opnfvdocs.git
8 years agoRemoving Ashiq as a committer after he stood down. 87/11887/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>
(cherry picked from commit f49057fe604a3abf3437761c90b18bda1fe45ee4)

8 years agoFinal edits. 25/10825/1 brahmaputra.1.0
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>
(cherry picked from commit 877535dd9a0b43dea345b44e15796177d49879ba)

8 years agoFinal editorials on release morning. Comment here! 13/10813/1
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>
(cherry picked from commit 9a79923a96c78bdf809fae01d99320d391e64b75)

8 years agoadd links and aodh service 07/10807/1
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>
(cherry picked from commit b3bdb86a4d8f3a702e25c75a7c5dd50b8e2f69ec)

8 years agoUpdating the overview doc with recent comments. 75/10675/1
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>
(cherry picked from commit 4cb9b020b922c090061a2dee77fa8ad77394d7b9)

8 years agoReview and finalize platformoverview 53/10653/1
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>
(cherry picked from commit 0d5c7b5b68fda47b1ee908ea9e002b30881ed83b)

8 years agoplease review, updates for release. 45/10645/1
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>
(cherry picked from commit d4134280f9acbf523454673931155ab4af9b42a0)

8 years agoIncluding additional projects, aligning test content. 79/10479/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>
(cherry picked from commit b3b1197b82cab346fd39a5e309897705472b3cd4)

8 years agoNext step platformoverview doc 35/10135/1
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>
(cherry picked from commit 9496212139c8d24678021f3fec522cfe9001c2f7)

8 years agoMerge "User guide updated for automated content inclusion." into stable/brahmaputra
Ryota Mibu [Tue, 16 Feb 2016 13:09:20 +0000 (13:09 +0000)]
Merge "User guide updated for automated content inclusion." into stable/brahmaputra

8 years agoscript: fix auto feature config builder 55/10055/1
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>
(cherry picked from commit e0a0a51fd5a903f184be9bf78051b8bec4ab6a2a)

8 years agoUser guide updated for automated content inclusion. 53/10053/1
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>
(cherry picked from commit 15ceb63b678d748526df434b82616356f97f0d8e)

8 years agocorrect file path in imported rst files 49/10049/1
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>
(cherry picked from commit 410ae27d228750f1e48f13d89fcbedbdb0708da9)

8 years agoRevert "introduce @OPNFVDOCS_PATH@ and @PROJECT_PATH@" 03/10003/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.
(cherry picked from commit e23cedb0b72dfbbad918fb94a4d63eb09cab0691)

Change-Id: Id96d957e6c781d2e9577a91abfea9b44eeeb1507

8 years agointroduce @OPNFVDOCS_PATH@ and @PROJECT_PATH@ 81/9981/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>
(cherry picked from commit 00abc9dc015c881138a2790a9757c58bb3d85255)

8 years agoscript: gather user guides automatically 73/9973/1
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>
(cherry picked from commit 8b29f1d89a38a37bfbe6d9a3631f641e11c8694a)

8 years agoscript: gather installer config guides automatically 67/9967/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>
(cherry picked from commit c510e2c65b782cb20895a4fcf79cf2cd30dfbd8d)

8 years agoWIP: script: gather feature config guides automatically 85/9785/1
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>
(cherry picked from commit 6bd42c59ae30c30b460f6e69171e71a4e4f9c541)

8 years agoMade some edits to the ONOS documentation 39/9739/1
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>
(cherry picked from commit 1cba2564098a29f40292b4ee4b0097c7be2da715)

8 years agoCreated a templamte for release note. 05/9705/1
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>
(cherry picked from commit 1248219725b58455f67bcfebbab2e87338b83d57)

8 years agouserguide: add new template 03/9603/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>
(cherry picked from commit 07f04d51f3d337d6c5b7ee6f5175dcdbcc30f736)

8 years agoconfigguide: make sections relevant by adding sub-level toctree 27/9527/1
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>
(cherry picked from commit b7519539bf10181d248b69486c490df46693b209)

8 years agoAdding general component descriptions and information. 83/9483/1
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>
(cherry picked from commit 58a2bb9407285dbf2bac8e32bd55582379c49a6a)

8 years agoAdd ipv6 docs entries in feature-config.rst, post-install.rst, userguide.rst and... 49/9349/1
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>
(cherry picked from commit 3f9b7e0eebea5599b3393d92f3220c2d0827c5ac)

