opnfvdocs.git
7 years agoMisc Changes 49/31349/1
ShubhamRathi [Wed, 15 Mar 2017 19:37:13 +0000 (01:07 +0530)]
Misc Changes

1. Renamed ‘How to work with Documentation’ to Documentation Guide
2. Add Test Overview documentation breneath ‘Testing’
3. Removed the index off Release Notes

Change-Id: Iaef364f5ee59a99f906270271c1daf49cfae4c4f
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
(cherry picked from commit 7cc71e8d705f20d4a36f9bcd9e022e439cf31197)

7 years agoFix for opera submodule 43/31343/1
Aric Gardner [Fri, 17 Mar 2017 20:15:20 +0000 (16:15 -0400)]
Fix for opera submodule

Change-Id: I929e35358fdc609c239bf77077defda4df7c52c8
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
(cherry picked from commit a4e3f3d28a133d83ade8ade7774e3477cdf9fd4d)

7 years agoAdding opera submodule 41/31341/1
Aric Gardner [Fri, 17 Mar 2017 19:44:28 +0000 (15:44 -0400)]
Adding opera submodule

This will fix build: https://gerrit.opnfv.org/gerrit/#/c/29335/5

Change-Id: Ib2e214374ab071a11a46588b83113b43468ebdb1
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
(cherry picked from commit 7d76bf377d21d4f3d9946078482e23e87f707cca)

7 years agoRemove nonparticipating projects 77/31177/2
ShubhamRathi [Mon, 20 Mar 2017 21:01:02 +0000 (02:31 +0530)]
Remove nonparticipating projects

Removed projects not part of Danube to
save build time.

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

7 years agoMerge "CSS Changes to layout" into stable/danube
Sofia Wallin [Tue, 21 Mar 2017 11:37:42 +0000 (11:37 +0000)]
Merge "CSS Changes to layout" into stable/danube

7 years agoRemoved openretriever off submodules 81/31181/1
ShubhamRathi [Mon, 20 Mar 2017 19:22:02 +0000 (00:52 +0530)]
Removed openretriever off submodules

Change-Id: Iea4f3f579e837bc4ff199a65b717be28113de2ef
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
(cherry picked from commit 86879954e4c2636c5cf71d3539a1b2a356e66b68)

7 years agoCSS Changes to layout 63/31163/3
ShubhamRathi [Wed, 15 Mar 2017 21:18:37 +0000 (02:48 +0530)]
CSS Changes to layout

1. Logo has been scaled up
2. Font has been defaulted to 'Arial'

Change-Id: I7d729009649ba59394f5a78c6909b6af21bae0ab
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
(cherry picked from commit 6e4ba246bfa93f285cabd242d392dccfbaee03ce)

7 years agoUpdate submodules 73/31073/1
ShubhamRathi [Wed, 15 Mar 2017 19:15:39 +0000 (00:45 +0530)]
Update submodules

Update HEAD of Barometer & Multisite
so that gerrit auto syncs the submod-
ules

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

7 years agoUpdating submodules & add openretriever 71/31071/1
ShubhamRathi [Wed, 15 Mar 2017 15:58:18 +0000 (21:28 +0530)]
Updating submodules & add openretriever

1. HEAD seems to be out of sync for the submodules
This patch fixes the HEAD so that henceforth
gerrit automatically updates the refs to latest
commit ID.

2. Adding openretriever to list of submodules

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

7 years agoUsing SPDX shorthand plus a several edits for wordsmithing 69/31069/1
Ray Paik [Tue, 14 Mar 2017 17:11:02 +0000 (10:11 -0700)]
Using SPDX shorthand plus a several edits for wordsmithing

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

7 years agoAdd Sidebar 67/31067/1
ShubhamRathi [Mon, 13 Mar 2017 18:24:03 +0000 (23:54 +0530)]
Add Sidebar

Change-Id: I1425eda919f49cbc82d1ab60ef91324d9afee041
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
(cherry picked from commit 43b90b762d5df17fac7395a709b5262b51c04375)

7 years agoUpdated license header with SPDX 65/31065/1
Sofia Wallin [Tue, 14 Mar 2017 12:27:54 +0000 (13:27 +0100)]
Updated license header with SPDX

Change-Id: I7fa081f2e3c01f053388ae8f85983abb007ab7f7
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
(cherry picked from commit 330aafa18db7133b1e3c08f80c874b0136b1cb4c)

7 years agoAdd release notes page 63/31063/1
ShubhamRathi [Sun, 5 Mar 2017 16:42:22 +0000 (22:12 +0530)]
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)

7 years agoMisc Changes 57/31057/1
ShubhamRathi [Sat, 4 Mar 2017 22:10:13 +0000 (03:40 +0530)]
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)

