summaryrefslogtreecommitdiffstats
path: root/docs/templates
AgeCommit message (Collapse)AuthorFilesLines
2019-06-01Improve security section of release notesKrzysztof Opasiak1-14/+24
In order to provide users with more details on project's state in terms of security let's divide the security release notes into three sections: - Fixed Security Issues Contains a list of security fixes merged during this release (especially those reported via OJSI tickets). - Known Security Issues Contains a list of vulnerabilities detected in project during release which have not been fixed yet and thus should be mitigated by the user. - Known Vulnerabilities in Used Modules Contains information about NexusIQ scan results Issue-ID: SECCOM-238 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I8bbac2b7e7126369e30da218b69cdc3744d3c0c5
2018-04-04Provide structure for VNFsRich Bennett1-0/+29
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>
2017-11-09Restore MultiVIM project & remove apiexamplesRich Bennett6-1487/+0
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-10-27Merge "Align references to MSB project repo"Gregory Glover1-0/+2
2017-10-27Align references to MSB project repoRich Bennett1-0/+2
Change-Id: I8639a7549729dfa7ee21fb57ea1a5dda75508357 Issue-ID: DOC-144 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-26Remove http domain directiveRich Bennett2-11/+0
Only used as an example of API documentation Remove to allowing parallel reads during verify and build Change-Id: Ib0549d12d80f986dba41c70706478c1fddfd9ef3 Issue-ID: DOC-142 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-20Connect Guides and Release Notes to Project infoRich Bennett1-1/+1
Change-Id: I48abd7f73dabba20f70b79d23a5dbe51362a406a Issue-ID: DOC-109 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-18Update Copyright and Licensing markingsRich Bennett2-4/+4
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-18Fix basic tox warningsMorgan Richomme1-427/+332
lots of warnings in file docs/templates/sections/apiexample/dcaecdap.rst Mainly formating issues in tables JIRA: DOC-107 Change-Id: I75782ab4b537babab1712ca762bb4631cd7f8a6b Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>
2017-10-16Improve Release Notes and Template referencesRich Bennett2-0/+0
Change-Id: Id5893bd319e047eba4fe0402d87c7ab368e1bced Issue-ID: DOC-106 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-16Sync logging-analytics update release note listRich Bennett1-0/+2
Sync logging-analytis submodule reference Add Repo names of release notes list Configuration changes to evaluate theme and footnote options Change-Id: Ib65612908b1739d138f16387d866dbfcc583cdbb Issue-ID: DOC-41 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-10Improve templates and add references in guidesRich Bennett44-279/+1925
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-18Updates to templates based on Webinar FeedbackRich Bennett9-24/+23
Change-Id: Ib01e3642ec89cbb730a28eb1fd7061d25cdd9e9f Issue-ID: DOC-26 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-09-18Remove linkcheck and add API examplesRich Bennett1-3/+20
Part 1 of moviing linkcheck from verify to a CSIT job Added API examples and extensions used to document APIs Change-Id: I5dd536c50930b09bb129e95a9767c97f09c0604b Issue-ID: DOC-82 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-09-13Enhancement and additions for webinarRich Bennett26-104/+260
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>
2017-08-24Update How To Guide & Git submodulesRich Bennett1-0/+25
vnfrqts/requirements master advanced beyond submodule reference in doc before verify job available updated git reference to current level Improvements in the how to guide describing submodule integration Updated sphinx configuration to support sequence diagrams Temporary exclusion filter reduced for seed documents with severe errors Issue-Id: VNFRQTS-76 Change-Id: I3928a3d1e55a0731125e07186d8041b1614c3c8d Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-16Updates to How to GuideRich Bennett2-2/+16
Improve How to Use Documentation Guide including display existing templates, consistency with the approved Jenkins job templates, and other editorial improvements Change-Id: I6a173a656acee2d675cb4af4c3070ab9ab9eb893 Issue-Id: DOC-59 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-07[DOC-24] Add Component Template, Sphinx 1.6.3Rich Bennett5-38/+68
Change-Id: Ib810ef3354ff17da35c57f563ecd8e15e9250fa3 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-07-19[DOC-23]Initial structure and Documentation GuideRich Bennett2-0/+38
Change-Id: Ie0fdb7be60acd79b878c2d9b985aaaf6aca035d2 Signed-off-by: Rich Bennett <rb2745@att.com>