1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00

DOCS: Merge toc and index (#1789)

Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
This commit is contained in:
Jeffrey Cafferata
2022-11-01 18:03:04 +01:00
committed by GitHub
parent dc86519365
commit e95c122c48
4 changed files with 21 additions and 54 deletions

View File

@ -35,9 +35,14 @@
</div>
<div class="collapse navbar-collapse" id="nav-collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="{{site.github.url}}/getting-started">Getting Started</a></li>
<li><a href="{{site.github.url}}/js">Language Reference</a></li>
<li><a href="{{site.github.url}}/provider-list">Providers</a></li>
<li><a class="hidden-xs" href="{{site.github.url}}/getting-started">Getting Started</a></li>
<li><a class="hidden-xs" href="{{site.github.url}}/js">Language Reference</a></li>
<li><a class="hidden-xs" href="{{site.github.url}}/provider-list">Providers</a></li>
<li><a class="visible-xs" href="{{site.github.url}}/#getting-started">Getting Started</a></li>
<li><a class="visible-xs" href="{{site.github.url}}/#reference">Reference</a></li>
<li><a class="visible-xs" href="{{site.github.url}}/#advanced-features">Advanced features</a></li>
<li><a class="visible-xs" href="{{site.github.url}}/#commands">Commands</a></li>
<li><a class="visible-xs" href="{{site.github.url}}/#developer-info">Developer Info</a></li>
<li>
<a href="https://github.com/StackExchange/dnscontrol" style="padding:10px 12px"><span class="fa fa-github fa-2x" aria-hidden="true"></span></a>
</li>

View File

@ -21,14 +21,14 @@ title: DNSControl
<strong><a href="migrating">migrate</a></strong>
an existing one. Read the
<strong><a href="js">language spec</a></strong>
for more info. You can also <strong><a href="toc">view a list of all topics</a></strong>.
for more info. You can also <strong><a href="#getting-started">view a list of all topics</a></strong>.
</p>
</div>
<div class="col-md-4">
<h3>Use It</h3>
<p>Take advantage of the
<strong><a href="">advanced features</a></strong>.
<strong><a href="#advanced-features">advanced features</a></strong>.
Use macros and variables for easier updates.
<!-- Optimize your SPF records. -->
Upload your zones to
@ -73,7 +73,7 @@ title: DNSControl
<div class="container-fluid">
<div class="row">
<div class="col-md-4">
<h2>
<h2 id="getting-started">
Getting Started
</h2>
<p>
@ -95,7 +95,7 @@ title: DNSControl
</li>
</ul>
<h2>
<h2 id="commands">
Commands
</h2>
<p>
@ -103,25 +103,12 @@ title: DNSControl
</p>
<ul>
<!--
<li>
<a href="check-preview-push">check/preview/push</a>: dnscontrol's fundamentals
</li>
-->
<li>
<a href="creds-json.html">creds.json</a>: creds.json file format
</li>
<li>
<a href="check-creds.html">check-creds</a>: Verify credentials
</li>
<!--
<li>
<a href="create-domains">create-domains</a>: Populate domains at a provider
</li>
<li>
<a href="fmt">fmt</a>: Reformat dnsconfig.js
</li>
-->
<li>
<a href="get-zones.html">get-zones</a>: Query a provider for zone info
</li>
@ -132,7 +119,7 @@ title: DNSControl
</div>
<div class="col-md-4">
<h2>
<h2 id="reference">
Reference
</h2>
<p>
@ -141,7 +128,7 @@ title: DNSControl
<ul>
<li>
<a href="{{site.github.url}}/js">Language Reference</a>: Full language description
<a href="{{site.github.url}}/js">Language Reference</a>: Description of the DNSControl language (DSL)
</li>
<li>
<a href="{{site.github.url}}/alias">Aliases</a>: ALIAS/ANAME records
@ -155,15 +142,15 @@ title: DNSControl
</ul>
</div>
<div class="col-md-4">
<h2>
Advanced Topics
<h2 id="advanced-features">
Advanced features
</h2>
<p>
Take advantage of DNSControl's unique features.
</p>
<ul>
<li>
<a href="{{site.github.url}}/why-the-dot">Why CNAME/MX targets require a trailing dot</a>
<a href="{{site.github.url}}/why-the-dot">Why CNAME/MX/NS targets require a trailing "dot"</a>
</li>
<li>
<a href="{{site.github.url}}/unittests">Testing</a>: Unit Testing for you DNS Data
@ -188,7 +175,7 @@ title: DNSControl
</div>
<div class="row">
<div class="col-md-12">
<h2>
<h2 id="developer-info">
Developer Info
</h2>
<p>
@ -196,7 +183,7 @@ title: DNSControl
</p>
<ul>
<li>
GitHub: <a href="https://github.com/StackExchange/dnscontrol">https://github.com/StackExchange/dnscontrol</a>
GitHub <a href="https://github.com/StackExchange/dnscontrol">StackExchange/dnscontrol</a>: Get the source!
</li>
<li>
Mailing list: <a href="https://groups.google.com/forum/#!forum/dnscontrol-discuss">dnscontrol-discuss</a>: The friendly best place to ask questions and propose new features
@ -226,4 +213,4 @@ title: DNSControl
<hr class="feature">
<p><small>Icons made by Freepik from <a href="http://www.flaticon.com">www.flaticon.com</a></small></p>
<p><small>Icons made by Freepik from <a href="https://www.flaticon.com">www.flaticon.com</a></small></p>

View File

@ -1,25 +0,0 @@
---
layout: default
title: TOC
---
## Getting Started
- [Getting Started]({{site.github.url}}/getting-started): A walk-through of the basics.
- [Providers]({{site.github.url}}/provider-list): Which DNS providers are supported.
- [Examples]({{site.github.url}}/examples): The DNSControl language by example.
- [Migrating]({{site.github.url}}/migrating): Migrating zones to DNSControl.
- [CLI Variables]({{site.github.url}}/cli-variables): Passing variables from CLI to JS
## Reference
- [Language Reference]({{site.github.url}}/js): Description of the DNSControl language (DSL).
- [ALIAS / ANAME records in dnscontrol]({{site.github.url}}/alias)
- [Why CNAME/MX/NS targets require a trailing "dot"]({{site.github.url}}/why-the-dot)
## Advanced Topics
- [Testing]({{site.github.url}}/unittests): Unit Testing DNS Data.
- [SPF Optimizer]({{site.github.url}}/js#SPF_BUILDER): Optimize your SPF records.
## Developer info
- [GitHub](https://github.com/StackExchange/dnscontrol): Get the source!
- [Writing Providers]({{site.github.url}}/writing-providers)
- [Adding new DNS record types]({{site.github.url}}/adding-new-rtypes)

View File

@ -23,7 +23,7 @@ NEW CNAME("foo", "ghs.googlehosted.com."),
```
# Why CNAME/MX/NS targets require a "dot"
# Why CNAME/MX/NS targets require a trailing "dot"
People are often confused about this error message: