Add release notes page

Added new composite document which
shall collate all release notes from
projects.
This document points to release notes of
<project>/docs/release/release-notes/index.rst

Change-Id: I5c545b3f7c91012131a4d5eeb73842432ce0a51a
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
(cherry picked from commit 1aabf0aab713a4b4e08a773b1701d0fbb1c74ece)

Misc Changes

1. Testing on index page points to <project>/docs/testing/user/index
2. Update all artifact links to RTD using labels
3. 'OPNFV Userguide' renamed as 'OPNFV User Guide & Config Guide'

Change-Id: I47837bac86feba0ae6f319b87315d38b4ef3229e
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
(cherry picked from commit 77a324e8f19bb42d08116a895d2c31fac2e608f9)

updated the license header to use the SPDX shorthand

Change-Id: I0f4e81bafbfdfdb6909a283907a5baa497552622
Signed-off-by: Ray Paik <rpaik@linuxfoundation.org>
(cherry picked from commit e025c0337b0483ff608347d43caa1b0414d97be2)

Fixed warnings

Updated structure for test docs

Updates done according to agreement with test projects.

Change-Id: I2f9b5783ef4e42fd26b357e0aad2e187bcf61777
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

Update Templates for Testing

A directory structure of organizing documents
has been maintained in templates/testing without
getting into the details of what these templates
files should contain. Teams could add whatever
documentation they think is necessary while
minimally maintaining the basic structure.

Change-Id: I2ccf1212acf5b71105cf7a0343705dfaaa95de3a
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Update gitmodule file

Added branch = . for ovno, snaps
& moon.

Change-Id: I07ff1693f2e008eb70386a02092b078108aeb9e4
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Fixed trailing markup

Change-Id: I8ce9b278dc3d0d9b376104f753c168ba9a478aa7
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Merge "StorPerf Documentation"

Misc changes

1. Added onvo, snaps, barometer submodules
2. Renamed a few titles

Change-Id: I8b47e68d64a9a16576abbc2891a39b6dacf164ca
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

StorPerf Documentation

Adds link to StorPerf documentation

Change-Id: I7d59478792867e47e7627f203015b9a1d716c404
Signed-off-by: mbeierl <mark.beierl@dell.com>

Fixing wrong directory name in documentation guide

The directory layout diagram in the documentation guide showed a
"developer" directory instead of "development".

Change-Id: Ie056a47ebcca65d5307d35543009bfb9c6d0a335
Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>

Update OPNFVDocs documentation

1. Added note about eliminating conf.py etc
from include-documentation.
2. Eliminated content about enabling toolchain
since its irrelevant after migration to RTD
3. Added steps to validate using doc8
4. Populated index page.

Change-Id: I80c8354fd4da4bca0b8f338c178f0773d834b6ee
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Adjusted titles

Updated according to comments and added the SFC feature configuration as
template under release/configguide.
Adjusted all titles so they are handled through the index file.

Change-Id: Icb0339fb19394940dc969725ddfe0420cb547955
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

Remove moon

Change-Id: I0b780d41eeb11dae12174cd7e63be1019ba327f7
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Remove moon, as they are breaking builds

Change-Id: Icef338564b07e2fd6e7379697c75624a065ad1b4
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>

Merge "Add Promise release docs to opnfvdocs"

Shallow clone to speed things up for RTD

RTD has a ten minute timeout, this might squeek us in

Change-Id: I3d5be51984bd939924b6dfc1d4017bd2a9c1b605
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>

Add Promise release docs to opnfvdocs

Change-Id: Idbc17af03fe7449ef3e20e198f21338880274dc5
Signed-off-by: Gerald Kunzmann <kunzmann@docomolab-euro.com>

barometer: add project submodules

Change-Id: Ie0119fca1cf27731a1f0b9bab824c0133fd55f41
Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>

Merge "Added steps to build documentation"

Added steps to build documentation

Added steps to build composite & discreet
documentation in include-documentation.
Added development in progress label atop index.

Change-Id: I28526f157a09e10faf17307445c4d90a3903be03
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Documentation guide ported from wiki

Edited content to enforce the new changes.
Added label to include-documentation.rst file
which is referenced from the documentation guide.

Change-Id: I6e81288062716231ece5934a0be934ed0dbb60dc
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Merge "New Tox build script"

Merge "New docs for 'How to include documentation'"

Misc Changes

Renamed developer/ to development/ in templates.
Corrected chapter level markup in docs/release/
Moved testing above developement in index

Change-Id: I950f69bf2ac60e97b260ecfbb4b870a42f8a233b
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

