From 4ddcd67d25bf190f95c30e919ec92a41dc1b25fa Mon Sep 17 00:00:00 2001 From: Jeremy Mitchell Date: Fri, 12 May 2017 09:43:07 -0600 Subject: [PATCH] adds details regarding writing documentation --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e7e387831..38e292ab3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ If it's a bug fix, make a [JIRA issue](https://issues.apache.org/jira/browse/TC) #### Documentation -If your pull request changes the user interface or API, make sure the relevant documentation is updated. +If your pull request changes the user interface or API, make sure the relevant [documentation](http://trafficcontrol.apache.org/docs/latest/index.html) is updated. Documentation [source code](https://github.com/apache/incubator-trafficcontrol/tree/master/docs/source) is written using [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText). Please verify any document changes by installing [Sphinx](http://www.sphinx-doc.org/en/stable/) and running 'make' from the [root of the docs directory](https://github.com/apache/incubator-trafficcontrol/tree/master/docs). #### Code formatting