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

DOCS: Renamed directory docs to documentation (#1966)

Browse Source 
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
This commit is contained in:
Jeffrey Cafferata
2023-01-21 23:26:04 +01:00
committed by GitHub
parent 7fe9e91d1e
commit aed4197984
3 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/creds-json.md
View File

@@ -201,7 +201,7 @@ This example requires the [1Password command-line tool](https://developer.1passw
but works with any shell command that returns a properly formatted `creds.json`. but works with any shell command that returns a properly formatted `creds.json`.
In this case, the 1Password CLI is used to inject the secrets from In this case, the 1Password CLI is used to inject the secrets from
a 1Password vault, rather than storing them in environment variables. a 1Password vault, rather than storing them in environment variables.
An example of a template file containing Linode and Cloudflare API credentials is available here: [creds.json](https://github.com/StackExchange/dnscontrol/blob/master/docs/assets/1password/creds.json). An example of a template file containing Linode and Cloudflare API credentials is available here: [creds.json](https://github.com/StackExchange/dnscontrol/blob/master/documentation/assets/1password/creds.json).
```json ```json
{ {

4
documentation/getting-started.md
View File

@@ -72,7 +72,7 @@ use BIND for DNS service, it is useful for testing.
domains, and so on. domains, and so on.
Start your `dnsconfig.js` file by downloading Start your `dnsconfig.js` file by downloading
[dnsconfig.js](https://github.com/StackExchange/dnscontrol/blob/master/docs/assets/getting-started/dnsconfig.js) [dnsconfig.js](https://github.com/StackExchange/dnscontrol/blob/master/documentation/assets/getting-started/dnsconfig.js)
and renaming it. and renaming it.
The file looks like: The file looks like:
@@ -138,7 +138,7 @@ It is only needed if any providers require credentials (API keys,
usernames, passwords, etc.). usernames, passwords, etc.).
Start your `creds.json` file by downloading Start your `creds.json` file by downloading
[creds.json](https://github.com/StackExchange/dnscontrol/blob/master/docs/assets/getting-started/creds.json) [creds.json](https://github.com/StackExchange/dnscontrol/blob/master/documentation/assets/getting-started/creds.json)
and renaming it. and renaming it.
The file looks like: The file looks like:

4
documentation/writing-providers.md
View File

@@ -77,7 +77,7 @@ Registrar if needed.
If you have any questions, please discuss them in the GitHub issue If you have any questions, please discuss them in the GitHub issue
related to the request for this provider. Please let us know what related to the request for this provider. Please let us know what
was confusing so we can update this document with advice for future was confusing so we can update this document with advice for future
authors (or even better, update [this document](https://github.com/StackExchange/dnscontrol/blob/master/docs/writing-providers.md) authors (or even better, update [this document](https://github.com/StackExchange/dnscontrol/blob/master/documentation/writing-providers.md)
yourself.) yourself.)
@@ -204,7 +204,7 @@ an automated way to test for this bug. The manual steps are here in
## Step 9: Update docs ## Step 9: Update docs
* Edit [README.md](https://github.com/StackExchange/dnscontrol): Add the provider to the bullet list. * Edit [README.md](https://github.com/StackExchange/dnscontrol): Add the provider to the bullet list.
* Edit [docs/providers.md](https://github.com/StackExchange/dnscontrol/blob/master/docs/providers.md): Add the provider to the provider list. * Edit [docs/providers.md](https://github.com/StackExchange/dnscontrol/blob/master/documentation/providers.md): Add the provider to the provider list.
* Create `docs/providers/PROVIDERNAME.md`: Use one of the other files in that directory as a base. * Create `docs/providers/PROVIDERNAME.md`: Use one of the other files in that directory as a base.
* Edit [OWNERS](https://github.com/StackExchange/dnscontrol/blob/master/OWNERS): Add the directory name and your GitHub username. * Edit [OWNERS](https://github.com/StackExchange/dnscontrol/blob/master/OWNERS): Add the directory name and your GitHub username.