Browse Source

Merge pull request #68 from sijis/docs/small_typos

docs: Fix small typos
pull/69/head
Ross McFarland 9 years ago
committed by GitHub
parent
commit
5c6981fd3f
2 changed files with 3 additions and 3 deletions
  1. +1
    -1
      CONTRIBUTING.md
  2. +2
    -2
      README.md

+ 1
- 1
CONTRIBUTING.md View File

@ -26,7 +26,7 @@ Here are a few things you can do that will increase the likelihood of your pull
* Follow [pep8](https://www.python.org/dev/peps/pep-0008/)
- Write thorough tests. No PRs will be merged without :100:% code coverage. More than that tests should be very thorough and cover as many (edge) cases as possible. We're working with DNS here and bugs can have a major impact so we need to do as much as reasonably possible to ensure quality. While :100:% doesn't even begin to mean there are no bugs, getting there often requires close inspection & a relatively complete understanding of the code. More times than no the endevor will uncover at least minor problems.
- Write thorough tests. No PRs will be merged without :100:% code coverage. More than that tests should be very thorough and cover as many (edge) cases as possible. We're working with DNS here and bugs can have a major impact so we need to do as much as reasonably possible to ensure quality. While :100:% doesn't even begin to mean there are no bugs, getting there often requires close inspection & a relatively complete understanding of the code. More times than not the endeavor will uncover at least minor problems.
- Bug fixes require specific tests covering the addressed behavior.


+ 2
- 2
README.md View File

@ -160,7 +160,7 @@ The above command pulled the existing data out of Route53 and placed the results
#### Notes
* ALIAS support varies a lot fromm provider to provider care should be taken to verify that your needs are met in detail.
* ALIAS support varies a lot from provider to provider care should be taken to verify that your needs are met in detail.
* Dyn's UI doesn't allow editing or view of TTL, but the API accepts and stores the value provided, this value does not appear to be used when served
* Dnsimple's uses the configured TTL when serving things through the ALIAS, there's also a secondary TXT record created alongside the ALIAS that octoDNS ignores
@ -170,7 +170,7 @@ You can check out the [source](/octodns/source/) and [provider](/octodns/provide
Most of the things included in OctoDNS are providers, the obvious difference being that they can serve as both sources and targets of data. We'd really like to see this list grow over time so if you use an unsupported provider then PRs are welcome. The existing providers should serve as reasonable examples. Those that have no GeoDNS support are relatively straightforward. Unfortunately most of the APIs involved to do GeoDNS style traffic management are complex and somewhat inconsistent so adding support for that function would be nice, but is optional and best done in a separate pass.
The `class` key in the providers config section can be used to point to arbitrary classes in the python path so internal or 3rd party providers can easily be included with no coordiation beyond getting them into PYTHONPATH, most likely installed into the virtualenv with OctoDNS.
The `class` key in the providers config section can be used to point to arbitrary classes in the python path so internal or 3rd party providers can easily be included with no coordination beyond getting them into PYTHONPATH, most likely installed into the virtualenv with OctoDNS.
## Other Uses


Loading…
Cancel
Save