Browse Source

ditch source directory, fix changelog

pull/1290/head
Ross McFarland 4 months ago
parent
commit
94d031ec7c
No known key found for this signature in database GPG Key ID: 943B179E15D3B22A
38 changed files with 17 additions and 24 deletions
  1. +8
    -11
      CHANGELOG.md
  2. +0
    -0
      docs/api.rst
  3. +0
    -0
      docs/api/processor.rst
  4. +0
    -0
      docs/api/provider-yaml.rst
  5. +0
    -0
      docs/api/provider.rst
  6. +0
    -0
      docs/api/records.rst
  7. +0
    -0
      docs/api/source.rst
  8. +0
    -0
      docs/assets/deploy.png
  9. +0
    -0
      docs/assets/noop.png
  10. +0
    -0
      docs/assets/octodns-logo.png
  11. +0
    -0
      docs/assets/pr.png
  12. +0
    -0
      docs/auto_arpa.md
  13. +5
    -0
      docs/changelog.md
  14. +1
    -1
      docs/conf.py
  15. +0
    -0
      docs/configuration.rst
  16. +0
    -0
      docs/dynamic_records.rst
  17. +0
    -0
      docs/examples/README.rst
  18. +0
    -0
      docs/examples/basic/README.md
  19. +0
    -0
      docs/examples/basic/config/my-domain.com.yaml
  20. +0
    -0
      docs/examples/basic/config/octodns.yaml
  21. +0
    -0
      docs/examples/basic/config/unused-domain.io.yaml
  22. +0
    -0
      docs/examples/basic/requirements.txt
  23. +0
    -0
      docs/examples/basic/target/my-domain.com.yaml
  24. +0
    -0
      docs/examples/basic/target/unused-domain.io.yaml
  25. +0
    -0
      docs/examples/docker-compose.yml
  26. +0
    -0
      docs/examples/env.sh
  27. +0
    -0
      docs/examples/migrating-to-octodns/README.md
  28. +0
    -0
      docs/examples/migrating-to-octodns/config/octodns.yaml
  29. +0
    -0
      docs/examples/migrating-to-octodns/populate/my-dumpable.com.yaml
  30. +0
    -0
      docs/examples/migrating-to-octodns/populate/octodns.yaml
  31. +0
    -0
      docs/examples/migrating-to-octodns/populate/unused-dumpable.com.yaml
  32. +0
    -0
      docs/examples/migrating-to-octodns/requirements.txt
  33. +0
    -0
      docs/getting-started.rst
  34. +1
    -0
      docs/index.rst
  35. +0
    -5
      docs/info/changelog.md
  36. +0
    -5
      docs/info/license.md
  37. +0
    -0
      docs/records.rst
  38. +2
    -2
      script/generate-docs

+ 8
- 11
CHANGELOG.md View File

