opnfvdocs.git
7 years agoAdd Index page for Feature Projects 07/26607/4
ShubhamRathi [Fri, 30 Dec 2016 14:06:08 +0000 (19:36 +0530)]
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>
7 years agoAdd index page for subrelease projects 05/26605/4
ShubhamRathi [Fri, 30 Dec 2016 11:44:46 +0000 (17:14 +0530)]
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>
7 years agoAdd new templates for docs contribution 23/26823/5
ShubhamRathi [Tue, 10 Jan 2017 12:50:30 +0000 (18:20 +0530)]
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>
7 years agoAdd index with submodules 15/26415/5
ShubhamRathi [Thu, 22 Dec 2016 06:47:04 +0000 (12:17 +0530)]
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>
7 years agoAdd conf.py, static files 27/26427/8
ShubhamRathi [Thu, 22 Dec 2016 08:59:26 +0000 (14:29 +0530)]
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>
7 years agoAdd submodules and .gitmodule 91/26091/9
ShubhamRathi [Fri, 16 Dec 2016 09:59:25 +0000 (15:29 +0530)]
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>
7 years agoMerge "Requirement updated to support sphinx_bootstrap_theme"
Sofia Wallin [Tue, 10 Jan 2017 18:20:58 +0000 (18:20 +0000)]
Merge "Requirement updated to support sphinx_bootstrap_theme"

7 years agoRequirement updated to support sphinx_bootstrap_theme 97/26797/2
ShubhamRathi [Mon, 9 Jan 2017 11:57:13 +0000 (17:27 +0530)]
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>
7 years agoFixing a typo 67/26567/2
Gerald Kunzmann [Wed, 28 Dec 2016 15:23:06 +0000 (15:23 +0000)]
Fixing a typo

Change-Id: I6ee6f4133bab226a7a67b6e09a5c4cccd906ed6a
Signed-off-by: Gerald Kunzmann <kunzmann@docomolab-euro.com>
7 years agoFix syntax error 17/25817/1
Yujun Zhang [Tue, 13 Dec 2016 02:02:38 +0000 (10:02 +0800)]
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>
7 years agoExit script with error count 57/23257/4
Yujun Zhang [Tue, 18 Oct 2016 03:49:58 +0000 (11:49 +0800)]
Exit script with error count

related JIRA: DOCS-71
Change-Id: I08501e6193dc555ebbb7b4b69af65e50ef4be5b7
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
8 years agoAdjusted the docs repo structure for D release work 67/24767/2
Sofia Wallin [Wed, 23 Nov 2016 13:49:15 +0000 (14:49 +0100)]
Adjusted the docs repo structure for D release work

Change-Id: I9befe06c424c726e17d754bc480413b2430549ba
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agoNew file for the readthedocs rendered. 59/24759/1
ChristopherPrice [Wed, 23 Nov 2016 12:51:37 +0000 (13:51 +0100)]
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>
8 years agoMerge "Add figure for Testing Ecosystem"
Sofia Wallin [Tue, 15 Nov 2016 15:01:50 +0000 (15:01 +0000)]
Merge "Add figure for Testing Ecosystem"

8 years agoMerge "Add support for macOS"
Ryota Mibu [Tue, 15 Nov 2016 13:59:24 +0000 (13:59 +0000)]
Merge "Add support for macOS"

8 years agoMerge "Colorado 2.0 updates"
Sofia Wallin [Tue, 8 Nov 2016 10:21:23 +0000 (10:21 +0000)]
Merge "Colorado 2.0 updates"

8 years agoAdd support for macOS 55/23255/3
Yujun Zhang [Tue, 18 Oct 2016 03:43:08 +0000 (11:43 +0800)]
Add support for macOS

