You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by de...@apache.org on 2017/05/12 15:47:01 UTC
[2/2] incubator-trafficcontrol git commit: adds details regarding
writing documentation
adds details regarding writing documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/1276eb19
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/1276eb19
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/1276eb19
Branch: refs/heads/master
Commit: 1276eb19e98911afdb10509d039b2b80f0f25703
Parents: 507cbbf
Author: Jeremy Mitchell <mi...@gmail.com>
Authored: Fri May 12 09:43:07 2017 -0600
Committer: Dewayne Richardson <de...@apache.org>
Committed: Fri May 12 09:46:54 2017 -0600
----------------------------------------------------------------------
CONTRIBUTING.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/1276eb19/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7e7e387..38e292a 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