summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer
AgeCommit message (Collapse)AuthorFilesLines
2020-06-05[DOC] Editorial changes in Documentation GuideAndrea Visnyei2-18/+15
End to end view moved to Setting up from Introduction. Steps numbered in Setting up and Setting up project repositories title fixed. Issue-ID: DOC-623 Issue-ID: DOC-624 Change-Id: I36fa54c2a86e98f220a80391b91bd1408890a61a Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-06-04Remove link to Postman collectionsEric Debeau1-9/+0
The postman suite has not been updated for Frankfurt There is no more repo in Integration project Remove the link towards the Integration project containing the Postman collections Issue-ID: DOC-630 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I770184034b988772d0755dda8b1362c7134361be
2020-05-27Correct Documentation display for bullet listEric Debeau1-25/+25
The new internal sphinx links auto-geenrated had some impacts on the display for some pages. This patch correct the RST files by adding some bullet lists guides/onap-developer/apiref/index.rst guides/onap-provider/index.rst guides/onap-provider/vnfvalidator.rst Provide better description for the links Issue-ID: DOC-619 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I4944a294516b90fbdfa998a623104ac6a85f3fe3
2020-04-13Fix links to new intersphinx format.Aric Gardner5-104/+109
Now that all the projects have anchors. convert links to intersphinx format Issue-ID: CIMAN-376 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I9c97ba7f6809446402cc2fa08add67a771e7e0fe
2020-04-09Remove devtool from docs.Aric Gardner1-10/+0
This project is archived. and cannot be converted. Issue-ID: CIMAN-376 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I2003bd12167043a28ff24694858afda480bce89c
2020-04-09Remove commented out doc code.Aric Gardner1-34/+0
This will no longer be relevant, and I am not going to covert this to intersphinx (as the endpoints don't actually exist) If this info is needed one can refer to this patchset Issue-ID: CIMAN-376 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I49c3d5a7b3622723eb93cb85d912a8aa948a1b75
2020-03-25Add AAF Certification Service to ONAP components and functionalities pageTomasz Wrobel1-0/+1
Issue-ID: AAF-1107 Signed-off-by: Tomasz Wrobel <tomasz.wrobel@nokia.com> Change-Id: If1ffac4402658bfd66ee1dd0733ed3e99eb10cb7
2019-12-11Creating an "Operations and Administration Guides" section and restructuring ↵andreasgeissler3-207/+2
chapters Issue-ID: DOC-543 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: Ia06c13cdf4299078c0fa5b133d50fe3d83c0cf59
2019-10-24Adding correct pngEric Debeau1-0/+0
Issue-ID: DOC-564 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I2fe6a7c140248ad6c0df8bce75b2e6370ac7e5c0
2019-10-21Architecture updateSofia Wallin1-86/+19
Updates for the Architecture introduction document Issue-ID: DOC-563 Change-Id: Ic15272ea91ead66d550522781e22976472cc0a66 Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
2019-10-17update modeling project docs - change toscaparser to etsicatalogyxpoke2-5/+8
Issue-ID: MODELING-228 Signed-off-by: yxpoke <yangxu5@huawei.com> Change-Id: I944ada0c07d87914ad4d729c193abc863483f34e
2019-10-14Correct System Message Warning errorsEric Debeau3-11/+1
Remove bad references Issue-ID: DOC-552 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I8cbe3d51884cab7114352c701ba701fd8a09da61
2019-10-08Remove unused ccsdk submodulesTimoney, Dan (dt5972)1-2/+0
The ccsdk/parent and ccsdk/utils repos do not contain any documentation (they are in other repos). So, removed those submodules and references from documentation tree. Issue-ID: CCSDK-1653 Signed-off-by: Timoney, Dan (dt5972) <dtimoney@att.com> Change-Id: I845382b036f231aa7db18cfbf4f5b1e1fb54988b
2019-09-03Merge "update link to Policy APIs Issue-ID: POLICY-1984"Eric Debeau1-1/+1
2019-09-02update link to Policy APIsRene_Robert1-1/+1
Issue-ID: POLICY-1984 Signed-off-by: Rene_Robert <rene.robert@orange.com> Change-Id: I2118acdadde30b2c502fdd8b6296a7a1001c924a
2019-09-02Renamed CLAMP to "Control Loop Automation Management Platform"andreasgeissler1-2/+2
Issue-ID: DOC-540 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I3ae512461d6afe5b94bdb4daf3cb2dddf963f876
2019-08-21Merge "SDN-R documentation location change"Sofia Wallin1-0/+9
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-25SDN-R documentation location changesai-neetha1-0/+9
SDN-R documentation location change Issue-ID: DOC-518 Signed-off-by: sai-neetha <sai-neetha.phulmali@highstreet-technologies.com> Change-Id: Ie9550de46368d7f33fe029e50181093a073bf0b2
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>