JIRA: DOCS-164
Change-Id: I769eb1d0fce7ead1ffb7c0a21e3aab969eeca3af
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
8 years agoColorado 2.0 updates 99/23299/4
Sofia Wallin [Tue, 18 Oct 2016 14:28:59 +0000 (16:28 +0200)]
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>
8 years agoRemoval of Victor Laza from the list of comitters 37/23437/1
Sofia Wallin [Thu, 20 Oct 2016 14:09:11 +0000 (16:09 +0200)]
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>
8 years agoMerge "Updated info file"
Sofia Wallin [Tue, 18 Oct 2016 12:32:07 +0000 (12:32 +0000)]
Merge "Updated info file"

8 years agoUpdated info file 85/23285/1
Sofia Wallin [Tue, 18 Oct 2016 11:30:08 +0000 (13:30 +0200)]
Updated info file

Updated contact info for Wenjing

Change-Id: Id2456fc55765f02317c7c258bb84df07876a507a
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agoLast minute adding LXD scenario docs 85/22385/1
ChristopherPrice [Fri, 23 Sep 2016 13:06:24 +0000 (15:06 +0200)]
Last minute adding LXD scenario docs

Change-Id: I530c2e01b03b49bfde4d4b10b353451c5d56fdbd
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoAdd figure for Testing Ecosystem 37/22337/2
Morgan Richomme [Thu, 22 Sep 2016 10:08:01 +0000 (12:08 +0200)]
Add figure for Testing Ecosystem

Change-Id: I7f71ff607e281e8991821fc9543f787d809d6b19
Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>
8 years agoFinal Colorado 1.0 update for the release documentation library 17/22217/11
ChristopherPrice [Wed, 21 Sep 2016 15:10:00 +0000 (17:10 +0200)]
Final Colorado 1.0 update for the release documentation library

Final version afaict

Change-Id: Ib15662ff3608880efdac84b147b9815d58824610
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoFinal version 65/21465/14
Sofia Wallin [Mon, 19 Sep 2016 15:07:17 +0000 (17:07 +0200)]
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>
8 years agoFinal version of the release document list. 93/21493/3
ChristopherPrice [Mon, 19 Sep 2016 17:32:55 +0000 (19:32 +0200)]
Final version of the release document list.

Updated with all Colorado release links.

Change-Id: Ia02b0add393a1af414d4c28a13e173a35077b134
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoDraft of the overview doc. 83/19783/13
ChristopherPrice [Mon, 29 Aug 2016 16:39:54 +0000 (18:39 +0200)]
Draft of the overview doc.

Change-Id: I13d4230591055c5e8c1f4daa469a6bf71993856e
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoWIP: Created 2 introduction documents for user guide and installation 73/18673/24
Sofia Wallin [Mon, 15 Aug 2016 13:20:50 +0000 (15:20 +0200)]
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>
8 years agoMerge "A compact version of the documentation library."
ChristopherPrice [Thu, 15 Sep 2016 14:04:54 +0000 (14:04 +0000)]
Merge "A compact version of the documentation library."

8 years agoA compact version of the documentation library. 85/20985/12
ChristopherPrice [Tue, 13 Sep 2016 08:18:33 +0000 (10:18 +0200)]
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>
8 years agoRemoving the multipage HTML document and renaming the single page rendering. 05/21105/1
ChristopherPrice [Wed, 14 Sep 2016 09:12:32 +0000 (11:12 +0200)]
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>
8 years agoRemoving excess License info. 89/20289/1
ChristopherPrice [Mon, 5 Sep 2016 05:29:54 +0000 (07:29 +0200)]
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>
8 years agoAdding creative commons license info. 19/20119/3
ChristopherPrice [Thu, 1 Sep 2016 09:30:44 +0000 (11:30 +0200)]
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>
8 years agoMerge "remove pfd/odt creation"
Sofia Wallin [Wed, 24 Aug 2016 11:42:27 +0000 (11:42 +0000)]
Merge "remove pfd/odt creation"

8 years agoMerge "add version, builddate and copyright in sidebar"
Ryota MIBU [Sun, 21 Aug 2016 13:45:18 +0000 (13:45 +0000)]
Merge "add version, builddate and copyright in sidebar"

