summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs
AgeCommit message (Collapse)AuthorFilesLines
2022-08-04update and rearrange documentation related contentthmsdt28-2770/+0
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Id454ec5f09903efb81123669e6eb024f21a08797
2022-07-07format conf.py; fix link in setup guide; fix releasereposthmsdt1-1/+1
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I12ee49b841065a930b68f68e596f4778ba50c93f
2022-07-05Fix LFN EasyCLA dead linksCédric Ollivier1-4/+2
It replaces the EasyCLA links used in ONAP doc which were removed. Backports must be considered as linkcheck ignore has hidden this issues for a while. Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: Iaff4da0e555bfaaadc5d97ef1bad0024af8f6415
2022-06-27add missing sections to conf.pythmsdt1-1/+1
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I2fdc0ae919f8a14d650f2cd9a745dcdf805e5d6a
2022-05-18[DOC] Add instruction for ssh key generationqingshuting1-3/+19
OpenSSH 8.8+ disables the support for RSA/SHA1. For developers in this scenario uses "ssh-keygen -t rsa" command, the ssh key can be generated successfully. But it will come back" Permission Denied (Public Key)" when they try to pull/push code through ssh method. Few solutions in google will tell it could be the OpenSSH reason which may cause some time for trouble shooting. So instruction is added here. Change-Id: Iaababa9e25e87604b1bc6464f65156ec6e6b2d31 Signed-off-by: qingshuting <qingshuting1@huawei.com> Issue-ID: DOC-790
2021-09-24Corrected duplicated templates chapterAndrea Visnyei3-28/+3
Issue-ID: DOC-743 Change-Id: I2a62c9cf89ed88162d9bdaaad18aed1bdbe5bc54 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2021-07-29fix broken link in setting-up-environment.rstthmsdt1-1/+1
Issue-ID: DOC-755 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ib8f86ff1bbce589a45d45573106cfe47656c8376
2021-06-11Updated updates and reviews chapterAndrea Visnyei1-102/+34
Removed outdated information about submodules, added new content Change-Id: Ie96da4f3f430a2eee940e8df6cac7681a22f6fb6 Issue-ID: DOC-743 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2021-05-06Merge "Template updates - sections"Andreas Geissler14-107/+309
2021-05-06Template updates - sectionsAndrea Visnyei14-107/+309
Instructions and examples added, notes commented out, review comments implemented Add example.com in the linkcheck_ignore Issue-ID: DOC-696 Change-Id: I8221ba6f2adce534ced7d8c06fbc7f23eef39efe Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2021-04-30Move examples from Addendum to Setting Up chapterAndrea Visnyei4-159/+153
Moved RST file examples and Jenkins info to Setting up chapter and RTD URLs to Introduction. Issue-ID: DOC-719 Change-Id: I3e8ac614985858f2e3999a325e7575d66c8a7f84 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-12-07Remove remaining warnings during Documentation buildingsEric Debeau3-131/+76
correct files to remove warnings Remove orphan links Correct bad links Issue-ID: DOC-692 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Iac1fea50a4edaf6ef38b97a1b5d689fab0206a15
2020-11-30Remove all warnings during Documentation buildingsEric Debeau16-0/+439
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-11-30Merge "Correct broken links"Sofia Wallin1-51/+51
2020-11-27Moving style-guide after setting upAndrea Visnyei2-3/+3
Changed order of Style-guide chapter and setting up chapter. Editorial change in style-guide: ONAP terms changed to ONAP terminology. Issue-ID: DOC-669 Change-Id: I12203b8e7736d70d503d32c8e1562ae89aaf336a Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-11-26Correct broken linksEric Debeau1-51/+51
Correct broken links detected by sphinx linkcheck Correct Doc8 warnings Add License headers Issue-ID: DOC-690 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I89b4b76206f7c4c6ba580fc9191ea838b43e13eb
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-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-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-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-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-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-04-13Fix links to new intersphinx format.Aric Gardner2-2/+2
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
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>