summaryrefslogtreecommitdiffstats
path: root/docs/guides
AgeCommit message (Collapse)AuthorFilesLines
2018-11-27Add Pomba submoduleRich Bennett2-20/+10
Add logging-analytics/pomba/pomba-audit-common as submodule Updates to documentation guide Issue-ID: DOC-323 Change-Id: Ied9363be20c39a893680b07bef964112361c9682 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-11-26Update SettingUp HeatEric Debeau1-28/+43
Update images used Update DCAE information Add proxy information Correct Robot request Issue-ID: DOC-340 Change-Id: Ifc78e05c89de0d6f2e8c56ed2e21202447549ba7 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-11-24Correct release noteEric Debeau1-0/+2
Installation section update to directly link to OOM installation Change-Id: I0a5adc36fe001033b88b1978a627339a6ded4ca9 Issue-ID: DOC-333 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-11-22Add Policy distribution repoRich Bennett1-0/+1
Change-Id: I2262bd8d0812651f78525137750fa3cb3727e108 Issue-ID: POLICY-1260 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-11-19Update SettingUp sectionEric Debeau3-82/+67
Rewrite index.rst to reflect OOM as the main installer Move text from onap_oom.rst to index.rst Issue-ID: DOC-340 Change-Id: Ie29547bc8c72c15a680393f63df35227a90116a1 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-11-16Correct architeture reference pageEric Debeau1-5/+6
Correct links for SO, AAF, Logging, MultiCloud Issue-ID: DOC-338 Change-Id: I0a0cf98930a5c9cc32674a84f223f2c2dbecd778 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-11-15Correct REST API Reference sectionEric Debeau1-3/+7
Add - AAF - DMaaP Bus Controller - DMaaP Data Router - Portal Correct - External API - SDNC Patch 2 corrects error in portal link Issue-ID: DOC-322 Change-Id: Ife5a3de75a60bd901929bd6fc36f3ff441607adf Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-11-14Update: Removed repeated wordsManish Kumar1-1/+1
Issue-ID: DOC-337 Change-Id: I271cb09a0c28ef45f69c637f4c38ee07cfeb3fa8 Signed-off-by: Manish Kumar <manishjpiet@gmail.com>
2018-11-08Add optf cmso module to the guidesvrvarma1-0/+1
Adding cmso index files to the onap-developer/developing link Change-Id: I4eb91c262def0df52793e659e7f12cbd41fb24ed Signed-off-by: vrvarma <vv8305@att.com> Issue-ID: OPTFRA-394
2018-11-08Merge "Update MultiCloud API reference"Rich Bennett1-1/+1
2018-11-06Add helm & k8s versions for casablancaMike Elliott1-7/+7
Change-Id: Ie2e85d279875e8661047d33431c9b72b17bb3d6c Issue-ID: OOM-1498 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com>
2018-11-03Update MultiCloud API referenceBin Yang1-1/+1
Change-Id: I89257ab964b55c5b600db7ac20ec9b07c5cfdab5 Issue-ID: MULTICLOUD-309 Signed-off-by: Bin Yang <bin.yang@windriver.com>
2018-10-25Add dmaap/buscontroller submoduleRich Bennett1-0/+1
Change-Id: I42ef09f71e80a401642b9479e3d65a11481c7271 Signed-off-by: Rich Bennett <rb2745@att.com> Issue-ID: DOC-328
2018-10-09Added apex-pdp to Developing ONAPmmis1-0/+1
Issue-ID: POLICY-1161 Change-Id: I6ddb4fd9d01e165eaa9afcc1c43d04a7c3def989 Signed-off-by: mmis <michael.morris@ericsson.com>
2018-10-02Eliminate duplicate toctree referencesRich Bennett1-21/+31
Integrate recently added repos with doc project sections Remove references from releases/repolist.rst Remove vnfreq and vvp from developing section Change-Id: I22ed97db8740ddb4080340afbad00f0485858f22 Issue-ID: DOC-312 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-09-21Add CLI into user guideKanagaraj Manickam k003651062-0/+12
Issue-ID: DOC-320 Change-Id: I25c12a3130ac75180bca005d9e09e9895d54cf3b Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
2018-09-08update the SO APIs in the docsseshukm1-1/+1
Change-Id: If400e7e4264754127799356b479ac8554085e3cd Issue-ID: SO-675 Signed-off-by: seshukm <seshu.kumar.m@huawei.com>
2018-09-01Cherry pick beijing improvements to masterRich Bennett14-96/+287
Replicating changes made when finalizing Beijing branch in the doc master branch. Change-Id: Ib1da658aef8cb84f896c6abac23631579ec0b80c Issue-ID: DOC-280 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-08-31DOC - Updating location of the VNFRQTSBozawglanian, Hagop (hb755d)4-18/+23
Moving the level of the doc project for the VNFRQTS. Issue-ID: DOC-318 Change-Id: I28d512744048acd008dfe127a86fb0c5d1bed480 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
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>