7 years agoupdated the license header to use the SPDX shorthand 33/30733/1
Ray Paik [Mon, 6 Mar 2017 21:52:21 +0000 (13:52 -0800)]
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)

7 years agoFixed warnings 73/30073/3
Sofia Wallin [Wed, 8 Mar 2017 16:25:08 +0000 (17:25 +0100)]
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>
7 years agoUpdate Templates for Testing 89/29789/1
ShubhamRathi [Sat, 4 Mar 2017 21:29:02 +0000 (02:59 +0530)]
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>
7 years agoUpdate gitmodule file 73/29573/2
ShubhamRathi [Wed, 1 Mar 2017 17:53:40 +0000 (23:23 +0530)]
Update gitmodule file

Added branch = . for ovno, snaps
& moon.

Change-Id: I07ff1693f2e008eb70386a02092b078108aeb9e4
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
7 years agoFixed trailing markup 61/29661/1
ShubhamRathi [Thu, 2 Mar 2017 17:11:41 +0000 (22:41 +0530)]
Fixed trailing markup

Change-Id: I8ce9b278dc3d0d9b376104f753c168ba9a478aa7
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
7 years agoMerge "StorPerf Documentation"
Sofia Wallin [Wed, 1 Mar 2017 13:14:54 +0000 (13:14 +0000)]
Merge "StorPerf Documentation"

7 years agoMisc changes 43/29443/1
ShubhamRathi [Mon, 27 Feb 2017 14:24:45 +0000 (19:54 +0530)]
Misc changes

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

Change-Id: I8b47e68d64a9a16576abbc2891a39b6dacf164ca
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
7 years agoStorPerf Documentation 05/29305/1
mbeierl [Thu, 23 Feb 2017 18:30:00 +0000 (13:30 -0500)]
StorPerf Documentation

Adds link to StorPerf documentation

Change-Id: I7d59478792867e47e7627f203015b9a1d716c404
Signed-off-by: mbeierl <mark.beierl@dell.com>
7 years agoFixing wrong directory name in documentation guide 27/29227/1
Georg Kunz [Wed, 22 Feb 2017 13:46:04 +0000 (14:46 +0100)]
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>
7 years agoUpdate OPNFVDocs documentation 43/29143/2
ShubhamRathi [Tue, 21 Feb 2017 12:53:52 +0000 (18:23 +0530)]
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>
7 years agoAdjusted titles 11/28711/3
Sofia Wallin [Wed, 15 Feb 2017 12:25:03 +0000 (13:25 +0100)]
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>
7 years agoRemove moon 91/29091/1
ShubhamRathi [Mon, 20 Feb 2017 18:29:34 +0000 (23:59 +0530)]
Remove moon

Change-Id: I0b780d41eeb11dae12174cd7e63be1019ba327f7
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
7 years agoRemove moon, as they are breaking builds 89/29089/1
Aric Gardner [Mon, 20 Feb 2017 18:18:59 +0000 (13:18 -0500)]
Remove moon, as they are breaking builds

Change-Id: Icef338564b07e2fd6e7379697c75624a065ad1b4
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
7 years agoMerge "Add Promise release docs to opnfvdocs"
Sofia Wallin [Mon, 20 Feb 2017 09:51:47 +0000 (09:51 +0000)]
Merge "Add Promise release docs to opnfvdocs"

7 years agoShallow clone to speed things up for RTD 83/28983/2
Aric Gardner [Fri, 17 Feb 2017 19:38:22 +0000 (14:38 -0500)]
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>
7 years agoAdd Promise release docs to opnfvdocs 55/28355/2
Gerald Kunzmann [Thu, 9 Feb 2017 09:46:02 +0000 (09:46 +0000)]
Add Promise release docs to opnfvdocs

Change-Id: Idbc17af03fe7449ef3e20e198f21338880274dc5
Signed-off-by: Gerald Kunzmann <kunzmann@docomolab-euro.com>
7 years agobarometer: add project submodules 39/28839/2
Maryam Tahhan [Thu, 16 Feb 2017 15:01:35 +0000 (15:01 +0000)]
barometer: add project submodules

Change-Id: Ie0119fca1cf27731a1f0b9bab824c0133fd55f41
Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
7 years agoMerge "Added steps to build documentation"
Sofia Wallin [Mon, 13 Feb 2017 13:02:47 +0000 (13:02 +0000)]
Merge "Added steps to build documentation"

7 years agoAdded steps to build documentation 61/28461/1
ShubhamRathi [Fri, 10 Feb 2017 20:06:55 +0000 (01:36 +0530)]
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>
7 years agoDocumentation guide ported from wiki 01/27701/5
ShubhamRathi [Sun, 29 Jan 2017 19:34:55 +0000 (01:04 +0530)]
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>
7 years agoMerge "New Tox build script"
Sofia Wallin [Fri, 3 Feb 2017 09:46:33 +0000 (09:46 +0000)]
Merge "New Tox build script"

