summaryrefslogtreecommitdiffstats
path: root/docs/guides
AgeCommit message (Collapse)AuthorFilesLines
2021-05-19Add guide for a doc dev systemthmsdt8-22/+752
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-06Merge "[DOC] updated vFWCL deployment tutorial"Andreas Geissler29-0/+1392
2021-05-03Merge "Move examples from Addendum to Setting Up chapter"Eric Debeau4-159/+153
2021-05-02[DOC] updated vFWCL deployment tutorialramagp29-0/+1392
Change-Id: I0b24a7d8f809d33eee63e5ba77a71d89154e0a6e Issue-ID: DOC-720 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
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-13Merge "[DOC] Installation guidelines for PaaS components"Andreas Geissler1-0/+9
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-26Correct kubectl command in cloud-site manualandreasgeissler1-1/+1
Issue-ID: DOC-715 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I0d579707fc68b1a0d27562ce0a5b3a5659fe0578
2021-03-25Merge "Added a warning about the scope of the B&R description"Sofia Wallin2-6/+9
2021-03-23[DOC] Installation guidelines for PaaS componentsSylwia Jakubek1-0/+9
Linked documentation of guidelines for installation of Prometheus Stack and Cert-Manager Issue-ID: OOM-2701 Signed-off-by: Sylwia Jakubek <sylwia.jakubek@nokia.com> Change-Id: I90a1fb29a296927a8e695566939566f75e925258
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-18Added a warning about the scope of the B&R descriptionandreasgeissler2-6/+9
Issue-ID: DOC-718 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I26322041651995b7f649abd38664e8f42adffb27
2021-03-18Policy/Clamp doc updateosgn422w4-4/+4
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>
2021-03-08[DOC] Add link to VID documentation (Instantiate Service, “Macro” mode ↵Marcin Rzepecki5-6/+22
(PNF example)) Issue-ID: VID-970 Signed-off-by: Marcin Rzepecki <marcin.rzepecki@nokia.com> Change-Id: I20ff95a88ef013afb0cb80401e18f93238580032
2021-02-17[DOC] Resource Onboarding - licensesJerzySzachniewicz2-4/+5
Issue-ID: SDC-3471 Signed-off-by: JerzySzachniewicz <jerzy.szachniewicz@nokia.com> Change-Id: I9d5d5d0c841246f829d1ec20dc6589d6bc626b74
2021-02-09Merge "[DOC] Fix tox docs-linkcheck profile issues"Eric Debeau1-2/+6
2021-02-09Merge "[DOC] Fix docs buildtime warnings"Eric Debeau3-53/+36
2021-02-08[DOC] vFWCL design tutorialramagp26-0/+252
This describes step by step instructions for vfwcl design Change-Id: Ie6f88703e1923c06dec7ad45db78ef847cb68607 Issue-ID: DOC-708 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2021-02-06[DOC] vFW service deployment tutorialramagp31-0/+558
This describes step by step instructions for vfw deployment Change-Id: I4bf1bbbf02d0fc05cfd1d967c47eefe4453636c1 Issue-ID: DOC-708 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2021-02-02[DOC] Fix tox docs-linkcheck profile issuesGuillaume Lambert1-2/+6
- ignore URLs logically unreachable such as about:config - and create a code block for the git clone URL that is not reachable - ignore URLs with anchors (especially the ones ill-generated from external objects, mainly onap-integration) - enforce tox docs-lincheck profile Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I619d8d5697a35bf2bdf3ee2ed59ca9f5733e7802
2021-02-02[DOC] Fix docs buildtime warningsGuillaume Lambert3-53/+36
Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I28e269ee146df465e5b9230bd0356e4766c90089
2021-02-01[DOC] Tutorial for vfw service designramagp46-1/+299
This describes step by step instructions for vfw design Change-Id: I9910b43e6d596bbcb397cc6789dc973992b91c7f Issue-ID: DOC-708 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2021-01-21restructured UserGuide Section and corrected CLI Userguide Linkandreasgeissler2-2/+18
Issue-ID: DOC-705 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I1ef195b181d18ea47c99aec77a3e90bfcb8736a9
2021-01-14Merge "[DOC] Update Service Design documentation section"Andreas Geissler1-5/+7
2021-01-14Merge "Instructions for control loop design"Andreas Geissler11-0/+77
2020-12-29[DOC] Update Service Design documentation sectionramagp1-5/+7
This is to update few notes under Service Design section Change-Id: I6c401fceaf79d5fd74fadfb93902f1b67a63c903 Issue-ID: DOC-664 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-12-28[Add K8S site] Remove SO VNFAdapter manual version change V1->V2deen19851-61/+1
Change-Id: I4ca90b654c150b1f28ddaeb442cafdf529f730c3 Signed-off-by: Damian Nowak <damian.nowak@nokia.com> Issue-ID: DOC-698
2020-12-10Merge "[DOC] changes to backup and restore ONAP component specific data bases"Andreas Geissler3-2/+877
2020-12-10[DOC] changes to backup and restore ONAP component specific data basesramagp3-2/+877
Change-Id: I5e40c8b7a4a310414022224df82998b469fe556a Issue-ID: DOC-682 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-12-10Instructions for control loop designramagp11-0/+77
Change-Id: I49d4409c0939fbfd63a5e30dec518642e1de4005 Issue-ID: DOC-681 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-12-07Merge "Remove remaining warnings during Documentation buildings"Sofia Wallin6-142/+85
2020-12-07Remove remaining warnings during Documentation buildingsEric Debeau6-142/+85
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-12-02Merge "changes needed in Service Distribution"Andreas Geissler1-2/+3
2020-11-30Remove all warnings during Documentation buildingsEric Debeau23-197/+453
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 Wallin3-58/+68
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 Debeau3-58/+68
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-25Merge "changes to be added in few steps"Eric Debeau1-21/+24
2020-11-25Merge "[DOC] Fix for example-packages path not found issue"Eric Debeau1-1/+1
2020-11-25Merge "changes to be added in vfcreation"Andreas Geissler1-5/+8
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