diff --git a/examples/README.md b/docs/examples/README.md similarity index 100% rename from examples/README.md rename to docs/examples/README.md diff --git a/examples/basic/README.md b/docs/examples/basic/README.md similarity index 99% rename from examples/basic/README.md rename to docs/examples/basic/README.md index f210881..c692a99 100644 --- a/examples/basic/README.md +++ b/docs/examples/basic/README.md @@ -1,4 +1,4 @@ -## Basic octoDNS Setup +# Basic octoDNS Setup This is the starting point octoDNS config, it's pretty similar to what you might see for managing a set of personal domains or a small business. diff --git a/examples/basic/config/my-domain.com.yaml b/docs/examples/basic/config/my-domain.com.yaml similarity index 100% rename from examples/basic/config/my-domain.com.yaml rename to docs/examples/basic/config/my-domain.com.yaml diff --git a/examples/basic/config/octodns.yaml b/docs/examples/basic/config/octodns.yaml similarity index 100% rename from examples/basic/config/octodns.yaml rename to docs/examples/basic/config/octodns.yaml diff --git a/examples/basic/config/unused-domain.io.yaml b/docs/examples/basic/config/unused-domain.io.yaml similarity index 100% rename from examples/basic/config/unused-domain.io.yaml rename to docs/examples/basic/config/unused-domain.io.yaml diff --git a/examples/basic/requirements.txt b/docs/examples/basic/requirements.txt similarity index 100% rename from examples/basic/requirements.txt rename to docs/examples/basic/requirements.txt diff --git a/examples/basic/target/my-domain.com.yaml b/docs/examples/basic/target/my-domain.com.yaml similarity index 100% rename from examples/basic/target/my-domain.com.yaml rename to docs/examples/basic/target/my-domain.com.yaml diff --git a/examples/basic/target/unused-domain.io.yaml b/docs/examples/basic/target/unused-domain.io.yaml similarity index 100% rename from examples/basic/target/unused-domain.io.yaml rename to docs/examples/basic/target/unused-domain.io.yaml diff --git a/examples/docker-compose.yml b/docs/examples/docker-compose.yml similarity index 100% rename from examples/docker-compose.yml rename to docs/examples/docker-compose.yml diff --git a/examples/env.sh b/docs/examples/env.sh similarity index 100% rename from examples/env.sh rename to docs/examples/env.sh diff --git a/examples/migrating-to-octodns/README.md b/docs/examples/migrating-to-octodns/README.md similarity index 99% rename from examples/migrating-to-octodns/README.md rename to docs/examples/migrating-to-octodns/README.md index 15c1742..92b6d47 100644 --- a/examples/migrating-to-octodns/README.md +++ b/docs/examples/migrating-to-octodns/README.md @@ -1,4 +1,4 @@ -## Migrating to octoDNS via octodns-dump +# Migrating to octoDNS via octodns-dump Importing an existing DNS setup into octoDNS management is a very straightforward process and can generally be completed in minutes. diff --git a/examples/migrating-to-octodns/config/octodns.yaml b/docs/examples/migrating-to-octodns/config/octodns.yaml similarity index 100% rename from examples/migrating-to-octodns/config/octodns.yaml rename to docs/examples/migrating-to-octodns/config/octodns.yaml diff --git a/examples/migrating-to-octodns/populate/my-dumpable.com.yaml b/docs/examples/migrating-to-octodns/populate/my-dumpable.com.yaml similarity index 100% rename from examples/migrating-to-octodns/populate/my-dumpable.com.yaml rename to docs/examples/migrating-to-octodns/populate/my-dumpable.com.yaml diff --git a/examples/migrating-to-octodns/populate/octodns.yaml b/docs/examples/migrating-to-octodns/populate/octodns.yaml similarity index 100% rename from examples/migrating-to-octodns/populate/octodns.yaml rename to docs/examples/migrating-to-octodns/populate/octodns.yaml diff --git a/examples/migrating-to-octodns/populate/unused-dumpable.com.yaml b/docs/examples/migrating-to-octodns/populate/unused-dumpable.com.yaml similarity index 100% rename from examples/migrating-to-octodns/populate/unused-dumpable.com.yaml rename to docs/examples/migrating-to-octodns/populate/unused-dumpable.com.yaml diff --git a/examples/migrating-to-octodns/requirements.txt b/docs/examples/migrating-to-octodns/requirements.txt similarity index 100% rename from examples/migrating-to-octodns/requirements.txt rename to docs/examples/migrating-to-octodns/requirements.txt diff --git a/docs/index.md b/docs/index.md index 595417f..90f0905 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,26 +8,25 @@ end-before: '## Table of Contents' ______________________________________________________________________ -## Indices and tables - -- {ref}`genindex` -- {ref}`modindex` - -### Project info - -- [License](info/license.md) -- [Changelog](info/changelog.md) +## User documentation -______________________________________________________________________ +```{toctree} +:caption: Getting Started: +:maxdepth: 1 -## User documentation +examples/basic/README.md +examples/migrating-to-octodns/README.md +records.md +``` ```{toctree} :caption: Guides: :maxdepth: 1 :glob: -* +[a-q]* +#records.md +[s-z]* ``` ______________________________________________________________________ @@ -75,3 +74,15 @@ modules/* modules/cmds/* modules/secret/* ``` + +______________________________________________________________________ + +## Indices and tables + +- {ref}`genindex` +- {ref}`modindex` + +### Project info + +- [License](info/license.md) +- [Changelog](info/changelog.md)