8 years agoCreated a template for feature configuration 67/18967/4
Sofia Wallin [Thu, 18 Aug 2016 13:37:10 +0000 (15:37 +0200)]
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>
8 years agoMerge "Creating a template for feature projects to produce userguide and scenario...
ChristopherPrice [Fri, 12 Aug 2016 12:02:08 +0000 (12:02 +0000)]
Merge "Creating a template for feature projects to produce userguide and scenario description documents"

8 years agoCreating a template for feature projects to produce userguide and scenario descriptio... 11/18311/3
ChristopherPrice [Wed, 10 Aug 2016 09:21:29 +0000 (11:21 +0200)]
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>
8 years agoadd version, builddate and copyright in sidebar 61/18661/1
Ryota MIBU [Thu, 11 Aug 2016 11:12:11 +0000 (20:12 +0900)]
add version, builddate and copyright in sidebar

Change-Id: I652de718ebc1084230499eb7bc19e2fd9ab90159
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agofix workaround for doc8 error 97/18497/4
Ryota MIBU [Wed, 10 Aug 2016 20:38:25 +0000 (05:38 +0900)]
fix workaround for doc8 error

Change-Id: I7c31f042f5fb02d1294e4a72aef872f153c55755
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoMerge "remove 'Save to PDF' link from normal HTML pages"
Ryota MIBU [Fri, 12 Aug 2016 04:20:51 +0000 (04:20 +0000)]
Merge "remove 'Save to PDF' link from normal HTML pages"

8 years agoworkaround for doc8 error in python2.6 57/18457/2
Ryota MIBU [Wed, 10 Aug 2016 18:48:24 +0000 (03:48 +0900)]
workaround for doc8 error in python2.6

Change-Id: I9b8967e564b522354f6fdcea51fe493c9682d36f
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoremove 'Save to PDF' link from normal HTML pages 47/18447/1
Ryota MIBU [Wed, 10 Aug 2016 18:10:50 +0000 (03:10 +0900)]
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>
8 years agoremove pfd/odt creation 91/18291/2
Ryota MIBU [Wed, 10 Aug 2016 06:54:36 +0000 (15:54 +0900)]
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>
8 years agoadd 'Save to PDF' link in sidebar 31/18431/1
Ryota MIBU [Wed, 10 Aug 2016 16:33:32 +0000 (01:33 +0900)]
add 'Save to PDF' link in sidebar

Change-Id: Ia9ffd10aa73c9e39203f31a5a19329006b68a444
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agouse doc8 in virtualenv 93/18293/1
Ryota MIBU [Wed, 10 Aug 2016 07:23:00 +0000 (16:23 +0900)]
use doc8 in virtualenv

Change-Id: I58fd9e9382932ebc2521765bb665dcf0473d6a68
JIRA: DOCS-152
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoadd creation of singlehtml for downloadable docs 89/18289/2
Ryota MIBU [Wed, 10 Aug 2016 06:48:19 +0000 (15:48 +0900)]
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>
8 years agoMerge "Updating the scenario installation template based on comments."
ChristopherPrice [Wed, 27 Jul 2016 11:46:53 +0000 (11:46 +0000)]
Merge "Updating the scenario installation template based on comments."

8 years agoUpdating the scenario installation template based on comments. 49/17549/1
ChristopherPrice [Tue, 26 Jul 2016 10:05:00 +0000 (12:05 +0200)]
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>
8 years agoremove build-composite.sh 89/17489/1
Ryota MIBU [Mon, 25 Jul 2016 05:09:33 +0000 (14:09 +0900)]
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>
8 years agofix pre-hook 69/17469/2
Ryota MIBU [Mon, 25 Jul 2016 01:59:18 +0000 (10:59 +0900)]
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>
8 years agosupport pre-hook in docs-build.sh 27/17227/3
Ryota MIBU [Wed, 20 Jul 2016 13:04:43 +0000 (22:04 +0900)]
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>
8 years agoimprove config 13/17213/4
Ryota MIBU [Wed, 20 Jul 2016 10:30:05 +0000 (19:30 +0900)]
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>
8 years agoModified the templates for the C release 33/16833/3
Sofia Wallin [Tue, 12 Jul 2016 14:22:17 +0000 (16:22 +0200)]
Modified the templates for the C release