New docs for 'How to include documentation'

This documentation elucidates the revised procedure
to include project documentation.

Change-Id: Icfcab3a07e386453ae7faf9fa737fe726ff70f0c
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Merge "Moving design/ requirements/ to developer"

Changing Documentation Theme

Documentation theme changed from 'united' to
'journal'

Change-Id: I89242a324ea3bd827f829b07f43098d91c225eb8
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Moving design/ requirements/ to developer

design/ & requirements/ were erroneously placed
under templates/release earlier. This patch fixes
them to templates/developer.

Change-Id: I1159c2999c63a4dd8f29e893fab9374e3077f59f
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Cleanup old templates and add placeholders where required

Old templates have beem eliminated. Placeholder index file
has been added for design/, release/ & testing/.

Change-Id: I536929924de42c855b6e775a1f2391db4cd04fc1
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

New Tox build script

To keep the doc jobs for OPNFV & ODL as similar as possible, we're
using a similar tox build script as used in ODLDocs.  The new merge
job is tested to run the same tox build script.  This build script
is to be run as `tox -edocs`. Everything under docs/ shall be built.

Change-Id: Ic4fab5e431e6937a1dbbeca2b1ff339dd092b688
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Removing RTD Hack

Eliminated rm -rf * from conf.py file &
time, date of generation from index.

Change-Id: I1c2c3da15a11b59659b9fbb46982bf71d7ec2ba9
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Merge "RTD Workaround to delete old files"

Merge "Adding all templates under templates/"

Merge "Original 'Including your Documentation'"

Original 'Including your Documentation'

Moving all content out of the wiki,
plan is to keep document build instructions
in the opnfvdocs repo too. This file shall be
edited with the new instruction.

Change-Id: Ie2e441be1810182c101bd3819ddc6587e1c6b2c2
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Updated intro and vsperf project description.

Updates:
Fixed review issues with trailing white spaces, Bottlenecks description and made further vsperf description edits.

Change-Id: Id1c979f6365b022f27ab79ac7b75a42110e0150b
Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>

Adding all templates under templates/

Templates for docs contribution have been
added under templates/ .Templates for release/
have been added only. Most of these templates
have been made by resuing the structure and
content of previous releases to reduce rework
on part of project teams.

Change-Id: I13f9b7fbb372bd712ee64aed775a2cede771f429
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

RTD Workaround to delete old files

Workaround to delete old files in RTD: We are callling a subprocess
from conf.py file to rm -rf *.The builds on RTD are failing but
documentation is being updated nonetheless, to check - we are seeing
the build time and date in index.

Change-Id: I278490e322e97e263d90f568fe4331bcc40ff4ad
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Move Scenario under release

Scenario templates moved under Release. Spelling for Integration corrected.

Change-Id: I3016ad8226293f3c806563b747fb14a140afece1
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Update testing community doc

Change-Id: I7ffbb3c0460958e3ecd837a14bf0c9a5752d1fc0
Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>

Adjusted naming path

Adjusted the naming path for consistency throughout our repository and the
community.

Change-Id: Ia055c418584f338f6000835fc28a7e5e8b5c5818
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

Merge "Update build script to newer tag"

Add Index page for Feature Projects

This feature index page lists all feature projects. This is proposed to be added under 'Developer Documentation'

Change-Id: I84f21000923d3b00c93cb8b2b4d00c15711d19e9
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Add index page for subrelease projects

Index page for subrelease projects. This is proposed to be added under 'Release documentation'

Change-Id: I66d9b5977697a1512ee3491921652dbad589bd23
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Add new templates for docs contribution

Adding new templates for docs contribution to be used by the project
teams. Templates for 'Testing/' havent been added yet since its not
perfectly clear what all cases need to be documented.

Change-Id: Id9c1d0d87d99bb071cbcd493817500666cd59b79
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Add index with submodules

Index page updated to point to feature, testing and installer
projects. This is in tandem with the plan to divide documentation in
Release, Developer and Testing.

Change-Id: I7e54190d402a6c241a358c9e13ce477d496f23a3
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Add conf.py, static files

Adding new conf.py & static files that shall be used to render docs.
As part of the move to read the docs, intent is to have a single static
conf.py at the root which shall manage the themeing etc.

Change-Id: I71aedd1268649889e7e8c1e357fd3860f08ae390
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Update build script to newer tag

The build script showed the tag as 'arno.2015.2.0'. The script
has been updated to take the latest tag.

Change-Id: Ifb64128d3c1097ac99130f00313d9eab7e885778
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Add submodules and .gitmodule

