summaryrefslogtreecommitdiffstats
path: root/docs/guides
AgeCommit message (Collapse)AuthorFilesLines
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>
2017-11-08Merge "Correct a reference to VID and add modeling"Rich Bennett1-4/+5
2017-11-07Adding architecture document to docs in rst formatChris Donley6-0/+397
This submission is an RST version of the onap architecture whitepaper for the Amsterdam release. It includes the main file plus 5 pngs referenced in the paper. To Do: update ONAP-toplevel.png when I get the revised version from LF. Issue-ID: DOC-151 Change-Id: I24a875589e32b738793ed6bb6bb01271f6123d73 Signed-off-by: Chris Donley <christopher.donley@huawei.com>
2017-11-07Correct a reference to VID and add modelingEric Debeau1-4/+5
Change-Id: Idf592bb6c287131aae7bea03f19c3cb15784e818 ISSUE-ID: DOC-152 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2017-11-06Merge "Create API reference page"Rich Bennett1-0/+42
2017-11-06Remove/hide projects not part of releaseRich Bennett3-7/+291
Remove/hide oom, authz, multivim Editorial improvements to Release Notes and Project Views Correct typo in License comment Issue-ID: DOC-112 Change-Id: If99b3fb304ffac35433cfe4930bdd4db9552d791 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-11-06Create API reference pageEric Debeau1-0/+42
Change-Id: Ia6945fd05a94155f17d2f16dfdb75c1ae8577caf ISSUE-ID: DOC-152 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2017-11-03Multiple editorial improvementsRich Bennett6-8/+31
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-10-27Align references to MSB project repoRich Bennett1-2/+2
Change-Id: I8639a7549729dfa7ee21fb57ea1a5dda75508357 Issue-ID: DOC-144 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-25Remove aai repo references aggregated in commonRich Bennett1-4/+0
Removed references to docs/**/*.rst in: aai/resource, aai/traversal, aai/data-router, aai/search-data-service Change-Id: I591f2ecb7d17b5975b4493f9943bec08e71e3cba Issue-ID: DOC-139 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-24Integrate CLAMP added templatesRich Bennett2-2/+2
Integrate templates into Architeture and Release Notes Remove excluded path auth/aaf.git for master branch Change-Id: I49b7ee43823e27b99a7b20dff7d955e16691d912 Issue-ID: DOC-110 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-20Connect Guides and Release Notes to Project infoRich Bennett2-21/+28
Change-Id: I48abd7f73dabba20f70b79d23a5dbe51362a406a Issue-ID: DOC-109 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-18Update Copyright and Licensing markingsRich Bennett2-71/+75
Add footer reference to CC4 and make Copyright 2017 ONAP Modify how to create documentation guide to describe appending copyrights on update contributions. Update Collections Titles Exclude aaf until source rst files are corrected for the next release. Change-Id: I3ed26910b2bbb7a15c7c2865e40ff1e5545a00ff Issue-ID: DOC-102 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-10Improve templates and add references in guidesRich Bennett2-11/+147
See description of DOC-101 Added multipple conf.py files to test themes and multiple versions Created initial structure for references in developer architecture guide and release notes Change-Id: I7affcd1cb0258bef7cebe357a938080abe419693 Issue-ID: DOC-101 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-09-20Temporarily removing submodule workflow sectionjsseidel2-7/+2
This section needs more work. There are a couple of subtle problems that we need to document regarding keeping the commit hash current to the doc superproject. I will be tracking thoughts in DOC-84. Change-Id: I854dc5bad7ccfacbf0e024f55aa5dfd40f1cbeed Issue-Id: DOC-84 Signed-off-by: jsseidel <spence@research.att.com>
2017-09-20Merge "Updated submodule section with new instructions"Rich Bennett1-0/+20
2017-09-20Updated submodule section with new instructionsjsseidel1-0/+20
After trying the instructions in the submodule section, I discovered there were a couple of steps missing, namely replacing origin with gerrit and telling git-review what the gerrit instances for the submodules are. Change-Id: Ide084200ebcd84d838dabbf352466ec3ca032409 Issue-Id: DOC-84 Signed-off-by: jsseidel <spence@research.att.com>
2017-09-20Improve integration instructionsRich Bennett1-1/+1
Use relative git/gerrit url for submodules Change-Id: I25cd7612b23bba904a2435d396df3716ba047912 Issue-ID: DOC-87 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-09-19Merge "Added section about submodules"Rich Bennett3-1/+104
2017-09-19Added section about submodulesjsseidel3-1/+104
Added section about working with submodules as a doc-team member. The instructions will be tested once this commit is approved and merged (so I can delete the tree and start from scratch). Change-Id: I92edcf534b2b2ebc81167c2e032ed046f69d6716 Issue-Id: DOC-84 Signed-off-by: jsseidel <spence@research.att.com>
2017-09-18Updates to templates based on Webinar FeedbackRich Bennett2-6/+9
Change-Id: Ib01e3642ec89cbb730a28eb1fd7061d25cdd9e9f Issue-ID: DOC-26 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-09-15Fixed indentation problemsjsseidel2-2/+6
Indentation problems were causing build failures. They were the result of not having empty lines between rst directives, like .. bash. Also, there was a malformed line in .gitmodules of the same type. Change-Id: I0cd51bd975ea1016d89053ab48ee0c433f43ae93 Issue-Id: DOC-78 Signed-off-by: jsseidel <jsseidel@fastmail.com>
2017-09-13Enhancement and additions for webinarRich Bennett16-0/+951
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>