mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-09-20 14:56:20 +08:00
DOCS: Fixed incorrect documentation directory path (#2131)
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
This commit is contained in:
parent
bfad9d68a0
commit
989e7e3e95
|
@ -228,7 +228,7 @@ tests, please ask!
|
|||
|
||||
## Step 8: Write documentation
|
||||
|
||||
Add a new Markdown file to `docs/functions/domain`. Copy an existing file (`CNAME.md` is a good example). The section between the lines of `---` is called the front matter and it has the following keys:
|
||||
Add a new Markdown file to `documentation/functions/domain`. Copy an existing file (`CNAME.md` is a good example). The section between the lines of `---` is called the front matter and it has the following keys:
|
||||
|
||||
- `name`: The name of the record. This should match the file name and the name of the record in `helpers.js`.
|
||||
- `parameters`: A list of parameter names, in order. Feel free to use spaces in the name if necessary. Your last parameter should be `modifiers...` to allow arbitrary modifiers like `TTL` to be applied to your record.
|
||||
|
|
|
@ -192,4 +192,4 @@ provider.)
|
|||
Implementing the `ListZones` function also activates the `check-creds`
|
||||
subcommand for that provider. Please add to the provider documentation
|
||||
a list of error messages that people might see if the credentials are
|
||||
invalid. See `docs/providers/gcloud.md` for examples.
|
||||
invalid. See `documentation/providers/gcloud.md` for examples.
|
||||
|
|
|
@ -198,14 +198,14 @@ Some useful `go test` flags:
|
|||
|
||||
There is a potential bug in how TXT records are handled. Sadly we haven't found
|
||||
an automated way to test for this bug. The manual steps are here in
|
||||
[docs/testing-txt-records.md](testing-txt-records.md)
|
||||
[documentation/testing-txt-records.md](testing-txt-records.md)
|
||||
|
||||
|
||||
## Step 9: Update docs
|
||||
|
||||
* 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/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.
|
||||
* Edit [documentation/providers.md](https://github.com/StackExchange/dnscontrol/blob/master/documentation/providers.md): Add the provider to the provider list.
|
||||
* Create `documentation/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.
|
||||
|
||||
## Step 10: Submit a PR
|
||||
|
@ -271,7 +271,7 @@ go get -u golang.org/x/lint/golint
|
|||
|
||||
## Step 13: Dependencies
|
||||
|
||||
See [docs/release-engineering.md](release-engineering.md)
|
||||
See [documentation/release-engineering.md](release-engineering.md)
|
||||
for tips about managing modules and checking for outdated
|
||||
dependencies.
|
||||
|
||||
|
@ -288,4 +288,4 @@ Here are some last-minute things to check before you submit your PR.
|
|||
## Step 15: After the PR is merged
|
||||
|
||||
1. Remove the "provider-request" label from the PR.
|
||||
2. Verify that [docs/providers.md](providers.md) no longer shows the provider as "requested"
|
||||
2. Verify that [documentation/providers.md](providers.md) no longer shows the provider as "requested"
|
||||
|
|
Loading…
Reference in a new issue