7 years agoMerge "New docs for 'How to include documentation'"
Sofia Wallin [Fri, 3 Feb 2017 09:44:24 +0000 (09:44 +0000)]
Merge "New docs for 'How to include documentation'"

7 years agoMisc Changes 73/27773/2
ShubhamRathi [Tue, 31 Jan 2017 09:44:34 +0000 (15:14 +0530)]
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>
7 years agoNew docs for 'How to include documentation' 07/27607/3
ShubhamRathi [Thu, 26 Jan 2017 13:05:38 +0000 (18:35 +0530)]
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>
7 years agoMerge "Moving design/ requirements/ to developer"
Sofia Wallin [Mon, 30 Jan 2017 13:31:28 +0000 (13:31 +0000)]
Merge "Moving design/ requirements/ to developer"

7 years agoChanging Documentation Theme 31/27731/1
ShubhamRathi [Mon, 30 Jan 2017 11:27:16 +0000 (16:57 +0530)]
Changing Documentation Theme

Documentation theme changed from 'united' to
'journal'

Change-Id: I89242a324ea3bd827f829b07f43098d91c225eb8
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
7 years agoMoving design/ requirements/ to developer 21/27721/1
ShubhamRathi [Mon, 30 Jan 2017 09:53:49 +0000 (15:23 +0530)]
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>
7 years agoCleanup old templates and add placeholders where required 99/27699/2
ShubhamRathi [Sun, 29 Jan 2017 18:04:14 +0000 (23:34 +0530)]
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>
7 years agoNew Tox build script 31/27631/1
ShubhamRathi [Thu, 26 Jan 2017 19:10:19 +0000 (00:40 +0530)]
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>
7 years agoRemoving RTD Hack 13/27613/1
ShubhamRathi [Thu, 26 Jan 2017 13:47:39 +0000 (19:17 +0530)]
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>
7 years agoMerge "RTD Workaround to delete old files"
Aric Gardner [Wed, 25 Jan 2017 12:35:51 +0000 (12:35 +0000)]
Merge "RTD Workaround to delete old files"

7 years agoMerge "Adding all templates under templates/"
Sofia Wallin [Tue, 24 Jan 2017 19:48:42 +0000 (19:48 +0000)]
Merge "Adding all templates under templates/"

7 years agoMerge "Original 'Including your Documentation'"
Sofia Wallin [Tue, 24 Jan 2017 19:46:36 +0000 (19:46 +0000)]
Merge "Original 'Including your Documentation'"

7 years agoOriginal 'Including your Documentation' 53/27453/2
ShubhamRathi [Tue, 24 Jan 2017 15:16:33 +0000 (20:46 +0530)]
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>
7 years agoUpdated intro and vsperf project description. 29/27329/2
Trevor Cooper [Sat, 21 Jan 2017 01:11:47 +0000 (17:11 -0800)]
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>
7 years agoAdding all templates under templates/ 41/27341/5
ShubhamRathi [Sat, 21 Jan 2017 17:31:46 +0000 (23:01 +0530)]
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>
7 years agoRTD Workaround to delete old files 87/27287/1
ShubhamRathi [Fri, 20 Jan 2017 10:43:36 +0000 (16:13 +0530)]
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>
7 years agoMove Scenario under release 79/27279/1
ShubhamRathi [Fri, 20 Jan 2017 09:19:38 +0000 (14:49 +0530)]
Move Scenario under release

Scenario templates moved under Release. Spelling for Integration corrected.

Change-Id: I3016ad8226293f3c806563b747fb14a140afece1
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
7 years agoUpdate testing community doc 15/27115/3
Morgan Richomme [Tue, 17 Jan 2017 17:20:27 +0000 (18:20 +0100)]
Update testing community doc

Change-Id: I7ffbb3c0460958e3ecd837a14bf0c9a5752d1fc0
Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>
7 years agoAdjusted naming path 53/27053/1
Sofia Wallin [Mon, 16 Jan 2017 15:12:13 +0000 (16:12 +0100)]
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>
7 years agoMerge "Update build script to newer tag"
Sofia Wallin [Sun, 15 Jan 2017 19:36:48 +0000 (19:36 +0000)]
Merge "Update build script to newer tag"

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 agoUpdate build script to newer tag 37/26937/1
ShubhamRathi [Thu, 12 Jan 2017 14:03:22 +0000 (19:33 +0530)]
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>
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>
7 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>
7 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>
7 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"

7 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>