8 years agoSmall update for apex and setting some info on component, to be completed. 61/9161/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>
(cherry picked from commit 16bfe0d50a6945ea0ff0a3858439346df2f9c892)

8 years agoAdding new projects content and license information. 41/9141/1
ChristopherPrice [Mon, 1 Feb 2016 15:58:24 +0000 (16:58 +0100)]
Adding new projects content and license information.

This includes content from a variety of projects participating in Brahmaputra.
We need to move to editorial work shortly, establishing a consistent style now that
we have sufficient content in place to work with.

Change-Id: I3a54358186ec788bf8cb60b2e44517c36ff53fa2
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
(cherry picked from commit f0e8daeff47cf716109945f277ba635f6c8e7a55)

8 years agoadd copyright in build script 39/9139/1
Ryota MIBU [Wed, 3 Feb 2016 00:39:55 +0000 (09:39 +0900)]
add copyright in build script

Change-Id: I8e2045a50fc283842ab2476b9411eb2c212145d4
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
(cherry picked from commit ead63efa3372541918b3e8227db49482ccedde9b)

8 years agofix section headers in consistent rule 17/8917/1
Ryota MIBU [Mon, 1 Feb 2016 15:24:22 +0000 (00:24 +0900)]
fix section headers in consistent rule

'*' with overline: document title (placed before toctree)
'=' with overline: sections
'=': subsections
'-': subsubsections

Change-Id: Ia91ec0c4f95185eac911e972a07ebc7fdae372f4
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
(cherry picked from commit 9351f9aed9383b85173215cf892eef5b3fc44fc3)

8 years agoUpdating scripts including composite doc input. 65/8865/1
ChristopherPrice [Sun, 31 Jan 2016 17:49:30 +0000 (18:49 +0100)]
Updating scripts including composite doc input.

Added functest repo to include validation text in userguide and configguide.
Also updated the script based on Ryota's input https://gerrit.opnfv.org/gerrit/8849
Ready to merge although another patch will be needed once the toolchain is
in place to continue to integrate content.

Change-Id: I4d7adbd174cea29aada99fcdbd42d4c182456739
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
(cherry picked from commit 145ed01de3d50f82a9ed25ec1421651b8248df63)

