Docs layout to pull in guides and tools 48/6848/1
authorThanh Ha <thanh.ha@linuxfoundation.org>
Fri, 13 Oct 2017 16:51:12 +0000 (12:51 -0400)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Fri, 13 Oct 2017 16:57:45 +0000 (12:57 -0400)
Setup initial layout and populate with todo comments.

Change-Id: I18ac021bca467f5157004e6d25463225544c4ad6
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
docs/conf.py
docs/index.rst

index 64adff2..afe73f6 100644 (file)
@@ -353,5 +353,9 @@ texinfo_documents = [
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {
+    'global-jjb': ('http://global-jjb.releng.linuxfoundation.org/en/latest/', None),
+    'lftools': ('http://lftools.releng.linuxfoundation.org/en/latest/', None),
+    'python': ('https://docs.python.org/', None),
+}
 
index 17246dd..54ce86d 100644 (file)
@@ -1,5 +1,4 @@
-.. Linux Foundation Release Engineering Tools documentation master file, created by
-   sphinx-quickstart on Sat Mar  4 12:20:05 2017.
+.. _lfreleng-docs:
 
 Linux Foundation Releng Documentation
 =====================================
@@ -8,8 +7,21 @@ Linux Foundation Release Engineering Documentation.
 
 A collection of documentation for Linux Foundation Continuous Integration (LFCI).
 
-Contents:
+Guides:
 
+- Best Practices
+
+.. TODO Gerrit (RELENG-509)
+.. TODO Jenkins (RELENG-510)
+.. TODO Bootstrap a ReadTheDocs / Sphinx project (RELENG-512)
+.. TODO Release Workflow (RELENG-511)
+.. TODO Packer (RELENG-513)
+.. TODO Javadoc (RELENG-515)
+
+Tools:
+
+- :ref:`lftools`
+- :ref:`global-jjb`
 
 Indices and tables
 ==================