summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer
AgeCommit message (Collapse)AuthorFilesLines
2019-08-05add links to ONAP Postman collection documentationRene_Robert1-0/+10
amend : correct directory level Issue-ID: DOC-520 Signed-off-by: Rene_Robert <rene.robert@orange.com> Change-Id: I1c8a60033f4a0b41e57077d839e47f6b40680822
2019-07-12Merge "Add information on tox usage"Eric Debeau1-3/+2
2019-07-12Merge "Document temporary character of references in repolist.rst"Eric Debeau1-1/+4
2019-07-12Merge "Removing submodules for apex & distribution"Eric Debeau1-2/+0
2019-07-12Removing submodules for apex & distributionramverma1-2/+0
The documents for apex & distribution components are moved to policy/parent. Hence, deleting the individual submodules/entries for these repos. Change-Id: I82d4729bfd2e80f831fadd544989e70bb5c3d99e Issue-ID: POLICY-1898 Signed-off-by: ramverma <ram.krishna.verma@est.tech>
2019-07-11Add information on tox usagePawel Wieczorek1-3/+2
This patch also adds link to Python Package Index (like for doc8 package) and removes no longer necessary directory change. Issue-ID: DOC-502 Change-Id: Ibfeda01256babebd3e5224fe766c740bc738e2e8 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-07-11Add information on virtualenv usagePawel Wieczorek1-4/+14
This patch also adds link to Python Package Index (like for doc8 package), drops no longer necessary privilege elevation and fixes minor spacing issues. Issue-ID: DOC-502 Change-Id: I55a583bf05a731371008d9cfb55cbfa2e2ad3a77 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-07-09Document temporary character of references in repolist.rstKrzysztof Opasiak1-1/+4
According to the comment in repolist.rst references there are only temporary and should be removed when the project is referenced from more appropriate place. Unfortunately developer may never notice this comment as writting to this file in documentation is done by echo command. To improve this situation let's add an explicit mention about this temporary character of repolist.rst to the documentation. Issue-ID: DOC-501 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I8d8b5fe03d29b5141d57e1d06220bd6382a52861
2019-07-04Issue-ID: INT-494Rene_Robert1-4/+4
add link to OOM user guide in "setting-up ONAP" section Signed-off-by: Rene_Robert <rene.robert@orange.com> Change-Id: I938c59774e703fece57841d203090b2868ec3414
2019-07-01Issue-ID: DOC-493Rene_Robert1-8/+16
correcting procedure to test documentation change before submitting the change replacing mv command by cp command mainly Signed-off-by: Rene_Robert <rene.robert@orange.com> Change-Id: I546a1beb82a23e51cdbb6e4f38e77bad2da3e6d7
2019-06-21Add Integration link in doc index pageYang Xu1-5/+4
Signed-off-by: Yang Xu <yang.xu@futurewei.com> Issue-ID: DOC-489 Change-Id: I3d198db2d24aac9e55b809709a3b9f5755f49a75
2019-06-01Merge "Update to Dublin API spec"Eric Debeau1-1/+1
2019-05-31Update to Dublin API specJimmy Forsyth1-1/+1
Issue-ID: DOC-472 Signed-off-by: Jimmy Forsyth <jf2512@att.com> Change-Id: I6e284cc50f3626c72c334dc225b27eaf2cee8ec9
2019-05-31Merge "Update Architecture section"Rich Bennett2-368/+389
2019-05-31Merge "Update nodePorts list"Rich Bennett1-41/+41
2019-05-31Update Architecture sectionEric Debeau2-368/+389
Update Architecture figure as defined by Architecture subcommittee Update text aligned with document produced by Marketing and Architecture Add links to Yourube and Youku Issue-ID: DOC-469 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I077ba9e747d52853d7e5b9d3209f2cfedf143302
2019-05-31Merge "Add caution to not modify ../ in git command"Eric Debeau1-1/+6
2019-05-29Update nodePorts listEric Debeau1-41/+41
Update list of nodeports based on May 29, 2019 installation Issue-ID: DOC-427 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I2ada608e3391692f21fb1d0981035ad043c758e8
2019-05-29Add new policy docsPamela Dragosh1-0/+1
Need the new architecture and api to be accessible from the front pages. We will be moving apex and distribution into policy/parent and also renaming policy/engine to indicate 'legacy'. Issue-ID: POLICY-1676 Change-Id: I0444b51631cbe7211073ff530461ea4dadf33b4c Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-05-29Add caution to not modify ../ in git commandKrzysztof Opasiak1-1/+6
Using incorrect repository location is hard to catch during review and merging it causes all jenkins verify job to fail. Thus let's add a warning to the documentation to warn potential users and avoid such incidents. Issue-ID: SECCOM-239 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I6b00a5bc6f34d33f2576c802eccf541069499d84
2019-05-22Update SettingUPEric Debeau3-545/+20
Upadte ONAP footprint Update Components versions Remove Heat installation Remove individual installation Issue-ID: DOC-427 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I85e720a9a27fc17b3ebc63e04d76beace4da3117
2019-05-17Removing contributing documentation from components and functionsGergely Csatari1-9/+0
Components and functions had a lin to the ducumentation section of the contributor guide This link is removed with this change. Issue-ID: DOC-449 Change-Id: I15011998f6816d9a1b0f1ef43997c7421ea9014b Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
2019-05-15Merge "Structural changes to documentation"Rich Bennett2-6/+3
2019-05-14Structural changes to documentationNoemi Wagner2-6/+3
Link corrected in landing page to the overview document. We moved out from the Developers Guide: Architecture, Developing ONAP, Setting-up ONAP. We renamed 'Developing ONAP' section to 'ONAP components and functionalities'. (Later we plan to further improve the current content of the Developing ONAP section, that is, we e.g. plan to move 'Documentation' part to Developers Guide). We are not 100% sure that 'ARchitecture'/'Setting up ONAP'/'ONAP components and functionalities' (current Developing ONAP) shall be 'duplicated or not, that is, shall be visible on the left bar AND under Developers Guide as well, OR only in the left bar. Issue-ID: DOC-449 Change-Id: Idca0bacac3c7cb28a870a7ea5f8beb54fda0187c Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2019-05-13Correction to documentation guide for APIEric Debeau1-3/+8
Add note when swaggerv2doc directive is not working Issue-ID: DOC-426 Change-Id: I19871c820f721016625ee7979632d2e2dfea80bb Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2019-04-18Merge "Correction to documentation guide for API"Rich Bennett1-6/+18
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-18Merge "Add BBS blueprint to developer guide"Eric Debeau2-0/+29
2019-04-17Add BBS blueprint to developer guidePérez Caparrós David, INI-INO-ECO-HCT2-0/+29
BBS blueprint description in onap developer guide, architecture section Issue-ID: DOC-432 Change-Id: Ibf08ec9b58b96b1671b2ce302c37fd19b8edbedb Signed-off-by: Pérez Caparrós David, INI-INO-ECO-HCT <David.PerezCaparros@swisscom.com>
2019-04-17Correct NodePorts tableEric Debeau1-0/+7
Add NodePorts for DCAE Issue-ID: DOC-430 Change-Id: I3a560dbd0e8b80a44370987b15b7ec1e4f0b24c5 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>