8 years agoIncluding text and graphic placeholders for the user and config guides. (I like apost... 11/8111/12
ChristopherPrice [Wed, 27 Jan 2016 08:25:06 +0000 (09:25 +0100)]
Including text and graphic placeholders for the user and config guides. (I like apostrophes'')

This patch contains the introduction and framing text for the user and config guide.
Work is required to add the scenario/feature mapping section and information.

Change-Id: I71c9fa7cfbac2d0100c743a8855df4a02cc7482c
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoPlatformoverview structured in separate files per section and added some content 93/8293/1
ulik [Thu, 28 Jan 2016 11:24:29 +0000 (12:24 +0100)]
Platformoverview structured in separate files per section and added some content

Jira: DOCS-42
Next step to create platform overview document.
Proper use of index.rst, separate files per major section.
Started to provide content.

Change-Id: I542ae1ed334d9832bbed24926213ce651d2ae4ce
Signed-off-by: ulik <ulrich.kleber@huawei.com>
8 years agoRenamed config-overview to userguide 69/7469/1
Sofia Wallin [Wed, 20 Jan 2016 15:01:40 +0000 (16:01 +0100)]
Renamed config-overview to userguide

Change-Id: Ie8e4806686a251ee45e11a8b0447edd6a7407168
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agoAdded template for config-overview 01/7401/1
Sofia Wallin [Wed, 20 Jan 2016 09:09:09 +0000 (10:09 +0100)]
Added template for config-overview

Added template for config-overview to be used by the featuers.

Change-Id: I4ed713bb1b4a257a70cba7a6ed51d6f71feb3bcd
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agoAdded template for config-overview 95/7395/1
Sofia Wallin [Wed, 20 Jan 2016 08:56:34 +0000 (09:56 +0100)]
Added template for config-overview

Added template for config-overview to be used by the featuers.

Change-Id: Id9d63af4f3f6ab469243800982e46aad236c2030
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agoUpdating the index.rst file to include referred content. 17/7017/13
ChristopherPrice [Sun, 17 Jan 2016 16:31:32 +0000 (17:31 +0100)]
Updating the index.rst file to include referred content.
Adding new committers in the INFO file.

This patch includes updates to the index files to establish the correct structure for the
composite docs in Brahmaputra.  The patch also includes an updated INFO file adding
Ryota Mibu and Sofia Wallin as committers to the project.

add the include references.

Change-Id: Ife98bd25ac3c80d2737132867449ee11f45a581e
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoReverting the reffered file reference to direct manual additions. 37/5937/5
ChristopherPrice [Fri, 8 Jan 2016 14:15:22 +0000 (15:15 +0100)]
Reverting the reffered file reference to direct manual additions.

Removed the generated file refernce in the index.rst file and referring to each project file specifically in the index.rst file.

Change-Id: I00eba02a292d74b2959fa071db3a7e857ce06300
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agocomposite docs: remove creation of other projects docs 81/6481/1
Ryota MIBU [Wed, 13 Jan 2016 06:09:12 +0000 (15:09 +0900)]
composite docs: remove creation of other projects docs

Change-Id: I73fa92f3fd782920486e364818b69e12974f4292
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agocomposite doc: limit project to import 79/6479/1
Ryota MIBU [Wed, 13 Jan 2016 06:04:08 +0000 (15:04 +0900)]
composite doc: limit project to import

Change-Id: Ie358ef46d9bd46e66e4562e05b0fec20b3f1d3c2
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoSmall editorial changes to the template documents. 73/5773/5
ChristopherPrice [Thu, 7 Jan 2016 11:14:15 +0000 (12:14 +0100)]
Small editorial changes to the template documents.

Added reference sections without local placeholders.
Restructured the user-guide index template.

Change-Id: I8b2e6abbe151a8fb9f3721e761a65f70fada1e85
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agofix docs builder script 81/5881/1
Ryota MIBU [Fri, 8 Jan 2016 10:47:30 +0000 (19:47 +0900)]
fix docs builder script

Change-Id: Idf58d22ea0db6835c7d71570fdd2a413de3c6fc3
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agofix args for git-clone in build-composite.sh 73/5873/2
Ryota MIBU [Fri, 8 Jan 2016 09:40:19 +0000 (18:40 +0900)]
fix args for git-clone in build-composite.sh

This patch also adds xtrace for debug.

Change-Id: Ic0642f31ba256ea768f7e7c3a767d2bd3f7f3ba8
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoupdate docs build dir names in .gitignore 45/5845/1
Ryota MIBU [Fri, 8 Jan 2016 02:39:03 +0000 (11:39 +0900)]
update docs build dir names in .gitignore

Change-Id: Ia0182184ea8e2fa528d7ffaba9beaf39e5768be1
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoadd build-composite.sh 91/5791/1
Ryota MIBU [Thu, 7 Jan 2016 14:16:14 +0000 (23:16 +0900)]
add build-composite.sh

Change-Id: I82440989202c8b0f5ff36b54965f3269c3ff2d66
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoUse auto project links generated by jenkins 69/5769/1
Ryota MIBU [Wed, 6 Jan 2016 11:52:12 +0000 (12:52 +0100)]
Use auto project links generated by jenkins

Note: https://gerrit.opnfv.org/gerrit/5767 is needed for this change.

Change-Id: I809edabea89129d9472852ceb07c323be97bdf45
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoUse include directive to include project docs in opnfvdocs 47/5747/1
Fatih Degirmenci [Wed, 6 Jan 2016 11:52:12 +0000 (12:52 +0100)]
Use include directive to include project docs in opnfvdocs

Change-Id: I7d70348cea93dddaeefc251554cbe564f8720c40
Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
8 years agoAdding template files for the configguide composite document 59/5559/10
ChristopherPrice [Tue, 5 Jan 2016 10:02:46 +0000 (11:02 +0100)]
Adding template files for the configguide composite document

Added the feature configuration and post install/config template files for use in the composite configguide document.
Fixed trailing whitespace, and added ./ specificity to the local doc references.

Change-Id: I7778993d01d978b60d46375b334d59dbdc2b855a
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
8 years agoMerge "Updated the config guide templates"
Christopher Price [Mon, 28 Dec 2015 14:55:57 +0000 (14:55 +0000)]
Merge "Updated the config guide templates"

8 years agoUpdated the config guide templates 11/5311/1
Sofia Wallin [Mon, 28 Dec 2015 13:04:14 +0000 (14:04 +0100)]
Updated the config guide templates

Updated the config guide templates.Some sections still need work.
Please feel free to change/add or update where needed.

Change-Id: Iaec8616a0d808a7b2c2f72433c630a36afaf4703
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agoMerge "Fix Line Length etc for existing docs"
Christopher Price [Fri, 18 Dec 2015 14:08:53 +0000 (14:08 +0000)]
Merge "Fix Line Length etc for existing docs"

8 years agoFix Line Length etc for existing docs 49/4849/2
Uli Kleber [Fri, 18 Dec 2015 10:35:35 +0000 (11:35 +0100)]
Fix Line Length etc for existing docs

Jira: DOCS-68
Fixing errors reported by the new tooling.
platformoverview/index.rst will be fixed with the new platformoverview
document (see separate patch)

corrected importing logo images

Change-Id: I08f73dcfeef4f2ff3a38a0372491a46798b4026b
Signed-off-by: Uli Kleber <ulrich.kleber@huawei.com>
8 years agoMerge "Skeleton and first draft content platformoverview"
Christopher Price [Fri, 18 Dec 2015 11:24:22 +0000 (11:24 +0000)]
Merge "Skeleton and first draft content platformoverview"

8 years agoMerge "Created a template for installer configuration"
Christopher Price [Fri, 18 Dec 2015 09:10:02 +0000 (09:10 +0000)]
Merge "Created a template for installer configuration"

8 years agoCreated a template for installer configuration 53/4453/2
Sofia Wallin [Mon, 14 Dec 2015 15:27:30 +0000 (16:27 +0100)]
Created a template for installer configuration

Change-Id: I1accfa33b28b00724e175b1e08a5cd34c1d85245
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
8 years agoSkeleton and first draft content platformoverview 73/4673/3
Uli Kleber [Wed, 16 Dec 2015 14:44:54 +0000 (15:44 +0100)]
Skeleton and first draft content platformoverview

Jira: DOCS-42
Skeleton is showing, which sort of content is expected.
Some content could already be provided, in other cases there
are Editor's notes describing the way to go.

worked on comments.
mistake in index.rst fixed

Change-Id: I075dc20398a87087910cb2d997db51f30f2d12e0
Signed-off-by: Uli Kleber <ulrich.kleber@huawei.com>
8 years agoMerge "updates to use new doc toolchain"
Christopher Price [Fri, 11 Dec 2015 09:22:46 +0000 (09:22 +0000)]
Merge "updates to use new doc toolchain"

8 years agoupdates to use new doc toolchain 79/4279/1
Ryota MIBU [Fri, 11 Dec 2015 06:30:46 +0000 (15:30 +0900)]
updates to use new doc toolchain

Change-Id: I68bffb1a0803d8aabb95d88ab70e243fb3fc75be
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
8 years agoAdding structure to the Config guide 37/4137/2
Sofia Wallin [Thu, 3 Dec 2015 11:47:50 +0000 (12:47 +0100)]
Adding structure to the Config guide

Removed content text from the index file. Created content files,
added sub sections for installers and features.

Change-Id: I630ac62546b6cd8facc793e595f647b5a5d8c45f
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
9 years agoJIRA: DOCS64 61/3561/1
ChristopherPrice [Tue, 24 Nov 2015 09:46:51 +0000 (10:46 +0100)]
JIRA: DOCS64
Adding three test files to establish the cross repository workflow and build out the templates for the Brahmaputra release documents.

Change-Id: I9afdaccfae5e583fdca43789ee65940f83514d34
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
9 years agoAdded opnfv-security-guide 89/3189/2
Luke Hinds [Tue, 10 Nov 2015 18:57:43 +0000 (18:57 +0000)]
Added opnfv-security-guide

Modified conf.py to include RTD theme.... html_theme = 'sphinx_rtd_theme'

Change-Id: I9b004725ba4ca6606ad8b9e8700f4395ccdeafaa
Signed-off-by: Luke Hinds <luke.hinds@nokia.com>
9 years agoMove documents to new directory structure 83/3183/1
Aric Gardner [Tue, 10 Nov 2015 18:38:38 +0000 (13:38 -0500)]
Move documents to new directory structure

added index.rst

Change-Id: I5af95b40afd5443176c1054085b597a435c31b1b
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
9 years agoUpdatng the doc tracking text to show _sha1_ and _date_ as required in the rst files. 63/763/3
ChristopherPrice [Wed, 3 Jun 2015 20:58:47 +0000 (22:58 +0200)]
Updatng the doc tracking text to show _sha1_ and _date_ as required in the rst files.

JIRA: BGS-48

Change-Id: I6dfd566af582d8da416065f7e4db728076d62a12
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
9 years agoAdd syntax highlighting for bash blocks 69/1069/2
Aric Gardner [Fri, 24 Jul 2015 16:00:35 +0000 (12:00 -0400)]
Add syntax highlighting for bash blocks

Also remove some []'s that were casuing rst2pdf to intepret a line as an
ipv6 url

Change-Id: I5e0cd0d455cc25e24853c37ac9329394c763828d
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
9 years agoTest docu-build.sh 68/668/1 stable/arno arno.2015.1.0 arno.2015.2.0
Fatih Degirmenci [Wed, 27 May 2015 14:37:40 +0000 (16:37 +0200)]
Test docu-build.sh

JIRA: OPNFVDOCS-XXX

Change-Id: I1f1b349fe8f80d6d5c9c8fbbc9750cf92e78a51a
Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
9 years agoSmall fix for sed _sha1_ and _date_ replacement 45/645/2
Victor Laza [Mon, 25 May 2015 11:19:53 +0000 (14:19 +0300)]
Small fix for sed _sha1_ and _date_ replacement

JIRA: DOCS-35 - Added also a comment on how to proceed in the code.

Change-Id: I96ce01ea8b4213e5a0dce08792118137a4eed0bd
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoUpdate docs/enable_docu_gen.rst scripts to include "rst2html --halt=warning" 11/511/6
Victor Laza [Tue, 12 May 2015 10:26:21 +0000 (13:26 +0300)]
Update docs/enable_docu_gen.rst scripts to include "rst2html --halt=warning"

JIRA: DOCS-32 - Update docs/enable_docu_gen.rst scripts to include "rst2html --halt=warning"
and added a more clear tree structure for repository

Change-Id: Iaabce4dcb04464cae1ec6404a6e86aee275e339c
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoMerge "Add Wiki - how update works in enable_docu_gen.rst"
Christopher Price [Mon, 11 May 2015 09:01:41 +0000 (09:01 +0000)]
Merge "Add Wiki - how update works in enable_docu_gen.rst"

9 years agoMerge "Documentation templates for: LICENCE Installation Build Release-notes"
Christopher Price [Mon, 11 May 2015 09:00:40 +0000 (09:00 +0000)]
Merge "Documentation templates for: LICENCE Installation Build Release-notes"

9 years agoAdd Wiki - how update works in enable_docu_gen.rst 74/474/3
Victor Laza [Tue, 5 May 2015 08:06:25 +0000 (11:06 +0300)]
Add Wiki - how update works in enable_docu_gen.rst

JIRA: DOCS-27 - Add Wiki - how update works in enable_docu_gen.rst

Change-Id: Ifcf96ffecbffc539a92ea43167ee81f44733f659
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoUpdate opnfvdocs/docs/enable_docu_gen.rst with latest scripts 45/445/2
Victor Laza [Thu, 30 Apr 2015 09:36:33 +0000 (12:36 +0300)]
Update opnfvdocs/docs/enable_docu_gen.rst with latest scripts

JIRA: DOCS-25 - Update opnfvdocs/docs/enable_docu_gen.rst with latest scripts
that extract project name from git rather that hard-coded

Change-Id: Iadb6fdf80653f45926037c6898e44ea18c33ee6c
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoJIRA: #2 update docs/enable_docu_gen.rst with latest image include code 26/426/1
Victor Laza [Tue, 28 Apr 2015 12:31:35 +0000 (15:31 +0300)]
JIRA: #2 update docs/enable_docu_gen.rst with latest image include code

Change-Id: Ie77e13aa5358f13011852739e792ab23ce5026c4
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoUpdated docs/enable_docu_gen.rst with latest image include code 24/424/2
Victor Laza [Tue, 28 Apr 2015 08:46:50 +0000 (11:46 +0300)]
Updated docs/enable_docu_gen.rst with latest image include code

JIRA: Updated docs/enable_docu_gen.rst with latest image include code
that will make visible images in .html artifacts also

Change-Id: Ie2938a1feeb815ddf51cafb53c96df3690ec6f4c
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoIncluding "node: master" for jjb enable-docu-gen jobs 15/415/1
Victor Laza [Mon, 27 Apr 2015 15:33:04 +0000 (18:33 +0300)]
Including "node: master" for jjb enable-docu-gen jobs

JIRA: Including "node: master" for jjb enable-docu-gen jobs

Change-Id: Ib6817d6cf8cad51c292f1347e030842050617432
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoUpload and include a smiley face into one of the documentations 14/414/1
Victor Laza [Mon, 27 Apr 2015 15:23:52 +0000 (18:23 +0300)]
Upload and include a smiley face into one of the documentations

JIRA: Using this to test the image upload script and html scrape
with included images.

Change-Id: I4d1baab8f4bd7cd89ddf1f714c5b5a68624bf097
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoDocumentation templates for: 56/356/3
Jonas Bjurel [Thu, 16 Apr 2015 19:23:57 +0000 (21:23 +0200)]
Documentation templates for:
LICENCE
Installation
Build
Release-notes

JIRA:
Change-Id: Ia0ed1ef2042c2ee84ae0b9db78bd117e3ca8de6a
Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
9 years agoUpdated docs/enable_docu_gen.rst to include the new updated script 90/390/8
Victor Laza [Mon, 20 Apr 2015 08:16:55 +0000 (11:16 +0300)]
Updated docs/enable_docu_gen.rst to include the new updated script

JIRA: Updated docs/enable_docu_gen.rst to include the new updated script
and added **Documentation trackin** to all docs in opnfvdocs

Change-Id: Ifc0390b8f5b96290f37143a49b543ce5e123ed24
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoRemoved requirements/main.rst to rest if build-docu.sh skips missings 73/373/8
Victor Laza [Fri, 17 Apr 2015 14:10:44 +0000 (17:10 +0300)]
Removed requirements/main.rst to rest if build-docu.sh skips missings

JIRA: Removed requirements/main.rst to rest if build-docu.sh skips missings
and fixed some small typos + sha1 & date injection

Change-Id: I72a52136d4f0380f53ce2ca2a2a9e1f8db92b518
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoImproved cosmetics of enable_docu_gen.rst & other_options_for_docu_gen.rst 61/361/4
Victor Laza [Fri, 17 Apr 2015 07:56:43 +0000 (10:56 +0300)]
Improved cosmetics of enable_docu_gen.rst & other_options_for_docu_gen.rst

JIRA: Removed some unneeded whitespaces, added link to reSt online editor with
live preview, link to documentation structure, more quick guides into reSt,
reworked link to PDF artifact

Change-Id: Ide489410bf8fa3bf5910b5b2e328c61a7d6b0348
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoAdded dummy .rst files and folders for opnfvdocs 42/342/1
Victor Laza [Thu, 16 Apr 2015 12:07:49 +0000 (15:07 +0300)]
Added dummy .rst files and folders for opnfvdocs

JIRA: Added dummy .rst files and folders for opnfvdocs

Change-Id: Icae9326dee1ac49a33ef084e05efa08e57ca8fc1
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoAdded docs/opnfv-jjb-usage.rst under opnfvdocs 41/341/1
Victor Laza [Thu, 16 Apr 2015 11:18:30 +0000 (14:18 +0300)]
Added docs/opnfv-jjb-usage.rst under opnfvdocs

JIRA: OCTO-40 - added docs/opnfv-jjb-usage.rst sourced from
https://wiki.opnfv.org/octopus/jenkins_wow

Change-Id: I1d4aa41aa91d8c8cee12b2d4b0a3736e2ed8b2a4
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoRemoved a redundant comment in the guide related to PDF 39/339/1
Victor Laza [Thu, 16 Apr 2015 09:10:33 +0000 (12:10 +0300)]
Removed a redundant comment in the guide related to PDF

JIRA: Removed a redundant comment in the guide related to PDF download

Change-Id: I044d94f4095d32dd514446b7042283375519843c
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoSplit/improved the documentation to enable docu-gen for projects 37/337/1
Victor Laza [Thu, 16 Apr 2015 08:27:04 +0000 (11:27 +0300)]
Split/improved the documentation to enable docu-gen for projects

JIRA: The part with other options tested has been separated, link to PDF
has been added, fixed indentation on job-template, added explanation that every
commit/merge might affect the docu displayed on wiki

Change-Id: Ieb33a08388522cc7d05e155de8f1f5fb9333d4f4
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoJIRA: JIRA - ? 36/336/1
ChristopherPrice [Thu, 16 Apr 2015 07:28:48 +0000 (09:28 +0200)]
JIRA: JIRA - ?
Adding Victor Laza as a committer on opnfvdocs.  Updated INFO file with information and reference to the vote.

Change-Id: Iaaccb7ce329dc53751b020817ad624f11f8b1179
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
9 years agoCosmetical operations in enable_docu_gen.rst to make a better looking document 34/334/2
Victor Laza [Wed, 15 Apr 2015 20:46:52 +0000 (23:46 +0300)]
Cosmetical operations in enable_docu_gen.rst to make a better looking document

JIRA: Cosmetical operations in enable_docu_gen.rst to make a better looking document:
rearanged some paragraphs, cleaner embedded code, scrape example

Change-Id: I1cd78bd8d8ccb4634d7eebd8f80b1769fd8d4e11
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoAdded extra code and explanations + some fixes for enable_docu_gen.rst 33/333/3
Victor Laza [Wed, 15 Apr 2015 20:07:21 +0000 (23:07 +0300)]
Added extra code and explanations + some fixes for enable_docu_gen.rst

JIRA: Added extra code and explanations + some fixes for enable_docu_gen.rst

Change-Id: Ic15fb871b4fcaa7281bad0312f48457baa163768
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoMoved main.rst & enable_docu_gen.rst under docs/ 32/332/1
Victor Laza [Wed, 15 Apr 2015 19:42:27 +0000 (22:42 +0300)]
Moved main.rst & enable_docu_gen.rst under docs/

JIRA: Moved main.rst & enable_docu_gen.rst under docs/

Change-Id: I597a465e8f5cc915430b3f39163434e6a981b666
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoEnable docu-gen for projects & main.rst 10/310/7
Victor Laza [Tue, 14 Apr 2015 14:44:42 +0000 (17:44 +0300)]
Enable docu-gen for projects & main.rst

JIRA: Adding the guide to enable docu-gen for projects
and main.rst moved from docs/

Change-Id: Iccce14028525157fd71149ee1ab408c39eeaf087
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoFirst version of release-notes template.rst 16/316/2
Jonas Bjurel [Tue, 14 Apr 2015 20:44:48 +0000 (22:44 +0200)]
First version of release-notes template.rst
First version of installation-instruction.rst
Git out-of sync issues hopefully fixed!

JIRA:

Change-Id: I4715710bc01a05b5cdff532a438e205bb32a6336
Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
9 years agoFirst version of release-notes template 07/307/1
Jonas Bjurel [Tue, 14 Apr 2015 13:28:36 +0000 (15:28 +0200)]
First version of release-notes template
JIRA:

Change-Id: I28e36486cfbbb5dac26d0b773ac9eee6462ece55

Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
9 years agoJIRA: DOCS-2 - docs/main.rst file for docu-generation in opnfvdocs 54/254/3
Victor Laza [Fri, 3 Apr 2015 13:46:12 +0000 (16:46 +0300)]
JIRA: DOCS-2 - docs/main.rst file for docu-generation in opnfvdocs

docs/main.rst contain basic .rst markup language with source from
https://wiki.opnfv.org/documentation_projects/opnfv_documentation

Change-Id: I84a72956a7455b1c24459811dd579af0082c4246
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
9 years agoAdding INFO and LICENSE file 43/243/1
Aric Gardner [Wed, 1 Apr 2015 16:12:12 +0000 (12:12 -0400)]
Adding INFO and LICENSE file

Change-Id: I2d91cf7b6d24a468b1391029f36e2dbb19be0161
JIRA:0000
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
9 years agoAdding gitreview
Aric Gardner [Wed, 1 Apr 2015 16:10:51 +0000 (12:10 -0400)]
Adding gitreview

JIRA:0000
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
9 years agoInitial empty repository
Aric Gardner [Wed, 1 Apr 2015 16:02:06 +0000 (16:02 +0000)]
Initial empty repository