summaryrefslogtreecommitdiffstats
path: root/docs/guides
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-02-18Merge "[DOC] Fix tox docs-linkcheck profile issues" into guilinAndreas Geissler1-2/+6
2021-02-18Merge "[DOC] Fix docs buildtime warnings" into guilinAndreas Geissler2-51/+34
2021-02-15[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 (cherry picked from commit 5b9d80a4e9175cfd6bd7f2be33c540053f726005)
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-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 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 (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-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-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 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 (cherry picked from commit ab0c78bb275b345eb5e995a40a90e633980d7bca)
2020-11-30Merge "Correct broken links" into guilinEric Debeau3-58/+68
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 Geissler1-1/+1
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 Debeau2-89/+0
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 (cherry picked from commit 79d76be5bc453e74ffa02b6a533efedae73a2ac9)
2020-11-25Update typos in Components Listandreasgeissler1-3/+3
Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I3e5e9cdb0cb9cb586dd5a19ffccafd8f30cb8966 (cherry picked from commit 15f3917911bc6778758739301c4246e84de3ee5d)
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 (cherry picked from commit 0c78ada4020a743fcd5c8b299fd3b0cb05c8b8f1)
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 (cherry picked from commit e7070c0a214a14b41baa4b04c5754f2b976754d7)
2020-11-25Update use case section for Guilinmrichomme1-1/+2
section has been split in 2 - Guilin use cases - Deprecated use cases the user guide shall also include the use case of the release.. Issue-ID: INT-1736 Signed-off-by: mrichomme <morgan.richomme@orange.com> Change-Id: I4d42605858924911f5c5b1f40836043966c20ee7 (cherry picked from commit b83ccbaea962083b37b3e097e76df23731bd0835)
2020-11-24Added links to older release docs for maintained componentsandreasgeissler1-0/+40
Issue-ID: DOC-672 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: If10a83665768cf3695b977448a3dd79f44f9b4dd (cherry picked from commit 8787afd724f24201b1e21ad0b8839c8189e51364)
2020-11-05Modify the Service Design Guide to match Guilin releaseandreasgeissler14-46/+60
Issue-ID: DOC-674 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I50521ea0b93a507bb3888feae6a6ef7855a4d6e0
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-16Merge "Redesigned the ONAP Modules page Issue-ID: DOC-672"Eric Debeau1-226/+339
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-16Merge "Removed active-projects reference, as redundant info to ONAP Modules ↵Sofia Wallin1-77/+0
and Functionalities Issue-ID: DOC-671"
2020-10-15Removed active-projects reference, as redundant infoandreasgeissler1-77/+0
to ONAP Modules and Functionalities Issue-ID: DOC-671 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: If022c077d58743e5943b85fcf8c9709b7f225b4a
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-09Remove onap-aaf-certserviceJessica Wagantall1-1/+0
Remove onap-aaf-certservice from the list of current active projects. Issue-ID: CIMAN-33 Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org> Change-Id: I58b08ee750766a9f8c534e1438c45d1662f490ae
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>