mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

CICD: Rename the master branch to main (#2774)

Browse Source 
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
This commit is contained in:
Jeffrey Cafferata
2024-01-10 21:50:12 +01:00
committed by GitHub
parent 858c902101
commit 355c0fe6a1
10 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
documentation/styleguide-doc.md
View File

@@ -2,18 +2,18 @@
## Where are the docs?
TL;DR version: [`docs`](https://github.com/StackExchange/dnscontrol/tree/master/docs) is the [marketing website](https://dnscontrol.org). [`documentation`](https://github.com/StackExchange/dnscontrol/tree/master/documentation) is the [docs.dnscontrol.org](https://docs.dnscontrol.org/) website. (Yes, the names are backwards!)
TL;DR version: [`docs`](https://github.com/StackExchange/dnscontrol/tree/main/docs) is the [marketing website](https://dnscontrol.org). [`documentation`](https://github.com/StackExchange/dnscontrol/tree/main/documentation) is the [docs.dnscontrol.org](https://docs.dnscontrol.org/) website. (Yes, the names are backwards!)
**The two websites**
1. <https://dnscontrol.org/>
* The main website
* Source code: [`docs`](https://github.com/StackExchange/dnscontrol/tree/master/docs)
* Source code: [`docs`](https://github.com/StackExchange/dnscontrol/tree/main/docs)
* Mostly "marketing" for the project.
* Rarely changes. Updated via GitHub "pages" feature.
2. <https://docs.dnscontrol.org/>
* Project documentation
* Source code: [`documentation`](https://github.com/StackExchange/dnscontrol/tree/master/documentation)
* Source code: [`documentation`](https://github.com/StackExchange/dnscontrol/tree/main/documentation)
* Users and developer documentation
* Changes frequently. Updated via [GitBook](https://www.gitbook.com/)
@@ -21,10 +21,10 @@ TL;DR version: [`docs`](https://github.com/StackExchange/dnscontrol/tree/master/
Within the git repo, docs are grouped:
* [`documentation/`](https://github.com/StackExchange/dnscontrol/tree/master/documentation): general docs
* [`documentation/providers/`](https://github.com/StackExchange/dnscontrol/tree/master/documentation/providers/): One file per provider
* [`documentation/functions/`](https://github.com/StackExchange/dnscontrol/tree/master/documentation/functions/): One file per `dnsconfig.js` language feature
* [`documentation/assets/FOO/`](https://github.com/StackExchange/dnscontrol/tree/master/documentation/assets/): Images for page FOO(PNGs only, please!)
* [`documentation/`](https://github.com/StackExchange/dnscontrol/tree/main/documentation): general docs
* [`documentation/providers/`](https://github.com/StackExchange/dnscontrol/tree/main/documentation/providers/): One file per provider
* [`documentation/functions/`](https://github.com/StackExchange/dnscontrol/tree/main/documentation/functions/): One file per `dnsconfig.js` language feature
* [`documentation/assets/FOO/`](https://github.com/StackExchange/dnscontrol/tree/main/documentation/assets/): Images for page FOO(PNGs only, please!)
## How to add a new page?