summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2019-08-09 08:12:31 -0700
committerGitHub <noreply@github.com>2019-08-09 08:12:31 -0700
commit3d97a2f44c019a980d1d05a2dc7f45afdb187243 (patch)
treedc84f0f1b349b09aa4a6f4e1611dcce6b023072e /CONTRIBUTING.md
parent485312630283bac22d568d8e5384242e52cd4bf9 (diff)
Documentation style guide & build instructions (#6563)
* Initial style guide setup * Addressing Chris' comments * Grammatical and typo fixes * Added warning about pip versions * Changed image URL to fix deploy error
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8847f0c2f1..caa11a984a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -61,9 +61,13 @@ As the project grows, an increasing share of our time is spent on supporting thi
### Improve documentation
-All of our documentation is in markdown (.md) files inside the netdata GitHub project. All of our [HTML documentation](https://docs.netdata.cloud) is generated from these files. At the top right of each documentation page you will see a pencil, that leads you directly to the markdown file that was used to generated it. Don't be afraid to click it and edit any of these documents and submit a GitHub Pull Request with your corrections/additions.
+Our documentation is in need of constant improvement and expansion. As Netdata's features grow, we need to clearly explain how each feature works and document all the possible configurations. And as Netdata's community grows, we need to improve existing documentation to make it more accessible to people of all skill levels.
-We also need help to [document each chart in the default dashboard](https://github.com/netdata/netdata/issues/279).
+We also need to produce beginner-level tutorials on using Netdata to monitor common applications, web servers, and more.
+
+Start with the [guide for contributing to documentation](docs/contributing/contributing-documentation.md), and then review the [documentation style guide](docs/contributing/style-guide.md) for specifics on how we write our documentation.
+
+Don't be afraid to submit a pull request with your corrections or additions! We need a lot of help and are willing to guide new contributors through the process.
## Developers