summaryrefslogtreecommitdiffstats
path: root/docs/guides
AgeCommit message (Collapse)AuthorFilesLines
2019-05-15Merge "Correction to documentation guide for API"Rich Bennett1-3/+8
2019-05-14Structural changes to documentationNoemi Wagner3-7/+6
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-14Merge "VNFRQTS - Updating title to VNF and PNF"Eric Debeau1-3/+3
2019-05-13VNFRQTS - Updating title to VNF and PNFHagop Bozawglanian1-3/+3
The naming convention has changed from xNF, VNF/PNF to VNF and PNF so I need to update the names to reflect this change. Change-Id: Ib47dfa2b4e67600663bdbd077585b9a436f4f47b Issue-ID: VNFRQTS-507 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.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-05-07Service Design Docu: Fixed typo; links changed for Pre-Onboarding and ↵thmsdt1-7/+6
Resource-Onboarding and more ... Issue-ID: DOC-443 Change-Id: I298ff68ad8c8d4549c622e6651a2a9d1e0573bc9 Signed-off-by: thmsdt <thomas.kulik@telekom.de>
2019-05-02Merge "Overview document created"Eric Debeau8-0/+414
2019-05-02Merge "Migration of Service Design from Wiki to Readthedocs User guide small ↵Eric Debeau2-0/+271
changes Source: https://wiki.onap.org/display/DW/Control+Loop+Design Issue-ID: DOC-439"
2019-05-02Merge ""Pre-Onboarding" section converted from ONAP Wiki (html) to ONAP RTD ↵Eric Debeau2-0/+126
(rst) Corrections after review <Issue-ID: DOC-435>"
2019-04-26Overview document createdNoemi Wagner8-0/+414
The overview document targets to provide the reader with a basic understanding on ONAP and its basic functional description.The doc also provides insight to Benefit of ONAP, licenses needed, basic releases etc. Issue-ID: DOC-364 Change-Id: I87c10896dc308d24d5aa8b54d920545372ffc41d Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2019-04-25Merge "Migration of Service Design from Wiki to Readthedocs User guide"Rich Bennett9-0/+177
2019-04-25Merge "Migration of Service Design from Wiki to Readthedocs User Guide"Rich Bennett2-0/+135
2019-04-25"Pre-Onboarding" section converted from ONAP Wiki (html) to ONAP RTD (rst)thmsdt2-0/+126
Corrections after review <Issue-ID: DOC-435> Change-Id: Ifb50cdc3eff5990e6f0d7f806531ba45bd21043a Signed-off-by: thmsdt <thomas.kulik@telekom.de>
2019-04-24Migration of Service Design from Wiki to Readthedocs User guideandreasgeissler2-0/+271
small changes Source: https://wiki.onap.org/display/DW/Control+Loop+Design Issue-ID: DOC-439 Change-Id: I5261d648b7d9a745738c8a01ffef86220e170af2 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
2019-04-24Migration of Service Design from Wiki to Readthedocs User GuideEric Debeau2-0/+135
Source: https://wiki.onap.org/display/DW/Governance+Approval+and+Service+Distribution Corrections to suppress OpenECOMP and USH Portal references Issue-ID: DOC-438 Change-Id: Ic678210cf882a15f248d17664d3f89631fcbc2ee Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2019-04-24Migration of Service Design from Wiki to Readthedocs User guideEric Debeau9-0/+177
Source: https://wiki.onap.org/display/DW/VF+Creation+and+Testing Issue-ID: DOC-437 Change-Id: Iae0d15e79e9a58df1855b604ae01ddfc45e486ca Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2019-04-18Migration of ServiceDesign/Resource-Onboarding from Wiki to Readthedocsandreasgeissler14-1/+257
Update Copyright and deleting tailing spaces Issue-ID: DOC-436 Change-Id: Ic264269c7008b42511839718d45b1ea04a39ace1 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
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-29Merge "VNFRQTS - Updating Release notes in hierarchy"Rich Bennett2-3/+5
2019-03-29VNFRQTS - Updating Release notes in hierarchyHagop Bozawglanian2-3/+5
Adding the release notes at a higher level to make it easier for readers to access. Change-Id: I8e96ad379a127d08ecc1f6c3f76780308e4dcf67 Issue-ID: VNFRQTS-543 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.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-15Added link to Portal-SDK docsWelch, Lorraine (lb2391)1-1/+3
Issue-ID: PORTAL-499 Change-Id: Iad19ecca6f7bb28b6ccef34047adf69f582fb49d Signed-off-by: Welch, Lorraine (lb2391) <lb2391@att.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 Wagner3-2/+4
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-30Add integration documentationRich Bennett1-0/+1
Release notes for oparent/cia and integration/benchmarks User Guides for verified use cases Change-Id: If1c017dcfd5a2f30bbdf43e7e5cb6e34ff5952b6 Issue-ID: INT-245 Signed-off-by: Rich Bennett <rb2745@att.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