@ -175,8 +175,7 @@ Minor:
### Noteworthy changes
* New dynamic zone config support that allows wildcard entries in the octoDNS
config to be expanded by the source provider(s). See
[Dynamic Zone Config](/README.md#dynamic-zone-config) for more information.
config to be expanded by the source provider(s).
* SplitYamlProvider has been deprecated and will be removed in 2.0. YamlProvider
now includes the ability to process split zones when configured to do so and
allows for more flexibility in how things are laid out than was previously
@ -254,11 +253,8 @@ long (years) overdue.
from octodns.record you'll need to update and pull them from their actual
home. Classes beginning with _ are not exported from octodns.record any
longer as they were considered private/protected.
* Beta support for auto-arpa has been added, See the
[auto-arpa documentation](/docs/auto_arpa.md) for more information.
* Support for subnet targeting in dynamic records, see
[this section](/docs/dynamic_records.md#subnets) of dynamic records
documentation for more information.
* Beta support for auto-arpa has been added
* Support for subnet targeting in dynamic records
* Enhanced validations on dynamic rules to encourage best practices
* The last rule must be a catch-all w/o any targeted geos or subnets
* Geos must not be repeated in multiple rules
@ -360,7 +356,7 @@ long (years) overdue.
to do so, but weren't. There was an ordering before, but it was essentially
arbitrarily picked.
* Record.register_type added so that providers can register custom record
types, see [docs/records.md](docs/records.md) for more information
types.
* New `octodns-versions` command which will log out the version of octodns and
any provider/processor/plan_output modules you are using.
@ -503,9 +499,10 @@ long (years) overdue.
* Alpha support for Processors has been added. Processors allow for hooking
into the source, target, and planing process to make nearly arbitrary changes
to data. See the [octodns/processor/](/octodns/processor) directory for
examples. The change has been designed to have no impact on the process
unless the `processors` key is present in zone configs.
to data. See the
[octodns/processor/](https://github.com/octodns/octodns/tree/main/octodns/processor)
directory for examples. The change has been designed to have no impact on the
process unless the `processors` key is present in zone configs.
* Fixes NS1 provider's geotarget limitation of using `NA` continent. Now, when
`NA` is used in geos it considers **all** the countries of `North America`
instead of just `us-east`, `us-west` and `us-central` regions


docs/source/api.rst → docs/api.rst View File


docs/source/api/processor.rst → docs/api/processor.rst View File


docs/source/api/provider-yaml.rst → docs/api/provider-yaml.rst View File


docs/source/api/provider.rst → docs/api/provider.rst View File


docs/source/api/records.rst → docs/api/records.rst View File


docs/source/api/source.rst → docs/api/source.rst View File


docs/source/assets/deploy.png → docs/assets/deploy.png View File


docs/source/assets/noop.png → docs/assets/noop.png View File


docs/source/assets/octodns-logo.png → docs/assets/octodns-logo.png View File


docs/source/assets/pr.png → docs/assets/pr.png View File


docs/source/auto_arpa.md → docs/auto_arpa.md View File


+ 5
- 0
docs/changelog.md View File

@ -0,0 +1,5 @@
# Changelog
```{include} ../CHANGELOG.md
```

+ 1
- 1
docs/conf.py View File

@ -78,7 +78,7 @@ myst_heading_anchors = 3
### content ###
master_doc = "source/index"
master_doc = "index"
templates_path = ["_templates"]
html_static_path = ["_static"]


docs/source/configuration.rst → docs/configuration.rst View File


docs/source/dynamic_records.rst → docs/dynamic_records.rst View File


docs/source/examples/README.rst → docs/examples/README.rst View File


docs/source/examples/basic/README.md → docs/examples/basic/README.md View File


docs/source/examples/basic/config/my-domain.com.yaml → docs/examples/basic/config/my-domain.com.yaml View File


docs/source/examples/basic/config/octodns.yaml → docs/examples/basic/config/octodns.yaml View File


docs/source/examples/basic/config/unused-domain.io.yaml → docs/examples/basic/config/unused-domain.io.yaml View File


docs/source/examples/basic/requirements.txt → docs/examples/basic/requirements.txt View File


docs/source/examples/basic/target/my-domain.com.yaml → docs/examples/basic/target/my-domain.com.yaml View File


docs/source/examples/basic/target/unused-domain.io.yaml → docs/examples/basic/target/unused-domain.io.yaml View File


docs/source/examples/docker-compose.yml → docs/examples/docker-compose.yml View File


docs/source/examples/env.sh → docs/examples/env.sh View File


docs/source/examples/migrating-to-octodns/README.md → docs/examples/migrating-to-octodns/README.md View File


docs/source/examples/migrating-to-octodns/config/octodns.yaml → docs/examples/migrating-to-octodns/config/octodns.yaml View File


docs/source/examples/migrating-to-octodns/populate/my-dumpable.com.yaml → docs/examples/migrating-to-octodns/populate/my-dumpable.com.yaml View File


docs/source/examples/migrating-to-octodns/populate/octodns.yaml → docs/examples/migrating-to-octodns/populate/octodns.yaml View File


docs/source/examples/migrating-to-octodns/populate/unused-dumpable.com.yaml → docs/examples/migrating-to-octodns/populate/unused-dumpable.com.yaml View File


docs/source/examples/migrating-to-octodns/requirements.txt → docs/examples/migrating-to-octodns/requirements.txt View File


docs/source/getting-started.rst → docs/getting-started.rst View File


docs/source/index.rst → docs/index.rst View File


+ 0
- 5
docs/info/changelog.md View File

@ -1,5 +0,0 @@
# Changelog
```{include} ../../CHANGELOG.md
```

+ 0
- 5
docs/info/license.md View File

@ -1,5 +0,0 @@
# License
```{include} ../../LICENSE
```

docs/source/records.rst → docs/records.rst View File


+ 2
- 2
script/generate-docs View File

@ -22,6 +22,6 @@ if [ -z "$BUILDER" ]; then
fi
build="_build/${BUILDER}"
rm -rf "$build" source/api/records/ source/api/processors/
rm -rf "$build" api/records/ api/processors/
sphinx-build --builder "$BUILDER" --conf-dir . --fail-on-warning "$@" "source/" "$build"
sphinx-build --builder "$BUILDER" --conf-dir . --fail-on-warning "$@" "." "$build"

Loading…
Cancel
Save