Skip to content

Commit

Permalink
Add documentation edits information (vinyldns#276) (vinyldns#277)
Browse files Browse the repository at this point in the history
* Add documentation contribution info
  • Loading branch information
leticiawanderley authored and rebstar6 committed Oct 23, 2018
1 parent ec6307e commit d01a2e0
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,7 @@ For specifics on our tests, see the [Testing](DEVELOPER_GUIDE.md#testing) sectio
#### Documentation Edits
Documentation for the VinylDNS project lives in files such as this one in the root of the project directory, as well
as in `modules/docs/src/main/tut` for the docs you see on [vinyldns.io](https://vinyldns.io). Many changes, such as those that impact
an API endpoint, config, portal usage, etc, will also need corresponding documentation edited to prevent it from going stale.
Include those changes in the Pull Request.
an API endpoint, config, portal usage, etc, will also need corresponding documentation edited to prevent it from going stale. The VinylDNS [gh-pages branch README](https://github.com/vinyldns/vinyldns/tree/gh-pages#vinyldns-documentation-site) has information on how to run and edit the documentation page.

#### Style Guides
* For Scala code we use [Scalastyle](https://www.scalastyle.org/). The configs are `scalastyle-config.xml` and
Expand Down

0 comments on commit d01a2e0

Please sign in to comment.