summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/index.rst
AgeCommit message (Collapse)AuthorFilesLines
2021-09-24Corrected duplicated templates chapterAndrea Visnyei1-1/+0
Issue-ID: DOC-743 Change-Id: I2a62c9cf89ed88162d9bdaaad18aed1bdbe5bc54 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2021-04-30Move examples from Addendum to Setting Up chapterAndrea Visnyei1-1/+0
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-11-30Remove all warnings during Documentation buildingsEric Debeau1-0/+1
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-27Moving style-guide after setting upAndrea Visnyei1-1/+1
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-10-22Updating templates section setting up chapterAndrea Visnyei1-2/+2
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-01Adding environment setup chapterAndrea Visnyei1-1/+2
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-09-18Renaming files in documentation guideAndrea Visnyei1-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>
2019-04-10API documentation guideEric Debeau1-0/+1
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>
2018-05-31Updates to How To Create DocumentationRich Bennett1-2/+2
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>
2017-11-17Improve References to User GuidesRich Bennett1-0/+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-09-20Temporarily removing submodule workflow sectionjsseidel1-1/+0
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-19Added section about submodulesjsseidel1-1/+2
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-13Enhancement and additions for webinarRich Bennett1-0/+14
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>