We are getting there....

Change-Id: I8cdf4b2a642a653b0eaa48acf8a7e46bf4a2f98d
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agoCreating a template scenario installation file for Colorado. 37/16837/2
ChristopherPrice [Wed, 13 Jul 2016 12:43:32 +0000 (14:43 +0200)]
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>
8 years agofix bug in build-composite.sh 23/17223/1
Ryota MIBU [Wed, 20 Jul 2016 12:11:05 +0000 (21:11 +0900)]
fix bug in build-composite.sh

Change-Id: I9dd5ac9037c7a473e5ae2229481a9bb7811b3101
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoMerge "Updated according to Chris comment Minor updates to the structure"
Sofia Wallin [Mon, 11 Jul 2016 13:13:15 +0000 (13:13 +0000)]
Merge "Updated according to Chris comment Minor updates to the structure"

8 years agoUpdated according to Chris comment 11/16611/2
Sofia Wallin [Fri, 8 Jul 2016 14:19:50 +0000 (16:19 +0200)]
Updated according to Chris comment
Minor updates to the structure

Change-Id: I86a2b286a522dd5e633da6dfd9133da2e7dbc7a4
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agofix to use docs-build.sh in opnfvdocs 83/16583/1
Ryota MIBU [Fri, 8 Jul 2016 07:19:01 +0000 (16:19 +0900)]
fix to use docs-build.sh in opnfvdocs

Change-Id: I2cabab87e3aaf144b2833bfeb54a8516a612d3c2
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agomigrate docs-build.sh from releng repo 15/16515/2
Ryota MIBU [Thu, 7 Jul 2016 07:38:19 +0000 (16:38 +0900)]
migrate docs-build.sh from releng repo

JIRA: DOCS-153

Change-Id: I568192dbb6653eb8fd8518abebf3558dc00dcee8
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoMerge "update howto use docs"
Ryota MIBU [Wed, 6 Jul 2016 13:16:01 +0000 (13:16 +0000)]
Merge "update howto use docs"

8 years agoEstablishing document structures for Colorado. 41/16241/9
ChristopherPrice [Fri, 1 Jul 2016 07:58:27 +0000 (09:58 +0200)]
Establishing document structures for Colorado.

Derived from converging patches 16165, 16047 & 15937 into one patch.

Change-Id: I3c544ba2fa30856a50274bad9342a06eebc39d58
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
Co-Authored-By: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agoupdate howto use docs 59/16159/1
Ryota MIBU [Thu, 30 Jun 2016 08:01:40 +0000 (17:01 +0900)]
update howto use docs

Change-Id: I48b4017c5fb012c7119b0685a71320c518694815
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoWe had been tracking this in the releng repo 77/15477/1
Aric Gardner [Mon, 13 Jun 2016 17:33:51 +0000 (13:33 -0400)]
We had been tracking this in the releng repo

I have removed it from the releng repo
This documentation on how to use the document tool chain
belongs in opnfv-docs

Change-Id: Iad621b394f03511649a1edc21501ca524f0506e4
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
8 years agoAdding additional examples and references to the glossary. 01/14301/2
ChristopherPrice [Wed, 18 May 2016 09:49:02 +0000 (11:49 +0200)]
Adding additional examples and references to the glossary.

Change-Id: I87a7b98891335914de4be2f346b7b932d4da1987
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoAdding a template for the OPNFV common glossary. 99/14299/3
ChristopherPrice [Wed, 18 May 2016 08:02:56 +0000 (10:02 +0200)]
Adding a template for the OPNFV common glossary.

Added the structure and a couple of examples as a starting point for the OPNFV Glossary.

