summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer
AgeCommit message (Collapse)AuthorFilesLines
2018-04-26Add tox environment for spellcheckRich Bennett3-5/+19
Updates to how-to use documentation for linkcheck and spellcheck Initial list of validword exceptions for immediate use of tox -espellcheck Validword exceptions will be improved when DOC-262 is complete Corrections of RST references based on recent Beijing contributions Change-Id: Ic82de1088fd961c2ad91493e8736777aede1cdb1 Signed-off-by: Rich Bennett <rb2745@att.com> Issue-ID: DOC-94
2018-04-24add links for externalapi/nbiRene Robert2-1/+3
Issue-ID: DOC-256 Change-Id: I4e236eca2cf78424ccfd40dd90a5eaf76dadc75f Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-04-18Add platform operations to user guidesRich Bennett4-54/+12
Reference OOM cloud set up, quick start, and user guide Top level User Guide wiki sections already migrated See DOC-259 http:gerrit.onap.org/r/42333 Remove references to non-existing project sections. Change-Id: I09f5faf019f76b3ccddaffa2b97f3efcf183a7f0 Issue-ID: DOC-250 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-04-11Clean-up using onap sectionRich Bennett1-4/+7
Migrate top level structure from wiki Eliminate duplicated subsections Move to current stable release of Sphinx (1.6.7) Change-Id: I2999962c306d69756161cb90993694877265b476 Issue-ID: DOC-259 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-04-04Provide structure for VNFsRich Bennett1-0/+9
Add to index hierarchy guides/onap-developer/architecture Create section template vnf-reference Change-Id: If1b7b2b89de906c66e43382a9bc9dc2bee4086e5 Issue-ID: DOC-260 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-03-29Developer Guide Index UpdatesRich Bennett1-19/+10
Remove SVNFM section from project developer guides Use project name, expand acronyms, re-order external API framework Change-Id: Ie47d6331097c2d7d15f78ab258d57f297cac2694 Issue-ID: DOC-251 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-03-28Merge "Fixing empty lines around the code block"Gregory Glover1-1/+4
2018-03-28Correct link to externalapi/nbi.gitRene Robert1-1/+1
Issue-ID: DOC-257 Change-Id: I0089dbb7032c33935c175cbdc438c2d8d136a76d Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-03-28Fixing empty lines around the code blockMars Toktonaliev1-1/+4
Issue-ID: DOC-252 Change-Id: I614a8b957c37320bc3d0c14d460c197a4becf1cd Signed-off-by: Mars Toktonaliev <mars.toktonaliev@nokia.com>
2018-03-28add links to externalAPIRene Robert2-0/+11
Issue-ID: DOC-256 Change-Id: Idf3e126090253603466533f34dd0b466cc0f5356 Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-03-21Add MUSIC project submodule and toctree refsRich Bennett2-0/+10
Change-Id: I88174a9eae28b4cf212ad6059d36b3ffff101ff1 Signed-off-by: Rich Bennett <rb2745@att.com> Issue-ID: DOC-253
2018-03-21Merge "Change Amsterdam by Beijing"Rich Bennett2-63/+143
2018-03-20Change Amsterdam by BeijingEric Debeau2-63/+143
Modify Amsterdam by Beijing Correct to pass DOC8 Change-Id: Ia26a7f95617c5f00d646ddd5ccb66d69c27b1bcc Issue-ID: DOC-239 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-03-17Added DNS forwarding sample configurationMars Toktonaliev1-1/+22
Issue-ID: DOC-252 Change-Id: I4706df9f24b3b0108d2936682fcce061a16c3607 Signed-off-by: Mars Toktonaliev <mars.toktonaliev@nokia.com>
2018-03-12Merge "Add Nokia SVNFM driver documentation"Rich Bennett1-0/+9
2018-03-12Add Nokia SVNFM driver documentationDenes Nemeth1-0/+9
Change-Id: I8b92b024908400d947e1ef896432561098b9a2bc Signed-off-by: Denes Nemeth <denes.nemeth@nokia.com> Issue-ID: VFC-728
2018-03-09Updated designate configuration linkMars Toktonaliev1-3/+3
Issue-ID: DOC-164 Change-Id: I832e96da0e3a6c0f4ddb693c7806dd9e32f785a3 Signed-off-by: Mars Toktonaliev <mars.toktonaliev@nokia.com>
2018-01-27DOC-239 : Replace Amsterdam by BeijingEmmanuel Bidet1-10/+10
Amsterdam replaced by Beijing 5 trailing spaces suppressed Issue-ID: DOC-239 Change-Id: I58367547c79badc9f4e386aa748f7ca62d4f5092 Signed-off-by: Emmanuel Bidet <emmanuel.bidet@m4x.org>
2017-12-05Add doc detailsDeterme, Sebastien (sd378r)2-20/+31
Add details to the doc, like additional links or explanation. Change-Id: I9596b137ac48c474e608a4901941b96de927e33f Issue-ID: DOC-211 Signed-off-by: Determe, Sebastien (sd378r) <sd378r@intl.att.com>
2017-11-28Update content of Integration pageGildas Lanilis1-5/+2
-remove link to former submodules/integration.git/docs/index.html -add link to new getting ONAP installed -add link to manifest file Issue-ID: DOC-203 Change-Id: I8f4c470aceb89295db09116e73cb9cd57edb4614 Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
2017-11-27Add explanation how to use branchesBlaisonneau David3-45/+687
Add what is a GIT branch, and what are the best practices in an ONAP context Issue-ID: DOC-207 Change-Id: Ifcab27b13df4719b16c6c3df84c2caafe7864973 Signed-off-by: Blaisonneau David <david.blaisonneau@orange.com>
2017-11-22Improve doc to install individual cptsGildas Lanilis1-4/+6
-Provide context and recommendation in "Setting Up individual ONAP Cpts" -Link Master RN to the above improvement Issue-ID: DOC-204 Change-Id: Iccbb1e19458b4bf3e16e54eb63c2f3bc3337f7fc Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
2017-11-21Merge "Update link in Master Release Notes"Gregory Glover1-0/+2
2017-11-21Issue-id: DOC-202Abdelmuhaimen Seaudi1-0/+1
modified: docs/guides/onap-developer/settingup/components.rst Change-Id: Ieefcdc7c9f924f69227040980ccc8d032d82e774 Signed-off-by: Abdelmuhaimen Seaudi <abdelmuhaimen.seaudi@orange.com>
2017-11-21Update link in Master Release NotesGildas Lanilis1-0/+2
-Use reference instead of http URL to limnk to other readthedoc pages Issue-ID: DOC-150 Change-Id: I840c305feabcefd3927e1fdd396e4c1a77a4ce16 Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
2017-11-20Update Master RN and Setting up ONAPGildas Lanilis1-37/+32
-Update Release Notes on developers skill required for independant installation -Update ONAP getting star with typo, links and clarifications Issue-Id: DOC-150 Change-Id: I59b3bad9eda994b65d13a99f33d8edb3396740c2 Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
2017-11-18Add Tutorial Links & Getting StartedRich Bennett1-3/+14
Add tutorial DW links to onap-developer/tutorials Changed Release title to "Getting Started With Amsterdam" Removed references to repos where Change Platform Adminstrator to User Portal information is aggregated at higher level Update DOC release notes Change-Id: I1b5f04ec0e2e4aae7e75013790f823c7b272b6ba Issue-ID: DOC-190 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-11-17Merge "Update the setting-up"Rich Bennett1-4/+21
2017-11-17Update the setting-upEric Debeau1-4/+21
Indication of manual tasks to perform for DCAE components Suppress link to Rackspace Minor editorial changes Change-Id: I6a9ee260e3454b729b4539b9bb6cab26e6fbe2ce Issue-ID: DOC-153 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2017-11-17Correct errors in linksEric Debeau1-8/+8
Change-Id: Ia912c2b771b2b665923bdb084e8f40effeedd97a Issue-ID: DOC-181 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2017-11-17Merge "Update ONAP Architecture diagram"Rich Bennett1-0/+0
2017-11-17Update ONAP Architecture diagramChris Donley1-0/+0
Replace top-level architecture diagram with TSC-approved version Issue-ID: DOC-180 Change-Id: I3a30472f2b4b5be89ccc17b4d56be4f988630bfb Signed-off-by: Chris Donley <christopher.donley@huawei.com>
2017-11-17Improve References to User GuidesRich Bennett7-4/+13
Insert Note before DW User Guide Links Add index entries to for major sections topics Remove requirement.txt workarounds after RTD change to recognize readthedocs.yml in the root folder Update release notes Change-Id: Id57ff10a055ea1d1e5394170d5b5b401d51d58ab Issue-ID: DOC-60 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-11-16Update Setting UP according to doc meetingEric Debeau2-31/+264
Merge Former Integration.rst Align with Readme demo file Add link to designate installation Add link to the wiki for the component lists Add information about OpenStack providers Change-Id: I932b1b4d186e19f85308c93dc8421d74f5353f8c ISSUE-ID: DOC-153 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2017-11-15Adding a page to explain how to install designateSylvain Desbureaux1-0/+53
Change-Id: Ifaf28f12c5892f22c43fc54192128128cb617059 Issue-ID: DOC-156 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com>
2017-11-14Update settingup docEric Debeau1-48/+117
Provide the list of vm with flavors, images Correct list of OpenStack components Provide list of artifacts Update links Change-Id: Ic6412ffe6d935bdbdd521f9ad727f9baca6e7b9c ISSUE-ID: DOC-153 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2017-11-13Merge "Changes to project references"Jun Hu1-0/+8
2017-11-13Create the list of component setting-upEric Debeau1-1/+49
List the reference towards to the installation of the various components Change-Id: Ib9a46735c2145c2b1f67d9f2888eb00e55a8bf88 ISUUE-ID: DOC-153 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2017-11-13Changes to project referencesRich Bennett1-0/+8
Restore OOM as visible / experimental project Reference toscaparser release notes Change-Id: Ibfee17d96511a51e3ba7c7816b5918c19bafdd99 Issue-ID: DOC-171 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-11-13Fix reference for vnfsdkEric Debeau1-1/+1
Change-Id: I3925656cc4669c90243f3c4c2118a85780632bb9 ISSUE-ID: DOC-152 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2017-11-13Fix figure numberingPawel Pawlak1-12/+14
Corrected numbering of figiures in text and some minor editorial issues Issue-ID: DOC-151 Change-Id: I60f89d3d11fbe6dd33f9b871a3c70aa8ba7f6de9 Signed-off-by: Pawel Pawlak <Pawel.Pawlak3@orange.com>
2017-11-13Merge "Consolidated ccsdk references"Rich Bennett7-212/+200
2017-11-13Merge "Pull submodules when running tox"Rich Bennett1-10/+2
2017-11-13Consolidated ccsdk referencesRich Bennett7-212/+200
ccsdk will provide documentation for multiple repos in ccsdk/distribution. Split content in settingup/index into two sections Eliminated Tutorial section now provided by setting up ONAP Change-Id: I2412dcaa03b0c6a34b90e69c950b62f56989fdb8 Issue-ID: DOC-130 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-11-13Pull submodules when running toxCédric Ollivier1-10/+2
Otherwise it only works via jjobs but tox is also designed for users. It creates a new venv to ease testing it before integrating in jjobs. The documentation is updated as well to refer to the new venv. Issue-ID: DOC-159 Change-Id: Ida2ad14ebcf54ab776c2439dd83e74364432af46 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
2017-11-10Update apirefEric Debeau1-7/+15
Add reference to VNF SDK Remove reference to AAF Align component namings Change-Id: I21c65357f9bd42ee305b9cc87e49937427ebeee8 ISUUE-ID: DOC-152 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2017-11-09Update Setting-Up ONAPGildas Lanilis1-12/+15
Edited index.rst file with minor typo and formatting Change-Id: I622e3c45c4029fab7856d4c369e718a12dc13cb5 Issue-Id: DOC-153 Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
2017-11-09Initialize Setting-Up ONAPEric Debeau1-2/+163
First version with the structure of the documents. To be completed. Change-Id: I3b2720b5429773d3614cdbb90230b55b08692c0f ISSUE-ID: DOC-153 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2017-11-09Restore MultiVIM project & remove apiexamplesRich Bennett2-8/+11
Preparing for Amsterdam branch, restore MultiVIM in project views Remove apiexamples from template section now that real examples are available Change-Id: I18f66e97dd32ea1c86d0245e92ebe17ca37b3da2 Issue-ID: DOC-112 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-11-08Integrate architecture overviewRich Bennett3-134/+152
Adjusted headings to fit index Corrected references to images Made architecture provided by projects a reference list Added build time and dropped the sphinx version on footers Change-Id: I411ff51c5de2ad65c3c276d363d2fd3ed1ba35a7 Issue-ID: DOC-148 Signed-off-by: Rich Bennett <rb2745@att.com>