summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs
AgeCommit message (Collapse)AuthorFilesLines
2019-07-12Merge "Add information on tox usage"Eric Debeau1-3/+2
2019-07-12Merge "Document temporary character of references in repolist.rst"Eric Debeau1-1/+4
2019-07-11Add information on tox usagePawel Wieczorek1-3/+2
This patch also adds link to Python Package Index (like for doc8 package) and removes no longer necessary directory change. Issue-ID: DOC-502 Change-Id: Ibfeda01256babebd3e5224fe766c740bc738e2e8 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-07-11Add information on virtualenv usagePawel Wieczorek1-4/+14
This patch also adds link to Python Package Index (like for doc8 package), drops no longer necessary privilege elevation and fixes minor spacing issues. Issue-ID: DOC-502 Change-Id: I55a583bf05a731371008d9cfb55cbfa2e2ad3a77 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-07-09Document temporary character of references in repolist.rstKrzysztof Opasiak1-1/+4
According to the comment in repolist.rst references there are only temporary and should be removed when the project is referenced from more appropriate place. Unfortunately developer may never notice this comment as writting to this file in documentation is done by echo command. To improve this situation let's add an explicit mention about this temporary character of repolist.rst to the documentation. Issue-ID: DOC-501 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I8d8b5fe03d29b5141d57e1d06220bd6382a52861
2019-07-01Issue-ID: DOC-493Rene_Robert1-8/+16
correcting procedure to test documentation change before submitting the change replacing mv command by cp command mainly Signed-off-by: Rene_Robert <rene.robert@orange.com> Change-Id: I546a1beb82a23e51cdbb6e4f38e77bad2da3e6d7
2019-05-29Add caution to not modify ../ in git commandKrzysztof Opasiak1-1/+6
Using incorrect repository location is hard to catch during review and merging it causes all jenkins verify job to fail. Thus let's add a warning to the documentation to warn potential users and avoid such incidents. Issue-ID: SECCOM-239 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I6b00a5bc6f34d33f2576c802eccf541069499d84
2019-05-13Correction to documentation guide for APIEric Debeau1-3/+8
Add note when swaggerv2doc directive is not working Issue-ID: DOC-426 Change-Id: I19871c820f721016625ee7979632d2e2dfea80bb Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2019-04-18Correction to documentation guide for APIEric Debeau1-6/+18
Add some notes to explain JSON file location and generation Issue-ID: DOC-426 Change-Id: Ifb617308b9548f892343b72fb7d885d17973d058 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2019-04-10API documentation guideEric Debeau4-0/+147
Guide how to use Swagger and swaggerv2dcc directive Add 2 JSON Swagger files Add code block Change-Id: If3af3f20509db2cc47bdb2cf3db9b44d8a1bcdc7 Issue-ID: DOC-426 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2019-03-08Advance submodule referencesRich Bennett1-2/+4
Advance submodule references of recently added repos Remove conf2.py no longer used. Clarify what tox -elocal does with submodules Add branch and ignore properties for recently added repos Change-Id: I9f40fea10ae515d72766c9c6e0e5771ad12ccc27 Issue-ID: DOC-414 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-11-27Add Pomba submoduleRich Bennett2-20/+10
Add logging-analytics/pomba/pomba-audit-common as submodule Updates to documentation guide Issue-ID: DOC-323 Change-Id: Ied9363be20c39a893680b07bef964112361c9682 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-07-12Add support for sphinx NEEDS DirectiveRich Bennett1-0/+24
Add configuration, pip requirements, and conventiions for use Change-Id: Ia065b7f72fc5aa16b4010b0100dc70e2f0a42b8c Issue-ID: DOC-285 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-05-31Updates to How To Create DocumentationRich Bennett6-209/+354
Integrating with doc project named release branch Code review of verify job console and html build How to use Read Docs URLs Doc8, formating, and reference link corrections Change-Id: If8ba97632045ec9542fd4bf1b2213a1bac5fd61d Issue-ID: DOC-270 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-04-26Add tox environment for spellcheckRich Bennett1-2/+16
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-18Add platform operations to user guidesRich Bennett1-0/+6
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>
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-17Improve References to User GuidesRich Bennett3-4/+5
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-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-10-24Integrate CLAMP added templatesRich Bennett1-1/+1
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-18Update Copyright and Licensing markingsRich Bennett1-1/+5
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 Bennett1-7/+36
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 Bennett1-6/+6
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 Bennett6-0/+854
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>