Change-Id: Ic23d784c01d997b2b7d967a54c5d9a4c3e2399c0
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoAdded audit related requirement references 61/11061/6
Ari Pietikainen [Wed, 9 Mar 2016 12:32:57 +0000 (14:32 +0200)]
Added audit related requirement references

Fixing a typo (cp)

Change-Id: Iae41f9e532f72ad0de00c824957d68a513720a18
Signed-off-by: Ari Pietikainen <ari.pietikainen@ericsson.com>
8 years agoAdded Sona's changes on Trusted Compute 95/9995/7
Luke Hinds [Mon, 15 Feb 2016 14:47:39 +0000 (14:47 +0000)]
Added Sona's changes on Trusted Compute

Updated with commented editorials, want to push this.  (cp)
Fixed formatting errors.

Change-Id: Ia2d5849561d4691d278cc67a6bcdfaec1331de3d
Signed-off-by: Luke Hinds <luke.hinds@nokia.com>
8 years agoMerge "add bottlenecks and prediction project for composite doc"
Ryota Mibu [Tue, 12 Apr 2016 01:24:32 +0000 (01:24 +0000)]
Merge "add bottlenecks and prediction project for composite doc"

8 years agoRemoved the folder "Arno" from the docs repo. 43/12143/1
Sofia Wallin [Mon, 11 Apr 2016 12:37:07 +0000 (14:37 +0200)]
Removed the folder "Arno" from the docs repo.

Change-Id: Id87d5f81d0883c3d24a07a4ab5de7be4f094a40b
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agoadd bottlenecks and prediction project for composite doc 29/12129/1
MatthewLi [Mon, 11 Apr 2016 09:11:19 +0000 (05:11 -0400)]
add bottlenecks and prediction project for composite doc

Change-Id: Id13363c135fe0008b9cbbc4d35c264e2e97fa1bd
Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
8 years agoRemoving an unwanted line from the index file. 97/11897/1
ChristopherPrice [Tue, 5 Apr 2016 11:51:06 +0000 (13:51 +0200)]
Removing an unwanted line from the index file.

Change-Id: I2e77de53615c3e7221681f02b8dadcd096b8e343
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoPromoting Sofia Wallin to opnfvdocs PTL. 03/11303/2
ChristopherPrice [Mon, 14 Mar 2016 19:36:27 +0000 (20:36 +0100)]
Promoting Sofia Wallin to opnfvdocs PTL.

Change-Id: I59ff5ecd2f5062383ec0bfdcd7c12f0fc63e5087
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoRemoving Malla as a committer in opnfvdocs after standing down. 09/11009/1
ChristopherPrice [Tue, 8 Mar 2016 13:05:10 +0000 (14:05 +0100)]
Removing Malla as a committer in opnfvdocs after standing down.

Change-Id: I3c28399a3b0ef770042ff2b72b704e3d45e568a5
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoRemoving Ashiq as a committer after he stood down. 91/10991/1
ChristopherPrice [Mon, 7 Mar 2016 11:24:42 +0000 (12:24 +0100)]
Removing Ashiq as a committer after he stood down.

Change-Id: Ib2bd8e3374d036829568f1565ad1820229a6c87e
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoFinal edits. 17/10817/3
ChristopherPrice [Thu, 25 Feb 2016 13:25:12 +0000 (14:25 +0100)]
Final edits.

Change-Id: I3125c7d63dcbd46bc5595269fb15ed3d4454f8b5
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoFinal editorials on release morning. Comment here! 31/10731/6
ChristopherPrice [Thu, 25 Feb 2016 08:51:47 +0000 (09:51 +0100)]
Final editorials on release morning.  Comment here!

Change-Id: Ifbd43732a5282e63d9699dfc08b8e5b072c3b040
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoadd links and aodh service 73/10773/2
Ryota MIBU [Thu, 25 Feb 2016 06:53:34 +0000 (15:53 +0900)]
add links and aodh service

