trafficcontrol-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From neu...@apache.org
Subject [01/10] incubator-trafficcontrol git commit: adds details regarding writing documentation
Date Fri, 12 May 2017 16:11:29 GMT
Repository: incubator-trafficcontrol
Updated Branches:
  refs/heads/master 13457d3f2 -> ccf2591ab


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/73a8fc82
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/73a8fc82
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/73a8fc82

Branch: refs/heads/master
Commit: 73a8fc82e54fc7977481275dcf24152ffc8c8355
Parents: 97632a4
Author: Jeremy Mitchell <mitchell852@gmail.com>
Authored: Fri May 12 09:43:07 2017 -0600
Committer: David Neuman <david.neuman64@gmail.com>
Committed: Fri May 12 09:54:32 2017 -0600

----------------------------------------------------------------------
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/73a8fc82/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
 


Mime
View raw message