summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer
AgeCommit message (Collapse)AuthorFilesLines
2021-05-19Add guide for a doc dev systemthmsdt1-1/+1
Issue-ID: DOC-742 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ie6071576bce613edaf50433b7b84b69b16e0e88c
2021-05-06Merge "Template updates - sections"Andreas Geissler15-107/+315
2021-05-06Template updates - sectionsAndrea Visnyei15-107/+315
Instructions and examples added, notes commented out, review comments implemented Add example.com in the linkcheck_ignore Issue-ID: DOC-696 Change-Id: I8221ba6f2adce534ced7d8c06fbc7f23eef39efe Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2021-05-03Merge "Move examples from Addendum to Setting Up chapter"Eric Debeau4-159/+153
2021-04-30Move examples from Addendum to Setting Up chapterAndrea Visnyei4-159/+153
Moved RST file examples and Jenkins info to Setting up chapter and RTD URLs to Introduction. Issue-ID: DOC-719 Change-Id: I3e8ac614985858f2e3999a325e7575d66c8a7f84 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2021-04-23Fix architecture func diagrambyungwoojun2-11/+16
Fix architecture func diagram and its description Issue-ID: DOC-736 Signed-off-by: byungwoojun <byung-woo.jun@ericsson.com> Change-Id: I83fe2908e1537595e29f1f18c2a789c5172ebe19
2021-04-13Update architecture description for Honolulubyungwoojun2-4/+11
Updated architecture descrition to add CPS for Honolulu Issue-ID: DOC-734 Signed-off-by: byungwoojun <byung-woo.jun@ericsson.com> Change-Id: Iea30427ec85edc43d728f8302d972003e59e57ec
2021-04-06Update the components list and move Portal to "unmaintained"andreasgeissler1-2/+2
Issue-ID: DOC-721 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I668d593bd562a307a5e237bec6246c87c2424837
2021-04-01Update conf.py and Documentation Release Notes for Honoluluandreasgeissler1-1/+1
Issue-ID: DOC-727 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I78ffbc5ba306ed9868fecbea24d07cfaf7e5d049
2021-03-30Corrected DMaaP name and linking to unmaintained projectsandreasgeissler1-18/+21
Issue-ID: DOC-723 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I0c333f68e56f1b02c4f87e724586c8c0aa05f057
2021-03-19Add CPS in release notes, API, Architecture and Component pagesandreasgeissler3-1/+15
Update AAI UI in Component pages Issue-ID: DOC-721 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I7a66fbdf2876a26d2e8e45fd3cdc9dff122debb4
2021-03-18Policy/Clamp doc updateosgn422w3-3/+3
update the documentation to reflect the merge of clamp into Policy framework Issue-ID: REQ-684 Change-Id: I2948f7af24a4beadabed21a929f22c4e6984f55d Signed-off-by: osgn422w <gervais-martial.ngueko@intl.att.com>
2020-12-07Merge "Remove remaining warnings during Documentation buildings"Sofia Wallin3-131/+76
2020-12-07Remove remaining warnings during Documentation buildingsEric Debeau3-131/+76
correct files to remove warnings Remove orphan links Correct bad links Issue-ID: DOC-692 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Iac1fea50a4edaf6ef38b97a1b5d689fab0206a15
2020-12-04Update architecture sectionEric Debeau2-202/+205
Update content for Guilin Update figure (provided by Architectue sub-committee) Add new section for CDS Issue-ID: DOC-695 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Ia3c09e9fd47068feb9c28311be875491e6508abd
2020-12-03Removed outdated SO/Libs reference and missing DMaaP API docandreasgeissler1-4/+0
Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I6d9ab697cff82a5af5cee91f20568f13152e8ae2
2020-11-30Remove all warnings during Documentation buildingsEric Debeau18-110/+439
Remove files with not links: - guides/onap-developer/architecture/blueprint-enr.rst old file based on Beijing - smsummary.rst: no more relevant as no more submodules used - templates/sections/vnf-reference.rst : not referenced - guides/onap-user/onapportal.rst: redundant - guides/onap-developer/tutorials/index.rst: no tutorial Add new files to inlude templates Move templates directory under how-to-use-docs Modify global release not label with onap_release_notes to avoid confusion Issue-ID: DOC-692 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I709765beb02403c4ad058863c2b5136f42968cff
2020-11-30Merge "Correct broken links"Sofia Wallin1-51/+51
2020-11-27Moving style-guide after setting upAndrea Visnyei2-3/+3
Changed order of Style-guide chapter and setting up chapter. Editorial change in style-guide: ONAP terms changed to ONAP terminology. Issue-ID: DOC-669 Change-Id: I12203b8e7736d70d503d32c8e1562ae89aaf336a Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-11-26Correct broken linksEric Debeau1-51/+51
Correct broken links detected by sphinx linkcheck Correct Doc8 warnings Add License headers Issue-ID: DOC-690 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I89b4b76206f7c4c6ba580fc9191ea838b43e13eb
2020-11-25Updated link to cert-service and corrected description for CLAMP in release ↵andreasgeissler1-1/+1
Notes Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: Iae1b2155a948a244930595c60539b1b6335575b4
2020-11-25Update typos in Components Listandreasgeissler1-3/+3
Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I3e5e9cdb0cb9cb586dd5a19ffccafd8f30cb8966
2020-11-25Merge "Cleanup use case part in doc repo"Sofia Wallin2-89/+0
2020-11-25Remove Deprecate tag from CLIKanagaraj Manickam1-0/+0
Issue-ID: DOC-688 Signed-off-by: Kanagaraj Manickam <kanagaraj.manickam@huawei.com> Change-Id: Ica9f5bf7ab98b9f4b3401754798a9b8213e3fa4e
2020-11-25Cleanup use case part in doc repomrichomme2-89/+0
The use cases are hosted in integration repositories There were 2 dirctories referencing use cases in doc repo - guides/onap-developer/use-cases - use-cases they both dealt with vfw and were not up to date the vfw call flows are also in integration repository no update since beijing Issue-ID: INT-1776 Signed-off-by: mrichomme <morgan.richomme@orange.com> Change-Id: I61b8eb80381d13f45bfdd4a7639ff5364d02186b
2020-11-24Added links to older release docs for maintained componentsandreasgeissler1-11/+11
Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: If10a83665768cf3695b977448a3dd79f44f9b4dd
2020-11-20Update the ONAP components list for Guilinandreasgeissler1-26/+16
Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: Ie1969a26fb25d7cc7dd6e5f6392564d7f87bd97c
2020-11-19Add CDS API ReferenceJakobKrieg1-0/+1
Issue-ID: CCSDK-2992 Change-Id: I44ba8057c0454a654b578d821d0a43c15b7469e5 Signed-off-by: JakobKrieg <jakob.krieg@bcmsolutions.de>
2020-10-27Merge "Updating templates section setting up chapter"Sofia Wallin2-15/+52
2020-10-22Updating templates section setting up chapterAndrea Visnyei2-15/+52
Added names and descriptions of section and collection templates to tables instead of list. Issue-ID: DOC-675 Change-Id: Ib6740c099bc72d650d93bf9dbba3fc819f189a64 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-10-16Redesigned the ONAP Modules pageandreasgeissler1-226/+339
Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: Iebe938decea4b4aca2e932f05dcd1ab0febf9ce9
2020-10-15Removed link to the outdated Tutorials pageandreasgeissler2-13/+1
Issue-ID: DOC-673 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: Idf69d6b77cf85731f7043fce664e56ba755930c7
2020-10-01Merge "Documentation structure updated in Introduction"Sofia Wallin1-16/+74
2020-10-01Merge "Adding environment setup chapter"Sofia Wallin3-1/+152
2020-10-01Documentation structure updated in IntroductionAndrea Visnyei1-16/+74
Documentation structure has been updated to reflect the current one in Introduction. Issue-ID: DOC-636 Change-Id: I038cf040a0669cd83d7b00725db0d3620a8b8f4d Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-10-01Adding environment setup chapterAndrea Visnyei3-1/+152
Added info on git/gerrit setup to doc guide. Issue-ID: DOC-654 Change-Id: Ia9ca52b0277a18bb8934f15d1a5ec89a1f88cc9e Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-10-01Moving section from style guide to other chaptersAndrea Visnyei3-27/+25
Moved 2 sections to Introduction. Moved 1 section to Setting up/Creating Restructured Text. Issue-ID: DOC-670 Change-Id: I2b147d7e54f1b8e5f10521734b86531e66ad2c68 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-09-30Merge "Renaming files in documentation guide"Sofia Wallin4-3/+3
2020-09-23Add link to ccsdk-oran documentationelinuxhenrik1-0/+1
Change-Id: I2f4d2d46c69dc308acc4d2b1f1e2b98def08b26a Issue-ID: CCSDK-2833 Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
2020-09-18Renaming files in documentation guideAndrea Visnyei4-3/+3
Renamed files containing introduction, setting up, and converting to RST chapters to reflect content. Issue-ID: DOC-639 Change-Id: I5353fbf52dc635ee43464eb3284c13cedcaf6fa6 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-09-11Intro paragraph added to Coverting to RSTAndrea Visnyei1-0/+8
Some introductory information has been added to Converting to RST chapter of documentation guide. Issue-ID: DOC-666 Change-Id: Ic488145c995c40a507a9bb6759c9263a4f62a9b8 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-08-21Remove deprecated policy/engine docsPamela Dragosh2-3/+1
As suggested by Eric, removing the links to policy/engine repository documentation due to deprecation. Changed the reference to point to policy/parent, that should have been changed back in Dublin. Issue-ID: POLICY-2003 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com> Change-Id: Ic2dcca16e6f839bf5bb8c8a292ecc8f210c63df5 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-08-19Update doc aliasBogumil Zebek1-1/+1
Rename documentation alias for onap-oom-certservice project. Issue-ID: OOM-2526 Signed-off-by: Zebek Bogumil <bogumil.zebek@nokia.com> Change-Id: I1f6ddd103a8c0767ec81907bdb0e53b44291f787
2020-08-10Move cert-service documentation from aaf to oom/platformpawel1-2/+2
Issue-ID: OOM-2526 Signed-off-by: Pawel <pawel.kasperkiewicz@nokia.com> Change-Id: I9fefdbfcee36ac8763910833b80534880ad5d7b1
2020-08-06Add warning for copying/replacing conf.py in Guide for Testing One ProjectJakobKrieg1-0/+6
Issue-ID: DOC-651 Change-Id: I4f7a55b6e622598b746332aa5d8d7b88607ccefc Signed-off-by: JakobKrieg <jakob.krieg@bcmsolutions.de>
2020-06-15Merge "[DOC] Editorial changes in Documentation Guide"Eric Debeau2-18/+15
2020-06-15Update Architecture OverviewEric Debeau5-104/+161
Update with last figure for Architecture Update figure for 5G Add figure for MDONS Update width for figures Remove references to Release Remove media files no more used Align content with Marketing team - Add section on End to End Tests - Add MDONS Blueprint - Update Modeling section Add HTML links to blueprints Issue-ID: DOC-633 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I2443bbf092fa43e055f4c7775bc8f3583f57c636
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