summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2021-10-14Split concreate and abstract dependenciesCédric Ollivier2-2/+2
It adds 2 upper-constraints to pin all the dependencies. It modifies a little bit the official upper-constraints.txt from OpenStack due to Sphinx (4.2.0 as asked by lfdocs-conf vs 3.5.2) and due to setuptools (58.1.0 as used in ONAP gates vs 54.1.1). In a long run, etc/upper-constraints.os.txt should be removed once ONAP is synced with OpenStack. For it's part, etc/upper-constraints.onap.txt should be centralized for all ONAP projects and then removed from this particular project. It should be noted that lfdocs-conf still mismatches concrete and abstract deps. Issue-ID: DOC-765 Change-Id: Iccf1e4cdab93acc9c55acb16cb11e3b3fcef3291 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> (cherry picked from commit ee3abf180c9df7813f16ee9fba7958860fc9ea6b) (cherry picked from commit cd4ff7e384bbb178a3b1cbc185a79da2df343b38)
2021-05-04Updated Release Date and content list for Guilin 7.0.1andreasgeissler1-3/+2
Issue-ID: DOC-709 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I3c4dfe597ccda08d196df771894e0f680bb1a4c5
2021-03-10Update the Release date and corrected component changesandreasgeissler1-4/+3
in composite release note Issue-ID: DOC-709 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I6e94cf6996be246322a107c0bf788e126e32c9e0 (cherry picked from commit 5c52765979e697e98eb648702a285085892092b5)
2021-03-10Merge "Added DOC release note for 7.0.1" into guilinAndreas Geissler1-4/+29
2021-03-02[DOC] Run autopep8 on conf.pyGuillaume Lambert1-24/+36
Issue-ID: DOC-710 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I95b674bd459f97afcab05ce71f217ac70114cf1b
2021-03-02[DOC] Improve words whitelistGuillaume Lambert1-0/+10
Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: Ie8717e321bc1e05dd9b7969ed067952e66e4a813 (cherry picked from commit e06aa164219491219e8a3a39b6d9f04496b9f0d2)
2021-03-02[DOC] Use words whitelist default filenameGuillaume Lambert1-0/+0
Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I00c67d2c749023e9f342f27edff62f21af45a563 (cherry picked from commit 1abd85aa9d46fb5e67f94cb7029732f14141ffe1)
2021-02-18Merge "[DOC] Fix sphinx add_stylesheet deprecated method" into guilinAndreas Geissler1-1/+1
2021-02-18Merge "[DOC] Fix tox docs-linkcheck profile issues" into guilinAndreas Geissler2-2/+20
2021-02-18Merge "[DOC] Remove tox.ini doppelganger" into guilinAndreas Geissler1-44/+0
2021-02-18Merge "[DOC] Fix docs buildtime warnings" into guilinAndreas Geissler2-51/+34
2021-02-18Merge "[DOC] Fix docs/conf.py" into guilinAndreas Geissler1-1/+1
2021-02-16Added composite release note for Guilin 7.0.1andreasgeissler1-3/+42
Issue-ID: DOC-709 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I44005e42556b020e97c97c7c01a1b0297073f0bb (cherry picked from commit 52c45d827ecc6fcaf55a51e5ffa684e077feb0ac)
2021-02-16Added DOC release note for 7.0.1andreasgeissler1-4/+29
Issue-ID: DOC-704 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I3edb18126d2baa4dc93c164249d052d62b7865ec (cherry picked from commit c4f97aa190e20d0f5630d3f7ff2794a79a51ff89)
2021-02-15[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 (cherry picked from commit 3e25eeb9b2c67473ed1513fa1c6aad0ab68f9edc)
2021-02-15[DOC] Fix tox docs-linkcheck profile issuesGuillaume Lambert2-2/+20
- 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 (cherry picked from commit 5b9d80a4e9175cfd6bd7f2be33c540053f726005)
2021-02-15[DOC] Remove tox.ini doppelgangerGuillaume Lambert1-44/+0
in docs folder - same profiles are declared in tox.ini. They can be called 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 (cherry picked from commit 406a9c94549c014fab8d777a788832f3a9197703)
2021-02-15[DOC] Fix docs buildtime warningsGuillaume Lambert2-51/+34
Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I28e269ee146df465e5b9230bd0356e4766c90089 (cherry picked from commit faffc27b609a194af9277ec247291ae86e4817c3)
2021-02-15[DOC] Fix docs/conf.pyGuillaume Lambert1-1/+1
Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: Iae1554c7ce71a2493b0ddde1ec0b94a9cd7623a4
2021-02-11[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> (cherry picked from commit e47c7f67b3afeccad18e170c021fea6d36c054a8)
2021-02-11[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> (cherry picked from commit 6188f9d73f583e3204b575322abbef879046b4ce)
2021-02-02[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> (cherry picked from commit 91a99bada18b1d636f35c939a16cb5fc78b71586)
2021-01-28restructured UserGuide Section and corrected CLI Userguide Linkandreasgeissler2-2/+18
Issue-ID: DOC-705 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I1ef195b181d18ea47c99aec77a3e90bfcb8736a9 (cherry picked from commit b3616d6a4ac7191dc1b2c77906f56704888fd11a)
2021-01-21Merge "[DOC] Update Service Design documentation section" into guilinAndreas Geissler1-5/+7
2021-01-14[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> (cherry picked from commit b912ee5c354522854a331cbaff4d3ffa8a3baea6)
2021-01-14Instructions for control loop designramagp11-0/+77
Change-Id: I49d4409c0939fbfd63a5e30dec518642e1de4005 Issue-ID: DOC-681 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com> (cherry picked from commit 9198d86003bafe94870ded9b1c376a6164c43e00)
2021-01-08[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 (cherry picked from commit b226ddffd6b38274eb2e397ac060afb767f0e098)
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 (cherry picked from commit 3028409da25aa4dbefc7fe8e30e196753275b27d)
2020-12-07Update 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 (cherry picked from commit ae97753f82eb63f7d8d701247febc40298fed8c0)
2020-12-05Minor 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 (cherry picked from commit b7ac9e9889e9819b3b6fca99c1f18484433b1093)
2020-12-03Update conf.py with the correct branchEric Debeau1-57/+60
Some projects have not branched for Guilin Some projets have no Guilin, Frankfurt branch Modify conf.py to be aligned with the correct branch Re-order by alphabetical order Verified with sphinx linkcheck Issue-ID: DOC-690 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Ie6157ab587fc49fa5fb9a6a177ddade24daf4bbe
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 (cherry picked from commit bf283cdd19462cdb290d8dd1f8e2c27551ad1c5f)
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 (cherry picked from commit e26a0d78084d175e7c4612657857ca2f9030f1f4)
2020-12-02changes needed in Service Distributionramagp1-2/+3
Change-Id: I8779b47add051c2aadef79980c1ed6b31b98dabd Issue-ID: DOC-665 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com> (cherry picked from commit 02584d5bdfd3bcc53353c7759452bcd4a31a56c6)
2020-12-02Remove 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 (cherry picked from commit ab0c78bb275b345eb5e995a40a90e633980d7bca)
2020-12-02Remove 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 (cherry picked from commit ab61350eb0d62d054b597b8eb45a314d8e9e332d)
2020-11-30Merge "Correct broken links" into guilinEric Debeau3-58/+68
2020-11-30Merge "Correct CII badge %" into guilinEric Debeau1-6/+35
2020-11-30Correct 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 (cherry picked from commit a10eeeb67d00de2f536af834d7745650a1a48396)
2020-11-30Correct 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 (cherry picked from commit b2af2a7a848b29227c69489f2faf4f28e9a5dced)
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> (cherry picked from commit 458d2753ddfd9dfde02cd2713e196c6cdcd11c4f)
2020-11-26Update Components list with master branchandreasgeissler1-50/+0
Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I507f57998431fe3d0920c90267c785198512961a
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-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 "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