summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer
AgeCommit message (Collapse)AuthorFilesLines
2019-04-18Correction to documentation guide for APIEric Debeau1-6/+18
Add some notes to explain JSON file location and generation Issue-ID: DOC-426 Change-Id: Ifb617308b9548f892343b72fb7d885d17973d058 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2019-04-15Add NodePorts tableEric Debeau2-2/+111
Add the NodePorts table with information extracted from the Casablanca Maintenance Release deployment Correct missing component for 30236 NodePort Issue-ID: DOC-430 Change-Id: I554cad580d9b2a56ad9df99d3e60e0bfb66c9a12 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2019-04-10API documentation guideEric Debeau4-0/+147
Guide how to use Swagger and swaggerv2dcc directive Add 2 JSON Swagger files Add code block Change-Id: If3af3f20509db2cc47bdb2cf3db9b44d8a1bcdc7 Issue-ID: DOC-426 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2019-03-15Add offline-installer as an installation optionPetr Ospalý1-0/+8
Change-Id: I80f16912ddc8e2c04b408f1340049a4ce985434c Issue-ID: OOM-1672 Signed-off-by: Petr Ospalý <p.ospaly@partner.samsung.com>
2019-03-08Advance submodule referencesRich Bennett1-2/+4
Advance submodule references of recently added repos Remove conf2.py no longer used. Clarify what tox -elocal does with submodules Add branch and ignore properties for recently added repos Change-Id: I9f40fea10ae515d72766c9c6e0e5771ad12ccc27 Issue-ID: DOC-414 Signed-off-by: Rich Bennett <rb2745@att.com>
2019-02-26Removing sectionsAndrea Visnyei1-18/+0
Removed Conclusion and Resources sections from Architecture description. Issue-ID: DOC-407 Change-Id: I70cb04dd8fbc2bd69be3fa8985546d1826b9b50e Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2019-02-12Add CDS to developing guideEzhilarasi1-0/+1
Change-Id: Ica8ea1a201a60b9d8259ff5e6c3218868fcdb7d0 Issue-ID: CCSDK-917 Signed-off-by: Ezhilarasi <ezhrajam@in.ibm.com>
2019-01-30I fixed a type Homes -> HolmesTodd Larchuk1-1/+1
Change-Id: Ie5be68fd8de1d10e6313edf54256fa4c416d63f6 Signed-off-by: Todd Larchuk <tlarchuk@att.com> Issue-ID: DOC-390
2019-01-18doc: Update recommended components versionsKrzysztof Opasiak1-2/+2
Update recommended components versions to match Casablance requirements. Issue-ID: DOC-368 Change-Id: I637f258820b49aa5d51fbb0804b227a7c7e745df Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com>
2019-01-10Updated: TypoManish Kumar1-2/+2
Issue-ID: DOC-373 Change-Id: Idc1b104fae05cef15797e742dc69f420946c2708 Signed-off-by: Manish Kumar <manishjpiet@gmail.com>
2019-01-04Added APPS in Developing ONAP pageezhil1-0/+1
Change-Id: I4afe7e3030bbf7755b9087cab10e20645fa8745a Issue-ID: CCSDK-904 Signed-off-by: ezhil <ezhrajam@in.ibm.com>
2018-12-11Label addedNoemi Wagner1-0/+2
Label is added to the file, so that link can be created to it. Issue-ID: DOC-353 Change-Id: I38ae79a8f66aa87dc3e20a355cf262a6764cc390 Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2018-12-03Remove redundancy on Use CaseGildas Lanilis1-1/+0
Remove old Use Case from the Developer guide. There is a new Use Case section under User Guides. Change-Id: I906eb759898a804571eb1588086ea78039c9b59b Issue-ID: DOC-333 Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
2018-12-03Update architecture sectionEric Debeau5-482/+558
Update architecture section with the architecture white-paper Add new files for new blueprints (5G and CCVPN) Issue-ID: DOC-363 Change-Id: I35b7633e71407b59b9f96ed5adf5814c7935341a Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-11-30Remove Beijing referencesEric Debeau2-2/+2
Issue-ID: DOC-362 Change-Id: I4c3738e28a33de18f3ddb14d88433e60b0168710 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-11-27Merge "Add Pomba submodule"Eric Debeau2-20/+10
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-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 Bennett11-90/+281
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-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>