summaryrefslogtreecommitdiffstats
path: root/docs/guides
AgeCommit message (Collapse)AuthorFilesLines
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-08Added PNF support in Onboarding and VF Creationandreasgeissler5-120/+282
Issue-ID: DOC-473 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I0a5be07fda257a0bd9b5d069da544920e81b3f5a
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-30Release Notes upgradedNoemi Wagner1-1/+3
We have added Release notes to the landing page, corrected release note label for Dublin, updated release info in Overview doc, removed overlapping content from Release Notes (content available in Overview) Change-Id: Ib03c38abfa115fd10cb0f8c64877ee140d6fece3 Issue-ID: DOC-471 Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2019-05-29Merge "Create unique labels for "Service Design" pages and updated reference ↵Rich Bennett5-2/+10
Issue-ID: DOC-468"
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-24Create unique labels for "Service Design" pages and updated referenceandreasgeissler5-2/+10
Issue-ID: DOC-468 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I879dbd67a51f9508642d81bb17412193764fb9ce
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-16"Using Onap" section content and structure changed to reflect content and ↵thmsdt38-20/+321
structure of the wiki Fixed missing CLI section Issue-ID: DOC-450 Change-Id: I2ad3f57e854e9e64023887fa54656d8f01bf87e0 Signed-off-by: thmsdt <thomas.kulik@telekom.de>
2019-05-15Merge "Structural changes to documentation"Rich Bennett3-7/+6
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>