summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
2021-02-02[DOC] Fix sphinx add_stylesheet deprecated methodGuillaume Lambert1-1/+1
by using add_css_file instead Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: Ib8af980dc116fc551ca180c28cfb658bb6f86299
2021-02-02[DOC] Fix tox docs-linkcheck profile issuesGuillaume Lambert3-3/+19
- 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] Reactivate docs-linkcheck profileGuillaume Lambert1-8/+3
so that it can be used to identify broken links. Since there are still issues with some links, force tox results to success. Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: Iec1a5d913ad4fe6823476be545cb833084f146e5
2021-02-02[DOC] Enforce warnings at docs buildtimeGuillaume Lambert1-1/+1
Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I36294591e42737592ffecdd5ec8f7d231d3c50d1
2021-02-02[DOC] Remove tox.ini doppelgangerGuillaume Lambert1-44/+0
in docs folder - same profiles are declared in tox.ini. They can be calld from the docs folder without it. - once run from the docs folder, this generates invalid files in doc/.tox for linters setup (e.g. docs/.tox/[..]/invalid.rst). They can cause warnings treated as errors by root tox profiles. Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I473ae1193c1e5b124c8532a1b8185f01c67c70de
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-02[DOC] Use sphinxcontrib-needs versions < 0.6.0Guillaume Lambert1-1/+1
This latest version introduces a new services support functionality - that cannot be easily disabled here - and that requires additional configuration parameters to link GitHub issues. We cannot provide these parameters since this project uses JIRA. As a result, sphinx generates a warning. https://sphinxcontrib-needs.readthedocs.io/en/service/services/index.html Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I3bfa231467804729deacbe70f1180c06b3eec978
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 Wallin7-143/+86
2020-12-07Remove remaining warnings during Documentation buildingsEric Debeau7-143/+86
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-07Merge "Update architecture section"Andreas Geissler3-202/+208
2020-12-04Update architecture sectionEric Debeau3-202/+208
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-04Minor fix to the list of Project Specific Release Notes.Sofia Wallin1-3/+3
Removing "Project" which is not consistent. Issue-ID: DOC-694 Signed-off-by: Sofia Wallin <sofia.wallin@est.tech> Change-Id: I8310fbed05e0944d2b689c6da6ac2133deded1da
2020-12-03Merge "Removed outdated SO/Libs reference and missing DMaaP API doc"Sofia Wallin1-4/+0
2020-12-03Add functional and non-functional requirements listsEric Debeau3-4/+102
As decided in PTL meeting (30 november 2020), add list of functional and non-functional requirements Add :orphan: to avoid remaining warnings during Documentation build Issue-ID: DOC-687 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I305057e0de909e0165d0ca8a05b426e97ed1b111
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-12-02Merge "Remove all warnings during Documentation buildings"Sofia Wallin27-238/+42
2020-12-01Remove MSB from global Release NoteEric Debeau1-1/+0
As decided in PTL meeting (30 november 2020), remove MSB from release note beaause MSB is uing the Frankfurt Release container Issue-ID: DOC-687 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Ie14a2d1a01feb12a32822b3531f07150dd79fe98
2020-11-30Remove all warnings during Documentation buildingsEric Debeau27-238/+42
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 CII badge %"Sofia Wallin1-6/+35
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-27Correct CII badge %Eric Debeau1-6/+35
Correct CII badge % with last results from BadgeApp Corret Doc8 warnings Issue-ID: DOC-687 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I465055248b357f1ec5b22e9283f3a46a77df745a
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-26Update conf.py with latestEric Debeau1-1/+1
Issue-ID: DOC-683 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I3f6b7061fbefd6052b22895eb8175a6e61914bc1
2020-11-26Merge "Added links to older release docs for maintained components"Andreas Geissler1-1/+1
2020-11-26Added links to older release docs for maintained componentsEric Debeau1-50/+0
Issue-ID: DOC-672 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Ibb1a62d57b5ff57c0b273a5baad31e7d294559a2
2020-11-25Merge "Updated link to cert-service and corrected description for CLAMP in ↵Andreas Geissler2-2/+2
release Notes" into guilin
2020-11-25Merge "changes to be added in vfcreation" into guilinEric Debeau1-5/+8
2020-11-25Merge "changes to be added in few steps" into guilinAndreas Geissler1-21/+24
2020-11-25changes to be added in few stepsramagp1-21/+24
Change-Id: I7398a9c58efef3052d022314db4a9b703a30385d Issue-ID: DOC-661 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com> (cherry picked from commit 0e19d4ff1ac995a88a5a945c189e3c2169af225c)
2020-11-25Merge "changes to be added in few steps"Eric Debeau1-21/+24
2020-11-25[DOC] Fix for example-packages path not found issueramagp1-1/+1
Change-Id: I40345147dd85324b728b7356e89ae70e28658673 Issue-ID: SDC-3278 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com> (cherry picked from commit c95e6ed131e4505bb7f3671642a85d1fc9608286)
2020-11-25changes to be added in vfcreationramagp1-5/+8
Change-Id: I6471010c41d7481ef54a8cece0761831e49422c5 Issue-ID: DOC-662 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com> (cherry picked from commit 14655f5557c2b72913a6d19de543b7f24b92ef77)
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-25Merge "Update typos in Components List" into guilinEric Debeau1-3/+3
2020-11-25Merge "Cleanup use case part in doc repo" into guilinEric Debeau4-177/+0
2020-11-25Updated link to cert-service and corrected description for CLAMP in release ↵andreasgeissler2-2/+2
Notes Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: Iae1b2155a948a244930595c60539b1b6335575b4 (cherry picked from commit 79d76be5bc453e74ffa02b6a533efedae73a2ac9)
2020-11-25Correct intersphinx mapping for cert-serviceEric Debeau1-1/+1
Add platform in the and the '-' between cert and service Issue-ID: OOM-2526 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Ic798e8a8a3486e469e1623602891e13a8440b1d6 (cherry picked from commit 9dde43681f0819be43aeab1f05c2360ea1282ebb)
2020-11-25Updated link to cert-service and corrected description for CLAMP in release ↵andreasgeissler2-2/+2
Notes Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: Iae1b2155a948a244930595c60539b1b6335575b4