This patch adds links to OPNFV User Guide and OPNFV Config Guide.

This patch also add aodh (alarming service) in OpenStack deployed
list, since it is aviable in apex with keystone configuration.

And, minor fixes.

Change-Id: I463683b547a4277c91e397fb14146eaf96c10153
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoUpdating the overview doc with recent comments. 51/10651/10
ChristopherPrice [Wed, 24 Feb 2016 22:20:43 +0000 (23:20 +0100)]
Updating the overview doc with recent comments.

Change-Id: I181279f9b0a4330bb98a3e0d40ecb2687d976b92
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoReview and finalize platformoverview 95/10495/3
ulik [Tue, 23 Feb 2016 12:35:01 +0000 (13:35 +0100)]
Review and finalize platformoverview

Jira: DOCS-42
Collected all comments.
Many comments done, open points marked in commentary (".. text")
Patchset 2: resolve most of the comments. Don't merge yet.

Change-Id: I3d676a6510ff3c3190110773649265a182b6f762
Signed-off-by: ulik <ulrich.kleber@huawei.com>
8 years agoplease review, updates for release. 87/10487/18
ChristopherPrice [Tue, 23 Feb 2016 11:42:23 +0000 (12:42 +0100)]
please review, updates for release.

Updated scenario matrix for the user guide.
Updated config guide

Change-Id: Ic1e55cacab47521c2428748e00458425c32a11af
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoIncluding additional projects, aligning test content. 61/10461/1
ChristopherPrice [Tue, 23 Feb 2016 10:06:57 +0000 (11:06 +0100)]
Including additional projects, aligning test content.

Change-Id: I0d3569996ca39a3952c248f1fdd8dc8e8c8963be
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoMerge "Next step platformoverview doc"
Ryota Mibu [Wed, 17 Feb 2016 12:49:42 +0000 (12:49 +0000)]
Merge "Next step platformoverview doc"

8 years agoNext step platformoverview doc 13/9813/2
ulik [Thu, 11 Feb 2016 16:02:39 +0000 (17:02 +0100)]
Next step platformoverview doc

Jira: DOCS-42
Added the license
Transformed introduction to more fluent text.
Created new and shorter component intro for ONOS as an example.
Similar intro for other components needs to be done.

Change-Id: Idf8afe4a1255031010dbf00830f845efa96b377f
Signed-off-by: ulik <ulrich.kleber@huawei.com>
8 years agoUser guide updated for automated content inclusion. 89/9789/13
ChristopherPrice [Thu, 11 Feb 2016 12:41:45 +0000 (13:41 +0100)]
User guide updated for automated content inclusion.

Editorial done on heading levels and overall content.
Still a work in progress, but this is a good milestone to push.

Change-Id: I49e0ee4d16ae87cc91bea62959ff7b2a56d5d757
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agocorrect file path in imported rst files 05/10005/9
Ryota MIBU [Mon, 15 Feb 2016 15:11:04 +0000 (00:11 +0900)]
correct file path in imported rst files

Change-Id: I2d3a784dd3fcd41b2ba637cef633a4cf42ebadae
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoRevert "introduce @OPNFVDOCS_PATH@ and @PROJECT_PATH@" 01/10001/1
Ryota MIBU [Mon, 15 Feb 2016 15:05:19 +0000 (00:05 +0900)]
Revert "introduce @OPNFVDOCS_PATH@ and @PROJECT_PATH@"

This reverts commit 00abc9dc015c881138a2790a9757c58bb3d85255.

8 years agointroduce @OPNFVDOCS_PATH@ and @PROJECT_PATH@ 79/9979/1
Ryota MIBU [Mon, 15 Feb 2016 13:09:09 +0000 (22:09 +0900)]
introduce @OPNFVDOCS_PATH@ and @PROJECT_PATH@

Change-Id: Icc3fcf36746e70dc0ec41826aa2e2fc3d86db2f1
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoscript: gather user guides automatically 53/9953/2
Ryota MIBU [Mon, 15 Feb 2016 05:21:00 +0000 (14:21 +0900)]
script: gather user guides automatically

