summaryrefslogtreecommitdiffstats
path: root/docs/guide
AgeCommit message (Collapse)AuthorFilesLines
2017-09-13Enhancement and additions for webinarRich Bennett10-864/+0
Add templates, revise master index, guides, and release document Improve project integration instructions based on 5 project integrations. Change-Id: I2a3e62737f3c126b7f5fb7cc4f53b35dba4f1d8f Issue-ID: DOC-26 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-09-07Added index creation docs to addendumSpencer Seidel1-0/+45
Added a section to the addendum in the how-to docs on how to build indices in Sphinx. Change-Id: Ib0a64c188f8942f5eb45cafae0d9685285eff855 Issue-ID: DOC-75 Signed-off-by: Spencer Seidel <jsseidel@fastmail.com>
2017-09-06Added new sectionsSpencer Seidel3-0/+151
Added sections describing which documentation should be stored on wiki vs rst, why the doc team chose rst/sphinx, and how to convert from other formats, loosely based on Steven Wright's video. Updated index.rst to account for the format-conversion section. Change-Id: Iea9ec284fc273510177966d8325191ea39d049b2 Issue-Id: DOC-66 Signed-off-by: Spencer Seidel <jsseidel@fastmail.com>
2017-09-06Append .git submodule repositories, update guideRich Bennett2-31/+37
The submodule path hierarchy needs to support a name used as hierarchy for lower level repositories or groupIDs AND allow for a repository at each level eg submodules/appc and submodules/appc/deployment are both repos. When viewed in the submodule directory structure in the doc project, a repository will have .git appended. The above example would be submodules/appc.git submodules/appc/deployment.git Change how to guide and convert existing submodule names Rebased prior change Change-Id: Ie16b8bbda7562aaaee3c21eb504dc6e293c98cbd Issue-ID: DOC-33 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-31Reverse order and improve add repo stepsRich Bennett1-36/+37
Issue-ID: DOC-33 Change-Id: I15988d24f7c74a690138ae24f540e265edc6477d Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-25Remove VNFRQTS ExclusionRich Bennett1-95/+83
Remove Sphinx exclusion of VNFRQTS repositories that were causing all doc verify jobs to fail. These have been updated, should now verify, and be published when merged Improvements in the setup / getting started instructions for other project creating documentation Issue-Id: DOC-11 Change-Id: Ieb932dcaa0b4c39073e1e20cbdbe05bf6977a006 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-24Update How To Guide & Git submodulesRich Bennett4-188/+222
vnfrqts/requirements master advanced beyond submodule reference in doc before verify job available updated git reference to current level Improvements in the how to guide describing submodule integration Updated sphinx configuration to support sequence diagrams Temporary exclusion filter reduced for seed documents with severe errors Issue-Id: VNFRQTS-76 Change-Id: I3928a3d1e55a0731125e07186d8041b1614c3c8d Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-17Add Style Guide rst fileMatthewHarffy2-0/+78
Added style-guide.rst and updated index.rst Issue-ID: DOC-29 Change-Id: I14ca5b484dbbb2185cb421399c671aa7ef33bca8 Signed-off-by: MatthewHarffy <Matthew.harffy@amdocs.com>
2017-08-16Updates to How to GuideRich Bennett4-76/+79
Improve How to Use Documentation Guide including display existing templates, consistency with the approved Jenkins job templates, and other editorial improvements Change-Id: I6a173a656acee2d675cb4af4c3070ab9ab9eb893 Issue-Id: DOC-59 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-14VNFRQTS Docs -- Including Requirementsrr929y1-0/+1
VNFRQTS Docs -- Including the Requirements repository as a submodule of the root docs repository VNFRQTS-38 VNFRQTS-40 VNFRQTS-41 Change-Id: Ifd925b54880de0647ad44fbedc90e9b5fdeff488 Issue-ID:VNFRQTS-38 Signed-off-by: rr929y <rr929y@att.com>
2017-07-25[DOC-57 Add vnfrqts/guidelines submodule]Rich Bennett8-0/+557
Change-Id: I483f12449de27a00421289438c73baa38e0fa1af Signed-off-by: Rich Bennett <rb2745@att.com>