summaryrefslogtreecommitdiffstats
path: root/docs/guides
AgeCommit message (Collapse)AuthorFilesLines
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>
2020-09-30Merge "Renaming files in documentation guide"Sofia Wallin4-3/+3
2020-09-24Merge "Reference link to be added"Sofia Wallin1-2/+2
2020-09-24Merge "Add missing ref links"Sofia Wallin1-3/+3
2020-09-23Add link to ccsdk-oran documentationelinuxhenrik2-0/+2
Change-Id: I2f4d2d46c69dc308acc4d2b1f1e2b98def08b26a Issue-ID: CCSDK-2833 Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
2020-09-18Renaming files in documentation guideAndrea Visnyei4-3/+3
Renamed files containing introduction, setting up, and converting to RST chapters to reflect content. Issue-ID: DOC-639 Change-Id: I5353fbf52dc635ee43464eb3284c13cedcaf6fa6 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-09-15Reference link to be addedramagp1-2/+2
Change-Id: I1528aaccffcc1269e46e022b78ae4c5e539979ee Issue-ID: DOC-668 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-09-15Add missing ref linksramagp1-3/+3
Change-Id: Iab57e73a928fa563c97eab8a64d98e464e2baeba Issue-ID: DOC-667 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-09-15Fix for SSL certificate issueramagp1-6/+6
Change-Id: I90a88ba5d8aa79dcc56818d0c06d693b469d082a Issue-ID: SDC-3284 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-09-11Intro paragraph added to Coverting to RSTAndrea Visnyei1-0/+8
Some introductory information has been added to Converting to RST chapter of documentation guide. Issue-ID: DOC-666 Change-Id: Ic488145c995c40a507a9bb6759c9263a4f62a9b8 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-08-27Merge "Correct bad reference links in user guide/pre-onboarding section"Andreas Geissler1-4/+7
2020-08-27Merge "VNF Validation Documentation broken link fix"Andreas Geissler1-1/+5
2020-08-27Correct bad reference links in user guide/pre-onboarding sectionEric Debeau1-4/+7
onap prefix is missing for 2 references towards vnfrqts project Issue-ID: DOC-660 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I3a08aed60793f56afce691d5b885117b2da2131c
2020-08-26Merge "Fixing pre-onboarding section ref links issue"Eric Debeau1-2/+2
2020-08-21Remove deprecated policy/engine docsPamela Dragosh3-4/+1
As suggested by Eric, removing the links to policy/engine repository documentation due to deprecation. Changed the reference to point to policy/parent, that should have been changed back in Dublin. Issue-ID: POLICY-2003 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com> Change-Id: Ic2dcca16e6f839bf5bb8c8a292ecc8f210c63df5 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-08-19Update doc aliasBogumil Zebek1-1/+1
Rename documentation alias for onap-oom-certservice project. Issue-ID: OOM-2526 Signed-off-by: Zebek Bogumil <bogumil.zebek@nokia.com> Change-Id: I1f6ddd103a8c0767ec81907bdb0e53b44291f787
2020-08-18Merge "Move cert-service documentation from aaf to oom/platform"Sofia Wallin1-2/+2
2020-08-10Fixing pre-onboarding section ref links issueramagp1-2/+2
Change-Id: Ia0b9d33044ae02ca92239be4d08862372c7480ce Issue-ID: DOC-637 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-08-10Fix for Heat requirements reference link issueramagp1-1/+1
Change-Id: Iac31130a15b1124f4a4ea96dfed634170009ada3 Issue-ID: DOC-655 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-08-10Move cert-service documentation from aaf to oom/platformpawel1-2/+2
Issue-ID: OOM-2526 Signed-off-by: Pawel <pawel.kasperkiewicz@nokia.com> Change-Id: I9fefdbfcee36ac8763910833b80534880ad5d7b1
2020-08-06Add warning for copying/replacing conf.py in Guide for Testing One ProjectJakobKrieg1-0/+6
Issue-ID: DOC-651 Change-Id: I4f7a55b6e622598b746332aa5d8d7b88607ccefc Signed-off-by: JakobKrieg <jakob.krieg@bcmsolutions.de>
2020-07-29VNF Validation Documentation broken link fixramagp1-1/+5
Change-Id: Id4a019ddb1781ab38a450caf21a941a183b83f6a Issue-ID: DOC-650 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-06-15Correct date for ONAP Release NoteEric Debeau1-4/+6
Update Date for the Release Update ONAP Platform Overvie with Frankfurt Release Issue-ID: DOC-606 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Ic4ad411ac6ff0af68076249e2c53c1c0b92689c9
2020-06-15Merge "[DOC] Editorial changes in Documentation Guide"Eric Debeau2-18/+15
2020-06-15Update Architecture OverviewEric Debeau5-104/+161
Update with last figure for Architecture Update figure for 5G Add figure for MDONS Update width for figures Remove references to Release Remove media files no more used Align content with Marketing team - Add section on End to End Tests - Add MDONS Blueprint - Update Modeling section Add HTML links to blueprints Issue-ID: DOC-633 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I2443bbf092fa43e055f4c7775bc8f3583f57c636
2020-06-11Remove extra back quotevmuthukrishnan@aarnanetworks.com1-2/+2
Change-Id: If80e78116b859b4d416e4781a0ae9babbecab6c2 Issue-ID: DOC-634 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-06-09Added a chapter "Verified Usecases" to add a TOC itemandreasgeissler1-1/+8
Added some small descriptioni for usecases Issue-ID: DOC-629 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: Ic76c2d091f1d6c37371a1012dddc8a4d701dfb80
2020-06-05[DOC] Editorial changes in Documentation GuideAndrea Visnyei2-18/+15
End to end view moved to Setting up from Introduction. Steps numbered in Setting up and Setting up project repositories title fixed. Issue-ID: DOC-623 Issue-ID: DOC-624 Change-Id: I36fa54c2a86e98f220a80391b91bd1408890a61a Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-06-04Remove link to Postman collectionsEric Debeau2-11/+1
The postman suite has not been updated for Frankfurt There is no more repo in Integration project Remove the link towards the Integration project containing the Postman collections Issue-ID: DOC-630 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I770184034b988772d0755dda8b1362c7134361be
2020-06-04Correction of NodePort list and removed SW versions for ONAP installationandreasgeissler2-117/+82
Corrections after comments... Issue-ID: DOC-627 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I452c6862e48f0ee30644d320a70f0644b9e23469
2020-05-27Correct Documentation display for bullet listEric Debeau3-35/+35
The new internal sphinx links auto-geenrated had some impacts on the display for some pages. This patch correct the RST files by adding some bullet lists guides/onap-developer/apiref/index.rst guides/onap-provider/index.rst guides/onap-provider/vnfvalidator.rst Provide better description for the links Issue-ID: DOC-619 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I4944a294516b90fbdfa998a623104ac6a85f3fe3
2020-04-13Fix links to new intersphinx format.Aric Gardner21-215/+221
Now that all the projects have anchors. convert links to intersphinx format Issue-ID: CIMAN-376 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I9c97ba7f6809446402cc2fa08add67a771e7e0fe
2020-04-09Remove devtool from docs.Aric Gardner1-10/+0
This project is archived. and cannot be converted. Issue-ID: CIMAN-376 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I2003bd12167043a28ff24694858afda480bce89c
2020-04-09Remove commented out doc code.Aric Gardner1-34/+0
This will no longer be relevant, and I am not going to covert this to intersphinx (as the endpoints don't actually exist) If this info is needed one can refer to this patchset Issue-ID: CIMAN-376 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I49c3d5a7b3622723eb93cb85d912a8aa948a1b75
2020-04-09Removing duplicate file SDC-Import.png due to case sensitivity problems on a MACafenner1-0/+0
Change-Id: Id18c01e4cd0c84f2ca2c02ee9cfded7847e5b1d9 Issue-ID: DOC-600 Signed-off-by: afenner <andrew.fenner@est.tech>
2020-04-07Merge "Changed User Design Guides to reflect the changes in the SDC in ↵Eric Debeau42-449/+423
Frankfurt Small additional changes"
2020-04-07Merge "Fix some documentation in multicloud"Eric Debeau2-13/+15
2020-04-02Intersphinx linkingAric Gardner1-0/+78
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