Adding submodules of all OPNFV projects in order to create a unified
repository for documentation. By using submodules we will be able to
maintain a single conf.py file and theme to be used across all projects

Change-Id: I65ec1a85f074f142bc335e8611e9636b5e4cb3a9
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Merge "Requirement updated to support sphinx_bootstrap_theme"

Requirement updated to support sphinx_bootstrap_theme

Builds for the new conf.py's importing sphinx_bootstrap_theme (SBT) were failing because jenkins was still loading the previous version of requirements which did not have SBT. Adding the SBT to requirements will ensure the build does not fail.

Change-Id: I9a46f519f5d5548e3a304a7d55d99e80a4366460
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>

Fixing a typo

Change-Id: I6ee6f4133bab226a7a67b6e09a5c4cccd906ed6a
Signed-off-by: Gerald Kunzmann <kunzmann@docomolab-euro.com>

Fix syntax error

Reported in https://gerrit.opnfv.org/gerrit/#/c/25785/

Change-Id: Iaba37b820ec17d8ac9009e63f606c8a38aebd236
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>

Exit script with error count

related JIRA: DOCS-71
Change-Id: I08501e6193dc555ebbb7b4b69af65e50ef4be5b7
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>

Adjusted the docs repo structure for D release work

Change-Id: I9befe06c424c726e17d754bc480413b2430549ba
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

New file for the readthedocs rendered.
This is a placeholder to test the toolchain.

Change-Id: Ib3eb61632e812369e6da6706a7ff8fe20a43c547
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

Merge "Add figure for Testing Ecosystem"

Merge "Add support for macOS"

Merge "Colorado 2.0 updates"

Add support for macOS

JIRA: DOCS-164
Change-Id: I769eb1d0fce7ead1ffb7c0a21e3aab969eeca3af
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>

Colorado 2.0 updates

Updated according to comments
All links updated for colorado 2.0
Link fixed in the overview doc according to Jira ticket DOCS-161

Change-Id: Ib3ff5f1159c45c6dc45601360e4e31a5210a15ec
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

Removal of Victor Laza from the list of comitters

Removing Victor from the list of committers due to no activity.
I have reached out several times without response.

Change-Id: Ib86d3e8dfd44751fe7d0d9c4a4d71acd0eca6b8b
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

Merge "Updated info file"

Updated info file

Updated contact info for Wenjing

Change-Id: Id2456fc55765f02317c7c258bb84df07876a507a
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

Last minute adding LXD scenario docs

Change-Id: I530c2e01b03b49bfde4d4b10b353451c5d56fdbd
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

Add figure for Testing Ecosystem

Change-Id: I7f71ff607e281e8991821fc9543f787d809d6b19
Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>

Final Colorado 1.0 update for the release documentation library

Final version afaict

Change-Id: Ib15662ff3608880efdac84b147b9815d58824610
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

Final version

Fixed trailing whitespaces

Added StorPerf, this should prob the last link to add.
Adding more document links.
Added security notes
Added numbering to the user guide
Adding the feature configuration parts to the user guide.

Change-Id: I2b1569c97507be18bd0ec17fab41eeb2554726e5
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

Final version of the release document list.

Updated with all Colorado release links.

Change-Id: Ia02b0add393a1af414d4c28a13e173a35077b134
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

Draft of the overview doc.

Change-Id: I13d4230591055c5e8c1f4daa469a6bf71993856e
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

WIP: Created 2 introduction documents for user guide and installation

Work on the contant in both installation and user guide

Started to add artifacts in the installation instruction  and user guide

This is a first draft of the installation.introduction.rst and userguide.introduction.rst.
Some of the information has been reused from the Brahmaputra docs with  modifications.
Please comment and add as needed/wanted.

Change-Id: I0c6d79aac7d1152ec894986dda251ad2d3c7048e
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

Merge "A compact version of the documentation library."

A compact version of the documentation library.

This document provides a master branch link to all Colorado related documentation.
The patch to Stable will update all release links to /colorado/docs/ but for the
time being this document should remaina accurate on master.

Change-Id: I47feb62980311f6f76ddc44ef6e46a0999690a8f
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

Removing the multipage HTML document and renaming the single page rendering.

This should be the final version for Colorado.
We need to ensure people stop using the "-single" url's prior to release.

Change-Id: Ib84c82582339f0de948d7b074d156343c566d535
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

Removing excess License info.

Removed License info from the sidebar, on review it is not necessary.

Change-Id: I12c7a4d4c6ec7498462e99e953867ba64630858b
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

Adding creative commons license info.