Change-Id: I80d0666c4eca809bba42a5cf03d294c4c05bdf99
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoscript: gather installer config guides automatically 43/9943/1
Ryota MIBU [Mon, 15 Feb 2016 02:58:38 +0000 (11:58 +0900)]
script: gather installer config guides automatically

Change-Id: Ib69f029ec5673e94d16b54df46952c5f17cfd5aa
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoscript: fix auto feature config builder 45/9845/7
Ryota MIBU [Fri, 12 Feb 2016 09:36:22 +0000 (18:36 +0900)]
script: fix auto feature config builder

Change-Id: Ifa7249ceed9f803e3bb7fbe79caa05705e7fd42f
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoWIP: script: gather feature config guides automatically 87/9687/7
Ryota MIBU [Wed, 10 Feb 2016 03:53:08 +0000 (12:53 +0900)]
WIP: script: gather feature config guides automatically

Change-Id: Iedc50c723ee3ec0fa0e07848d633d35c67d5aa94
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoMade some edits to the ONOS documentation 31/9731/2
Ashlee Young [Wed, 10 Feb 2016 15:28:23 +0000 (07:28 -0800)]
Made some edits to the ONOS documentation

Change-Id: I3e9ad207d3421582d0ec70ae36cc5d28ea9889ea
Signed-off-by: Ashlee Young <ashlee@wildernessvoice.com>
8 years agoMerge "Created a templamte for release note."
Sofia Wallin [Wed, 10 Feb 2016 10:23:44 +0000 (10:23 +0000)]
Merge "Created a templamte for release note."

8 years agoCreated a templamte for release note. 03/9703/2
Sofia Wallin [Wed, 10 Feb 2016 09:36:50 +0000 (10:36 +0100)]
Created a templamte for release note.

Change-Id: I67ebce045ffcc26643d44a73dd8924d6fb1ee326
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agouserguide: add new template 45/9545/1
Ryota MIBU [Mon, 8 Feb 2016 16:07:26 +0000 (01:07 +0900)]
userguide: add new template

This patch adds new template 'testusage.rst' and 'featureusage.rst'
in the same manner of configguide. This makes us easier to compile
files into correct places.

Change-Id: I1aaacb07098b068f42b0f7b7cd1f724de617c932
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoconfigguide: make sections relevant by adding sub-level toctree 15/9515/12
Ryota MIBU [Mon, 8 Feb 2016 11:32:33 +0000 (20:32 +0900)]
configguide: make sections relevant by adding sub-level toctree

This patch wrap each import document with 'toctree' directive so that
we can make sure the sections in imported docs won't take any upper
level section.

This patch also fixes the followings:

* path to copper/featureconfig.rst

* path to promise/configguide/images/

Change-Id: I52d4e9cd637af5707af418ef287d57d8c301b85e
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoAdding general component descriptions and information. 79/9379/6
ChristopherPrice [Fri, 5 Feb 2016 11:48:04 +0000 (12:48 +0100)]
Adding general component descriptions and information.

Change-Id: Ie9824ac9c706f730c929a5ca0ed34ee85314719e
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoAdd ipv6 docs entries in feature-config.rst, post-install.rst, userguide.rst and... 99/9299/2
Bin Hu [Thu, 4 Feb 2016 22:11:24 +0000 (14:11 -0800)]
Add ipv6 docs entries in feature-config.rst, post-install.rst, userguide.rst and build-composite.sh

Change-Id: I3783c30d4adfe4ebe913cfeeace3e76d5bb57f38
Signed-off-by: Bin Hu <bh526r@att.com>
8 years agoSmall update for apex and setting some info on component, to be completed. 55/9155/1
ChristopherPrice [Wed, 3 Feb 2016 10:42:45 +0000 (11:42 +0100)]
Small update for apex and setting some info on component, to be completed.

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