summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
AgeCommit message (Collapse)AuthorFilesLines
2022-08-15improve navigation and readabilitythmsdt1-8/+37
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ib4f8246d548a77885c5f6c5457ce2c3b20e275b6
2022-08-10improve doc navigation (project specific release notes)thmsdt1-2/+2
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Iad0b8cd373aaa70dc4ad56c6416fbeae4fb8ccc0
2022-08-04update and rearrange documentation related contentthmsdt1-16/+12
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Id454ec5f09903efb81123669e6eb024f21a08797
2022-07-05Revert "add security related docs (osa)"Thomas Kulik1-0/+1
This reverts commit 6458ba752df13912f3497576949f85192a9ca8b5. Reason for revert: <build problems> Issue-ID: DOC-782 Change-Id: Ie07ea0d4b0d3bf1cb5d378d9b3b248e5d580fe5e Signed-off-by: thmsdt <thomas.kulik@telekom.de>
2022-06-27add security related docs (osa)thmsdt1-0/+3
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I8e4f6692c6249e16a1862ec533620c1a43a579d6
2022-05-31remove repos without j branch from docsthmsdt1-5/+1
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ie41998cefa08327be5eb3cedc659e69afb84bfbe
2022-05-03provide also project specific release notes in navigationthmsdt1-2/+6
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I8d920b2b46ee57c9b8cdb0f1a25491a856b5b9df
2022-05-02remove unmaintained repos from jakarta docsthmsdt1-5/+0
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ice20b360b2a438ee74a60d51d73292e8714b2531
2021-12-20fix sphinx config example files and update readmethmsdt1-2/+2
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I1facd195d3fddf158ebdd7deb3c8882e7db35277
2021-05-19Add guide for a doc dev systemthmsdt1-2/+7
Issue-ID: DOC-742 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ie6071576bce613edaf50433b7b84b69b16e0e88c
2021-04-29Add reference to OSA repo from main documentation pageKrzysztof Opasiak1-0/+3
In order to make it easy for users to find, let's add OSA reference to the main page of ONAP documentation Issue-ID: SECCOM-239 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I2c009a1a21289c2dd18f0e60122a24ec86aefb40
2020-11-30Remove all warnings during Documentation buildingsEric Debeau1-1/+1
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-10-15Removed active-projects reference, as redundant infoandreasgeissler1-3/+0
to ONAP Modules and Functionalities Issue-ID: DOC-671 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: If022c077d58743e5943b85fcf8c9709b7f225b4a
2020-04-02Intersphinx linkingAric Gardner1-1/+3
each project now has its own read the docs page example: https://onap-oom-offline-installer.readthedocs.io/ this will redirect to the subproject location in this case: https://onap-doc.readthedocs.io/projects/onap-oom-offline-installer/ Added a new section on the main page: active-projects it shows linking in action. you can click through to the subproject docs from there. you will land on genindex.html This is not ideal To see why this is the case you can run python -m sphinx.ext.intersphinx 'https://onap-doc.readthedocs.io/ projects/onap-oom-offline-installer/en/latest/objects.inv' refer to https://gist.github.com/Aricg/27c739da7c35d201e9ca034df6e30ef6 we must link to one of the avaliable std:label This means that each project should add a lable to its main index page so that we can propery link it. eg, in their index.rst add .. _projectname-mainindex: or something we can agree on. Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I0e1b506d113b9fbbcf2cb854482dfb557d8012b7
2020-02-07sphinxcontrib-needs extension to workAric Gardner1-0/+1
template added in the conf.py file that signifies the metadata allowed. necessary for the vnfrqts project. Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I9c50dc18ac22ec7ca575186a4761e1a277387b50
2020-01-29Changes to doc configAric Gardner1-0/+1
now uses lfdocs-conf pip package. needed for future move to rtdv3 jobs. Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: Ic08a81100d8a4c59c2d326161662f207cfd9e25e
2020-01-27Removed pin on sphinxcontrib-blockdiagAric Gardner1-1/+0
This broke local tox builds for me on python3 added a tiny change to index.rst so that this will trigger a verify Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: Iad3047f02c7e00f3aac1bb998e3750363479df1f
2019-12-11Creating an "Operations and Administration Guides" section and restructuring ↵andreasgeissler1-11/+7
chapters Issue-ID: DOC-543 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: Ia06c13cdf4299078c0fa5b133d50fe3d83c0cf59
2019-10-14Update release note labelEric Debeau1-2/+2
Remove Dublin reference Update Overview.rst adding El Alto line in Release table Issue-ID: DOC-554 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I14af0d147dea4a506da948f29b6a508293b3af68
2019-05-30Release Notes upgradedNoemi Wagner1-1/+4
We have added Release notes to the landing page, corrected release note label for Dublin, updated release info in Overview doc, removed overlapping content from Release Notes (content available in Overview) Change-Id: Ib03c38abfa115fd10cb0f8c64877ee140d6fece3 Issue-ID: DOC-471 Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2019-05-17Link correction in Landing page and removal of Dublin release namingNoemi Wagner1-3/+3
The link to VNF/PNF requirements doc has been corrected in the table on the landing page. Also the name 'Dublin release' has been removed from the text. The final sentence on navigation has been removed as it referred to the left bar, which might change in the future with the new theme. Issue-ID: DOC-353 Change-Id: Ic0b8b861dd83a338caa5403ccef9175d1af6ea43 Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2019-05-14Structural changes to documentationNoemi Wagner1-31/+35
Link corrected in landing page to the overview document. We moved out from the Developers Guide: Architecture, Developing ONAP, Setting-up ONAP. We renamed 'Developing ONAP' section to 'ONAP components and functionalities'. (Later we plan to further improve the current content of the Developing ONAP section, that is, we e.g. plan to move 'Documentation' part to Developers Guide). We are not 100% sure that 'ARchitecture'/'Setting up ONAP'/'ONAP components and functionalities' (current Developing ONAP) shall be 'duplicated or not, that is, shall be visible on the left bar AND under Developers Guide as well, OR only in the left bar. Issue-ID: DOC-449 Change-Id: Idca0bacac3c7cb28a870a7ea5f8beb54fda0187c Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2019-05-14Updating release nameSofia Wallin1-2/+2
Updating from Casablanca to Dublin where needed. Some sections still need input for updates. Issue-ID: DOC-464 Change-Id: I5f015716109ba4939517b0babab2b046c510bf8a Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
2019-05-13VNFRQTS - Updating title to VNF and PNFHagop Bozawglanian1-30/+31
The naming convention has changed from xNF, VNF/PNF to VNF and PNF so I need to update the names to reflect this change. Change-Id: Ib47dfa2b4e67600663bdbd077585b9a436f4f47b Issue-ID: VNFRQTS-507 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com>
2019-04-26Overview document createdNoemi Wagner1-0/+1
The overview document targets to provide the reader with a basic understanding on ONAP and its basic functional description.The doc also provides insight to Benefit of ONAP, licenses needed, basic releases etc. Issue-ID: DOC-364 Change-Id: I87c10896dc308d24d5aa8b54d920545372ffc41d Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2019-02-20Sidebar enhancementAndrea Visnyei1-2/+2
Added the Architecture and the Setting up ONAP pages to the sidebar Issue-ID: DOC-401 Change-Id: I90261a5abf2aebd603692c05d6a7a29ce1decddc Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2019-01-08Adding HomeNoemi Wagner1-0/+1
Adding home to the left bar will enable the reader to go back to the list and description of docs, if he/she has searched around the content. Issue-ID: DOC-372 Change-Id: I560622585d4af9e1cfb62b7b11c76b0ada9a1c8e Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2018-12-18Landing page restructuredNoemi Wagner1-17/+32
The detailed description on ONAP and the architecture figure have been removed form the landing page. The table on documentation types has been added to the landing page. Issue-ID: DOC-353 Change-Id: Iadc0aa94bb3db62d7a0f73924a7afdd34889a6f7 Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2018-12-05New landing page structureNoemi Wagner1-10/+36
On the landing page there was no generic and basic info on ONAP yet, this has been added. A new architecture figure has been created. ONAP documentation was made available from this main landing page as well. The side bar of the landing page has also been changed. So far the section of the Release note have been made available from here, but now only the main doc titles are listed. Issue-ID: DOC-351 Change-Id: I381c8e232438c51211a8a9303ea3589ebea4d4a4 Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
2018-11-30Remove Beijing referencesEric Debeau1-3/+4
Issue-ID: DOC-362 Change-Id: I4c3738e28a33de18f3ddb14d88433e60b0168710 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-11-23Removal of index and search from the landing pageGergely Csatari1-8/+0
Index: The index did not cover the whole documentation and the index entries were not referenced from the text, therefore it is not useful. The long term plan is to replace it with a proper glossary, so the '.. index::' tags are not removed. Search: The search page is an empty page, while the left bar already contains a working search function. Issue-ID: DOC-356 Change-Id: Ibda434a302d90ed16d4f8c2c5b986d16306f0c25 Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
2018-09-13Switch theme and add report issueRich Bennett1-2/+2
Switch to sphinx_rtd_theme Add report issue in Jira with current page/release context Change-Id: Ie237ee4d084f2b8bd025acc7499d19563f6e3e68 Issue-ID: DOC-310 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-09-01Cherry pick beijing improvements to masterRich Bennett1-5/+3
Replicating changes made when finalizing Beijing branch in the doc master branch. Change-Id: Ib1da658aef8cb84f896c6abac23631579ec0b80c Issue-ID: DOC-280 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-08-31DOC - Updating location of the VNFRQTSBozawglanian, Hagop (hb755d)1-0/+1
Moving the level of the doc project for the VNFRQTS. Issue-ID: DOC-318 Change-Id: I28d512744048acd008dfe127a86fb0c5d1bed480 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
2018-06-14Add description of master and stable releasesRich Bennett1-0/+10
Make it clear the master is not a stable release Provide redirects for a stable release Change-Id: Ia6a8706614cd0b35c857743fee6c11c5178d3590 Issue-ID: DOC-281 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-01-16Create use case example and structureRich Bennett1-0/+1
Change-Id: Ia4eff37921ee6d38b86fc3c50176757ef9d56ff8 Signed-off-by: Rich Bennett <rb2745@att.com> Issue-ID: DOC-223
2017-11-03Multiple editorial improvementsRich Bennett1-3/+2
Release notes expanded outline and content Release notes for doc projet Remove aai/sparky-fe submodule combined with spark-be Remove Module & Renamed Index and Search Change-Id: I4eeabee3604f1ffc4bb02dd4125a1770a77812d1 Issue-ID: DOC-147 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-09-14Add aai/search-data-service as submodule to docsMatthewHarffy1-1/+1
First AAI doc submodule repo inclusion, following instructions from readthedocs.io Setting Up page. Change-Id: I61fe98666370691d447c658262a299bf909d5ae1 Issue-Id: DOC-77 Signed-off-by: MatthewHarffy <Matthew.harffy@amdocs.com>
2017-09-13Enhancement and additions for webinarRich Bennett1-6/+4
Add templates, revise master index, guides, and release document Improve project integration instructions based on 5 project integrations. Change-Id: I2a3e62737f3c126b7f5fb7cc4f53b35dba4f1d8f Issue-ID: DOC-26 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-07-25[DOC-57 Add vnfrqts/guidelines submodule]Rich Bennett1-5/+9
Change-Id: I483f12449de27a00421289438c73baa38e0fa1af Signed-off-by: Rich Bennett <rb2745@att.com>
2017-07-19[DOC-23]Initial structure and Documentation GuideRich Bennett1-0/+20
Change-Id: Ie0fdb7be60acd79b878c2d9b985aaaf6aca035d2 Signed-off-by: Rich Bennett <rb2745@att.com>