From a31fa189c131b8e45b5cddb309945e1a4bb7e3d7 Mon Sep 17 00:00:00 2001 From: Ella <72365100+eilla1@users.noreply.github.com> Date: Wed, 16 Jun 2021 00:32:43 -0700 Subject: [PATCH 1/3] fix: update syntax for commands for example: `$ octodns-sync --config-file=./config/production.yaml` was throwing an error. Then, when i did `$ octodns-dump`, it prompted me to put it in this format: `$ octodns-sync --config-file CONFIG_FILE` (without the = sign) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2ce9445..eb7789b 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,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. ```shell -$ octodns-sync --config-file=./config/production.yaml +$ octodns-sync --config-file ./config/production.yaml ... ******************************************************************************** * example.com. @@ -146,7 +146,7 @@ There will be other logging information presented on the screen, but successful Now it's time to tell OctoDNS to make things happen. We'll invoke it again with the same options and add a `--doit` on the end to tell it this time we actually want it to try and make the specified changes. ```shell -$ octodns-sync --config-file=./config/production.yaml --doit +$ octodns-sync --config-file ./config/production.yaml --doit ... ``` @@ -177,7 +177,7 @@ If that goes smoothly, you again see the expected changes, and verify them with Very few situations will involve starting with a blank slate which is why there's tooling built in to pull existing data out of providers into a matching config file. ```shell -$ octodns-dump --config-file=config/production.yaml --output-dir=tmp/ example.com. route53 +$ octodns-dump --config-file ./config/production.yaml --output-dir tmp/ example.com. route53 2017-03-15T13:33:34 INFO Manager __init__: config_file=tmp/production.yaml 2017-03-15T13:33:34 INFO Manager dump: zone=example.com., sources=('route53',) 2017-03-15T13:33:36 INFO Route53Provider[route53] populate: found 64 records From fb805ced62e649dd42529081055cf38bcb616bc8 Mon Sep 17 00:00:00 2001 From: Ella <72365100+eilla1@users.noreply.github.com> Date: Wed, 16 Jun 2021 00:39:01 -0700 Subject: [PATCH 2/3] chore: add alt text to images --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index eb7789b..3ad16d3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - +OctoDNS Logo ## DNS as code - Tools for managing DNS across multiple providers @@ -158,17 +158,17 @@ In the above case we manually ran OctoDNS from the command line. That works and The first step is to create a PR with your changes. -![](/docs/assets/pr.png) +![GitHub user interface of a pull request](/docs/assets/pr.png) Assuming the code tests and config validation statuses are green the next step is to do a noop deploy and verify that the changes OctoDNS plans to make are the ones you expect. -![](/docs/assets/noop.png) +![Output of a noop deployment command](/docs/assets/noop.png) After that comes a set of reviews. One from a teammate who should have full context on what you're trying to accomplish and visibility in to the changes you're making to do it. The other is from a member of the team here at GitHub that owns DNS, mostly as a sanity check and to make sure that best practices are being followed. As much of that as possible is baked into `octodns-validate`. After the reviews it's time to branch deploy the change. -![](/docs/assets/deploy.png) +![Output of a deployment command](/docs/assets/deploy.png) If that goes smoothly, you again see the expected changes, and verify them with `dig` and/or `octodns-report` you're good to hit the merge button. If there are problems you can quickly do a `.deploy dns/master` to go back to the previous state. From 501ae886738522b13e3c9e8c5f564c48d5c135d8 Mon Sep 17 00:00:00 2001 From: Ella <72365100+eilla1@users.noreply.github.com> Date: Wed, 16 Jun 2021 15:25:14 -0700 Subject: [PATCH 3/3] chore: use = --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3ad16d3..91e04eb 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,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. ```shell -$ octodns-sync --config-file ./config/production.yaml +$ octodns-sync --config-file=./config/production.yaml ... ******************************************************************************** * example.com. @@ -146,7 +146,7 @@ There will be other logging information presented on the screen, but successful Now it's time to tell OctoDNS to make things happen. We'll invoke it again with the same options and add a `--doit` on the end to tell it this time we actually want it to try and make the specified changes. ```shell -$ octodns-sync --config-file ./config/production.yaml --doit +$ octodns-sync --config-file=./config/production.yaml --doit ... ``` @@ -177,7 +177,7 @@ If that goes smoothly, you again see the expected changes, and verify them with Very few situations will involve starting with a blank slate which is why there's tooling built in to pull existing data out of providers into a matching config file. ```shell -$ octodns-dump --config-file ./config/production.yaml --output-dir tmp/ example.com. route53 +$ octodns-dump --config-file=config/production.yaml --output-dir=tmp/ example.com. route53 2017-03-15T13:33:34 INFO Manager __init__: config_file=tmp/production.yaml 2017-03-15T13:33:34 INFO Manager dump: zone=example.com., sources=('route53',) 2017-03-15T13:33:36 INFO Route53Provider[route53] populate: found 64 records