Cannot build a reference until it's merged I guess, Ryota can you make sure this is not broken?

Change-Id: Ibc7d98287cb513b894ae79f53864f654959de39a
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

Merge "remove pfd/odt creation"

Merge "add version, builddate and copyright in sidebar"

Created a template for feature configuration

Updated according to comments.
Any more information or steps neeeded please add.

Change-Id: Ibd3685252f7ae0fe236f36ee640b3424f0761fb5
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

Merge "Creating a template for feature projects to produce userguide and scenario description documents"

Creating a template for feature projects to produce userguide and scenario description documents

This template will be pushed to features projects in Colorado to help them create the right
documentation for the Colorado release.  The documentation will be feature and scenario specific
at a level where that makes sense while allowing common activities like instalation to be
handled in documents for the installation tools.

Change-Id: I649c583233ab8d8f8c3ebf7ddf8ae539dae15c8a
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

add version, builddate and copyright in sidebar

Change-Id: I652de718ebc1084230499eb7bc19e2fd9ab90159
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

fix workaround for doc8 error

Change-Id: I7c31f042f5fb02d1294e4a72aef872f153c55755
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

Merge "remove 'Save to PDF' link from normal HTML pages"

workaround for doc8 error in python2.6

Change-Id: I9b8967e564b522354f6fdcea51fe493c9682d36f
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

remove 'Save to PDF' link from normal HTML pages

'Save to PDF' should be appeared in single HTML pages.

JIRA: DOCS-156

Change-Id: I4566a976a8590a521bff4d0038597421f367f8e3
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

remove pfd/odt creation

This patch also adds description of html_sidebars in how-to doc.

Change-Id: I904ceca3847a085754aacc8d0d0a388f2606c880
JIRA: DOCS-156
Co-Authored-By: Aric Gardner <agardner@linuxfoundation.org>
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

add 'Save to PDF' link in sidebar

Change-Id: Ia9ffd10aa73c9e39203f31a5a19329006b68a444
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

use doc8 in virtualenv

Change-Id: I58fd9e9382932ebc2521765bb665dcf0473d6a68
JIRA: DOCS-152
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

add creation of singlehtml for downloadable docs

Change-Id: I4e7b188f43d69866fa5f42b4393e92f91cd795a2
JIRA: DOCS-156
Co-Authored-By: Aric Gardner <agardner@linuxfoundation.org>
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

Merge "Updating the scenario installation template based on comments."

Updating the scenario installation template based on comments.

Commets from https://gerrit.opnfv.org/gerrit/#/c/16837 adressed.

Change-Id: I83a58c5ec6088805a8670bc7801351d33c6e5fa8
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

remove build-composite.sh

The contents in build-composite.sh were already moved to docs/pre-hook.sh .

After jjb was updated to use scripts/docs-build.sh instead of
build-composite.sh , we can remove it.

Change-Id: Icbffed34a281a9119dca57d26a003fd2f0791731
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

fix pre-hook

- execute pre-hook after required python package installed

- remove execution flag of docs/pre-hook.sh as it's unnecessary

- add howto document regarding 'Hooks'

Change-Id: Ib94888b018347ce8660d53db93dba3586c098948
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

support pre-hook in docs-build.sh

Some projects need special pre steps before executing docs-build.sh .
For instance, opnfvdocs needs to download other repos which will be
composited. Also, apidoc creation is needed during docs build in
yardstick.

In order to support such cases, this patch introduces pre-hook in
docs-build.sh that provides much flexibility to projects and
simplifies job definition in releng.

Change-Id: If9f26c490671ec0788dc48dd4fccb4513d0ca777
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

improve config

A developer was asked to copy all contents in the base config file in
order to set all parameters properly, even if the change is partial.

This patch improves this config by setting all default parameters based
on users' custom config file, so that they can write parameters just
which they want to change.

Change-Id: Ide459c8e9f416b29b114a4bf2a432e8eae1f841e
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

Modified the templates for the C release

We are getting there....

Change-Id: I8cdf4b2a642a653b0eaa48acf8a7e46bf4a2f98d
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>

Creating a template scenario installation file for Colorado.

Aside from my likely copywright infringements, please review/comment.
The basic idea is we create a "master" versions for each colorado installer then each scenario
derives from the master files to produce their own.  The template is intentionally modular for
that purpose.

Change-Id: Ic5ca72ece8eb462e6e6e7307d3cde32ea7760b23
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

fix bug in build-composite.sh

Change-Id: I9dd5ac9037c7a473e5ae2229481a9bb7811b3101
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>