StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2025-09-07 05:34:43 +08:00
Code Issues Projects Releases Packages Wiki Activity

Website fixes (Part 2) (#221) (#236)

Browse source 
* Fix page title spelling

* Fixed some more mistakes

* Spacing fixes

* Fix title in TOC

* Improved TOC
This commit is contained in:
Patrick G 2017-10-24 09:42:30 -04:00 • committed by Craig Peterson
parent 60ed1a2e0b
commit 98e01e75aa
4 changed files with 18 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/index.md
View file

@ -21,7 +21,7 @@ title: DnsControl
<strong><a href="migrating">migrate</a></strong> <strong><a href="migrating">migrate</a></strong>
an existing one. Read the an existing one. Read the
<strong><a href="js">language spec</a></strong> <strong><a href="js">language spec</a></strong>
for more info. for more info. You can also <strong><a href="toc">view a list of all topics</a></strong>.
</p> </p>
</div> </div>

7
docs/nameservers.md
View file

@ -1,6 +1,6 @@
--- ---
layout: default layout: default
title: Namservers title: Nameservers
--- ---
# Nameservers # Nameservers
@ -51,11 +51,10 @@ DnsControl will also register the authoritative nameserver list with the registr
## 3. Backup providers ## 3. Backup providers
It is also possible to specify a Dns Provider that is not "authoritative" by using `DnsProvider("name", 0)`. This means the provider will be updated It is also possible to specify a DNS Provider that is not "authoritative" by using `DnsProvider("name", 0)`. This means the provider will be updated
with all records to match the authoritative ones, but it will not be registered in the tld name servers, and will not take traffic. with all records to match the authoritative ones, but it will not be registered in the tld name servers, and will not take traffic.
It's nameservers will not be added to the authoritative set. While this may seem an attractive option, there are a few things to note: It's nameservers will not be added to the authoritative set. While this may seem an attractive option, there are a few things to note:
1. Backup nameservers will still be updated with the NS records from the authoritative nameserver list. This means the records 1. Backup nameservers will still be updated with the NS records from the authoritative nameserver list. This means the records will still need to be updated to correctly "activate" the provider.
will still need to be updated to correctly "activate" the provider.
2. Costs generally scale with utilization, so there is often no real savings associated with an active-passive setup vs an active-active one anyway. 2. Costs generally scale with utilization, so there is often no real savings associated with an active-passive setup vs an active-active one anyway.

7
docs/release-engineering.md
View file

@ -4,18 +4,15 @@ title: How to build and ship a release
--- ---
# How to build and ship a release # How to build and ship a release
Here are my notes from producing the v0.2.2 release. Change the version number as appropriate. Here are my notes from producing the v0.2.2 release. Change the version number as appropriate.
## Step 1. Run the integration tests ## Step 1. Run the integration tests
* If you are at StackOverflow, this is in TC as "DNS > Integration Tests". * If you are at StackOverflow, this is in TC as "DNS > Integration Tests".
* Otherwise: * Otherwise:
* Run "go test" (documented in [Creating new DNS Resource Types](adding-new-rtypes)) * Run "go test" (documented in [Creating new DNS Resource Types](adding-new-rtypes))
* Run the integration tests (documented in [Writing new DNS providers](writing-providers) * Run the integration tests (documented in [Writing new DNS providers](writing-providers)
## Step 2. Bump the verison number ## Step 2. Bump the verison number
Edit the "Version" variable in `main.go` and commit. Edit the "Version" variable in `main.go` and commit.
``` ```
@ -26,7 +23,6 @@ git push origin tag v0.2.2
``` ```
## Step 3. Make the draft release. ## Step 3. Make the draft release.
[On github.com, click on "Draft a new release"](https://github.com/StackExchange/dnscontrol/releases/new) [On github.com, click on "Draft a new release"](https://github.com/StackExchange/dnscontrol/releases/new)
Pick the v0.2.2 tag Pick the v0.2.2 tag
@ -66,13 +62,11 @@ dnscontrol 0.1.5 ("6fdf78997815055bbe119c0116c9e2d60310a515[dirty]") built 24 Au
``` ```
## Step 4. Attach the binaries and release. ## Step 4. Attach the binaries and release.
Drag and drop binaries into the web form. Drag and drop binaries into the web form.
Submit the release. Submit the release.
## Step 5. Announce it ## Step 5. Announce it
Email the mailing list: (note the format of the Subject line and that the first line of the email is the URL of the release) Email the mailing list: (note the format of the Subject line and that the first line of the email is the URL of the release)
``` ```
@ -91,5 +85,4 @@ So many new providers and features! Plus, a new testing framework that makes it
## Step 6. Get credit! ## Step 6. Get credit!
Mention the fact that you did this release in your weekly accomplishments. Mention the fact that you did this release in your weekly accomplishments.

39
docs/toc.md
View file

@ -4,36 +4,21 @@ title: TOC
--- ---
## Getting Started ## Getting Started
- [Getting Started]({{site.github.url}}/getting-started): A walk-through of the basics.
### [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.
### [Providers]({{site.github.url}}/provider-list): Which DNS providers are supported. - [Migrating]({{site.github.url}}/migrating): Migrating zones to DNSControl.
### [Examples]({{site.github.url}}/examples): The DNSControl language by example.
### [Migrating]({{site.github.url}}/migrating): Migrating zones to DNSControl.
## Reference ## Reference
- [Language Reference]({{site.github.url}}/js): Description of the DNSControl language (DSL).
### [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)
### [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 ## Advanced Topics
- [Testing]({{site.github.url}}/unittests): Unit Testing DNS Data.
### [Testing]({{site.github.url}}/unittests): Unit Testing for you DNS Data. - [SPF Optimizer]({{site.github.url}}/spf): Optimize your SPF records.
### [SPF Optimizer]({{site.github.url}}/spf): Optimize your SPF records.
## Developer info ## Developer info
- [GitHub](https://github.com/StackExchange/dnscontrol): Get the source!
### [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)
### [Writing Providers]({{site.github.url}}/writing-providers)
### [Adding new DNS record types]({{site.github.url}}/adding-new-rtypes)