summaryrefslogtreecommitdiffstats
path: root/docs/guides
AgeCommit message (Collapse)AuthorFilesLines
2018-07-24bugfix in blueprint-enr.rstkevinmcdonnell1-1/+1
scaleing->scaling. some minor rephrasing. Issue-ID: DOC-289 Change-Id: I38282c0f2ed0c677f1463b323aab2a6d048a95e3 Signed-off-by: kevinmcdonnell <kevin.mcdonnell@huawei.com>
2018-07-19update host file location in Linuxnecuser1-1/+1
Issue-ID: DOC-170 Signed-off-by: ankatare <ankatare@hotmail.com> Change-Id: I7d45a116e42b450f6d4a5a2d4068b06ac6cf7193
2018-07-12Add support for sphinx NEEDS DirectiveRich Bennett1-0/+24
Add configuration, pip requirements, and conventiions for use Change-Id: Ia065b7f72fc5aa16b4010b0100dc70e2f0a42b8c Issue-ID: DOC-285 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-06-23Merge "Include OOF documentation"Rich Bennett1-0/+11
2018-06-05Include OOF documentationShankar Narayanan1-0/+11
Include OOF HAS and OSDF documentation links. Issue-ID: OPTFRA-255 Change-Id: I91ce88567e046d565f85eb51d53057ffebbc4c4d Signed-off-by: Shankar Narayanan <snarayanan@research.att.com>
2018-06-04Add blueprint enrichment to DocsChris Donley2-5/+109
Issue-ID: DOC-275 Change-Id: Ieb72ee07ab99e0bb869d0f7d2f16d6a06d4cb623 Signed-off-by: Chris Donley <christopher.donley@huawei.com>
2018-06-04Clean RST fileEric Debeau1-46/+47
Correct DOC8 errors Change-Id: Ic40f9c2ddf1788424cae2ae383e17cba30e30773 Issue-ID: DOC-275 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-06-04Fix broken Doc linksChris Donley1-3/+3
Issue-ID: DOC-275 Change-Id: I761642faaa82872553d54141dee35e206237b67d Signed-off-by: Chris Donley <christopher.donley@huawei.com>
2018-06-04Update DOC arch section for BeijingChris Donley5-216/+405
Issue-ID: DOC-275 Change-Id: I5d0ac386de0692ce39f5b2f9f156d7553f494a3a Signed-off-by: Chris Donley <christopher.donley@huawei.com>
2018-06-04Merge "Remove the other section from the references"Eric Debeau1-9/+0
2018-06-04Remove the other section from the referencesKatel341-9/+0
Change-Id: I19d42879ba432634a62f280d8dabeb779af4ca20 Signed-off-by: Katel34 <cl664y@att.com> Issue-ID: DOC-273
2018-06-04update the model spec referencesVictor Gao1-1/+1
Change-Id: I57b86c109338080552127c611cf23e41d63677be Issue-ID: MODELING-79 Signed-off-by: Victor Gao <victor.gao@huawei.com>
2018-06-02Update modeling specs in references.rstVictor Gao1-1/+1
Change-Id: Ia736f2910693e973c9d9c05947a3961d31f177bd Issue-ID: MODELING-79 Signed-off-by: Victor Gao <victor.gao@huawei.com>
2018-05-31Updates to How To Create DocumentationRich Bennett6-209/+354
Integrating with doc project named release branch Code review of verify job console and html build How to use Read Docs URLs Doc8, formating, and reference link corrections Change-Id: If8ba97632045ec9542fd4bf1b2213a1bac5fd61d Issue-ID: DOC-270 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-05-23Correct SettingUp ONAPEric Debeau1-6/+4
- correct flavor and image for DCAE - suppress parameters no more used - editorial corrections Change-Id: I8b1404d5aeef8bb91e07802e567a64f849ec3168 Issue-ID: DOC-269 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-05-22Update SettingUp ONAPEric Debeau5-292/+79
-remove components.rst -create onap_oom.rst for OOM installation -change fullonap.rst to onap_heat.rst -upgrade the heat docummentation with existing Heat installation: remove all DCAE details used for R1, update the list of VM Change-Id: Ic07bbebb116f0d9561b3fede009ae7a56a2abe10 Issue-ID: DOC-269 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-05-22Add link check exceptionsRich Bennett2-1/+11
Add private address ranges and example URL names Add references to added or changed ui, ccsdk, and modeling rst files Change-Id: I913ac118ec4ea5e60522ac6ba29a8d7f9cff14c4 Issue-ID: DOC-268 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-05-14Merge "[DOC] add release to vnf provider page"Rich Bennett1-0/+1
2018-05-09VVP - Fixing reference titles for VVPBozawglanian, Hagop (hb755d)3-3/+4
Fixing the names for VVP as well as fixing the link in the developing section. Change-Id: If557745d467807543cb1a5e4bb0e92c7f4e58087 Issue-ID: VVP-35 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
2018-05-09[DOC] add release to vnf provider pagestark, steven1-0/+1
add the release notes rst to the vnf provider landing page so that it is easier to access Change-Id: Ie4bdeb4c0d194b77bca1386b4b86b742bc2dc3db Issue-ID: VNFRQTS-214 Signed-off-by: stark, steven <ss820f@att.com>
2018-05-04VVP - Updating docs to include vvpBozawglanian, Hagop (hb755d)6-0/+22
Adding references to the Doc project to include VVP in the correct places, as well as a new VNF Certifier page. Change-Id: I1a28aef94784674b7db4d013aec93e780d949fb5 Issue-ID: VVP-35 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
2018-04-26Add tox environment for spellcheckRich Bennett3-5/+19
Updates to how-to use documentation for linkcheck and spellcheck Initial list of validword exceptions for immediate use of tox -espellcheck Validword exceptions will be improved when DOC-262 is complete Corrections of RST references based on recent Beijing contributions Change-Id: Ic82de1088fd961c2ad91493e8736777aede1cdb1 Signed-off-by: Rich Bennett <rb2745@att.com> Issue-ID: DOC-94
2018-04-24add links for externalapi/nbiRene Robert2-1/+3
Issue-ID: DOC-256 Change-Id: I4e236eca2cf78424ccfd40dd90a5eaf76dadc75f Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-04-18Add platform operations to user guidesRich Bennett6-54/+28
Reference OOM cloud set up, quick start, and user guide Top level User Guide wiki sections already migrated See DOC-259 http:gerrit.onap.org/r/42333 Remove references to non-existing project sections. Change-Id: I09f5faf019f76b3ccddaffa2b97f3efcf183a7f0 Issue-ID: DOC-250 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-04-11Clean-up using onap sectionRich Bennett8-48/+143
Migrate top level structure from wiki Eliminate duplicated subsections Move to current stable release of Sphinx (1.6.7) Change-Id: I2999962c306d69756161cb90993694877265b476 Issue-ID: DOC-259 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-04-10title in docs tree reflect type of userguanwenyao1-2/+2
Issue-ID: VNFRQTS-197 Change-Id: I6a6b55ab86b760b8be112dfe97b974fac3e1a65a Signed-off-by: guanwenyao <guanwenyao@chinamobile.com>
2018-04-04Provide structure for VNFsRich Bennett1-0/+9
Add to index hierarchy guides/onap-developer/architecture Create section template vnf-reference Change-Id: If1b7b2b89de906c66e43382a9bc9dc2bee4086e5 Issue-ID: DOC-260 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-04-03Merge "DOC added vnfrqts/usecases"Rich Bennett1-0/+1
2018-03-30Merge "Developer Guide Index Updates"Rich Bennett1-19/+10
2018-03-29DOC added vnfrqts/usecasesBozawglanian, Hagop (hb755d)1-0/+1
Adding VNF Requirements Use Cases project This should be the same level as the VNF Requirements and VNF Guidelines projects Followed this guide http://onap.readthedocs.io/en/latest/guides/onap-developer/how-to-use-docs/include-documentation.html#setup-project-repositories-s Issue-ID: VNFRQTS-154 Change-Id: If9205dd4c533944085af639af413141a8ee0db88 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
2018-03-29DOC added vnfrqts/testcasesstark, steven1-0/+1
Adding VNF Requirements Test Cases project This should be at the same level as the VNF Requirements and VNF Guidelines projects Followed this guide http://onap.readthedocs.io/en/latest/guides/onap-developer/how-to-use-docs/include-documentation.html#setup-project-repositories-s Change-Id: I7473a3ff71960d47e98b386a6ff1afe6282d72a5 Issue-ID: VNFRQTS-53 Signed-off-by: stark, steven <ss820f@att.com>
2018-03-29Developer Guide Index UpdatesRich Bennett1-19/+10
Remove SVNFM section from project developer guides Use project name, expand acronyms, re-order external API framework Change-Id: Ie47d6331097c2d7d15f78ab258d57f297cac2694 Issue-ID: DOC-251 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-03-28Merge "Fixing empty lines around the code block"Gregory Glover1-1/+4
2018-03-28Correct link to externalapi/nbi.gitRene Robert1-1/+1
Issue-ID: DOC-257 Change-Id: I0089dbb7032c33935c175cbdc438c2d8d136a76d Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-03-28Fixing empty lines around the code blockMars Toktonaliev1-1/+4
Issue-ID: DOC-252 Change-Id: I614a8b957c37320bc3d0c14d460c197a4becf1cd Signed-off-by: Mars Toktonaliev <mars.toktonaliev@nokia.com>
2018-03-28add links to externalAPIRene Robert2-0/+11
Issue-ID: DOC-256 Change-Id: Idf3e126090253603466533f34dd0b466cc0f5356 Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-03-21Add MUSIC project submodule and toctree refsRich Bennett2-0/+10
Change-Id: I88174a9eae28b4cf212ad6059d36b3ffff101ff1 Signed-off-by: Rich Bennett <rb2745@att.com> Issue-ID: DOC-253
2018-03-21Merge "Change Amsterdam by Beijing"Rich Bennett2-63/+143
2018-03-20Change Amsterdam by BeijingEric Debeau2-63/+143
Modify Amsterdam by Beijing Correct to pass DOC8 Change-Id: Ia26a7f95617c5f00d646ddd5ccb66d69c27b1bcc Issue-ID: DOC-239 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-03-17Added DNS forwarding sample configurationMars Toktonaliev1-1/+22
Issue-ID: DOC-252 Change-Id: I4706df9f24b3b0108d2936682fcce061a16c3607 Signed-off-by: Mars Toktonaliev <mars.toktonaliev@nokia.com>
2018-03-12Merge "Add Nokia SVNFM driver documentation"Rich Bennett1-0/+9
2018-03-12Add Nokia SVNFM driver documentationDenes Nemeth1-0/+9
Change-Id: I8b92b024908400d947e1ef896432561098b9a2bc Signed-off-by: Denes Nemeth <denes.nemeth@nokia.com> Issue-ID: VFC-728
2018-03-09Updated designate configuration linkMars Toktonaliev1-3/+3
Issue-ID: DOC-164 Change-Id: I832e96da0e3a6c0f4ddb693c7806dd9e32f785a3 Signed-off-by: Mars Toktonaliev <mars.toktonaliev@nokia.com>
2018-03-08Merge "add onboarding in ONAP User section"Rich Bennett2-0/+17
2018-01-27DOC-239 : Replace Amsterdam by BeijingEmmanuel Bidet1-10/+10
Amsterdam replaced by Beijing 5 trailing spaces suppressed Issue-ID: DOC-239 Change-Id: I58367547c79badc9f4e386aa748f7ca62d4f5092 Signed-off-by: Emmanuel Bidet <emmanuel.bidet@m4x.org>
2017-12-05Add doc detailsDeterme, Sebastien (sd378r)2-20/+31
Add details to the doc, like additional links or explanation. Change-Id: I9596b137ac48c474e608a4901941b96de927e33f Issue-ID: DOC-211 Signed-off-by: Determe, Sebastien (sd378r) <sd378r@intl.att.com>
2017-11-28Update content of Integration pageGildas Lanilis1-5/+2
-remove link to former submodules/integration.git/docs/index.html -add link to new getting ONAP installed -add link to manifest file Issue-ID: DOC-203 Change-Id: I8f4c470aceb89295db09116e73cb9cd57edb4614 Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
2017-11-27Add explanation how to use branchesBlaisonneau David3-45/+687
Add what is a GIT branch, and what are the best practices in an ONAP context Issue-ID: DOC-207 Change-Id: Ifcab27b13df4719b16c6c3df84c2caafe7864973 Signed-off-by: Blaisonneau David <david.blaisonneau@orange.com>
2017-11-22Improve doc to install individual cptsGildas Lanilis1-4/+6
-Provide context and recommendation in "Setting Up individual ONAP Cpts" -Link Master RN to the above improvement Issue-ID: DOC-204 Change-Id: Iccbb1e19458b4bf3e16e54eb63c2f3bc3337f7fc Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
2017-11-21Merge "Update link in Master Release Notes"Gregory Glover1-0/+2