Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upChanges recommended structure of config files #200
Conversation
|
Mostly agree with this change. I think I'd prefer not to suggest |
| @@ -79,7 +79,7 @@ Further information can be found in [Records Documentation](/docs/records.md). | |||
| We're ready to do a dry-run with our new setup to see what changes it would make. Since we're pretending here we'll act like there are no existing records for `example.com.` in our accounts on either provider. | |||
|
|
|||
| ``` | |||
| $ octodns-sync --config-file=./config/production.yaml | |||
| $ octodns-sync --config-file=./env/production.yaml | |||
This comment has been minimized.
This comment has been minimized.
ross
Feb 20, 2018
Contributor
env would be a common case for how to break these down, but not the only one. E.g. we might separate the public important zones, from the very static and seldom touched vanity redirects like gtihub.com -> github.com, and separate the constantly changing internal zones into yet another config. All of these would be "production", but there'd be (in this case) 3 different setups.
This comment has been minimized.
This comment has been minimized.
ad-m
Feb 20, 2018
Author
@ross , maybe there is another name that will actually describe the content? config matches everything. Maybe inventory?
This comment has been minimized.
This comment has been minimized.
ross
Mar 3, 2018
Contributor
I think I'd like to stick to config/ here since it's "config" for octoDNS itself. Inventory doesn't really seem to line up to me and I've not come up with anything else that seems to encompass all the cases.
| @@ -60,7 +60,7 @@ Further information can be found in the `docstring` of each source and provider | |||
|
|
|||
| Now that we have something to tell OctoDNS about our providers & zones we need to tell it about or records. We'll keep it simple for now and just create a single `A` record at the top-level of the domain. | |||
|
|
|||
| `config/example.com.yaml` | |||
| `zones/example.com.yaml` | |||
This comment has been minimized.
This comment has been minimized.
|
I - at the time of README reading - at some point I got the impression that we need to create a nested |
|
Is there anything what I can do to help merge that PR? |
As mentioned in the review. The zones change makes sense, but I'd rather than recommend the |
ad-m commentedFeb 18, 2018
•
edited
Keeping everything in one directory made it difficult for me to understand what the expected directory structure is. Hence, it proposes to separate the basic configuration of the environment from the detailed configuration of the zones.