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>
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"
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>
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>
Ryota MIBU [Fri, 12 Aug 2016 04:20:51 +0000 (04:20 +0000)]
Merge "remove 'Save to PDF' link from normal HTML pages"
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>
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>
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>
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>
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>
ChristopherPrice [Wed, 27 Jul 2016 11:46:53 +0000 (11:46 +0000)]
Merge "Updating the scenario installation template based on comments."
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>
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>
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>
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>
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>
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>
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>
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>
Sofia Wallin [Mon, 11 Jul 2016 13:13:15 +0000 (13:13 +0000)]
Merge "Updated according to Chris comment Minor updates to the structure"
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>
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>
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>
Ryota MIBU [Wed, 6 Jul 2016 13:16:01 +0000 (13:16 +0000)]
Merge "update howto use docs"
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>
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>
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>
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>
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>
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>
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>
Ryota Mibu [Tue, 12 Apr 2016 01:24:32 +0000 (01:24 +0000)]
Merge "add bottlenecks and prediction project for composite doc"
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Ryota Mibu [Wed, 17 Feb 2016 12:49:42 +0000 (12:49 +0000)]
Merge "Next step platformoverview doc"
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>
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>
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>
Ryota MIBU [Mon, 15 Feb 2016 15:05:19 +0000 (00:05 +0900)]
Revert "introduce @OPNFVDOCS_PATH@ and @PROJECT_PATH@"
This reverts commit
00abc9dc015c881138a2790a9757c58bb3d85255.
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>
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>
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>
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>
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>
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>
Sofia Wallin [Wed, 10 Feb 2016 10:23:44 +0000 (10:23 +0000)]
Merge "Created a templamte for release note."
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Christopher Price [Mon, 28 Dec 2015 14:55:57 +0000 (14:55 +0000)]
Merge "Updated the config guide templates"
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>
Christopher Price [Fri, 18 Dec 2015 14:08:53 +0000 (14:08 +0000)]
Merge "Fix Line Length etc for existing docs"
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>
Christopher Price [Fri, 18 Dec 2015 11:24:22 +0000 (11:24 +0000)]
Merge "Skeleton and first draft content platformoverview"
Christopher Price [Fri, 18 Dec 2015 09:10:02 +0000 (09:10 +0000)]
Merge "Created a template for installer configuration"
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>
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>
Christopher Price [Fri, 11 Dec 2015 09:22:46 +0000 (09:22 +0000)]
Merge "updates to use new doc toolchain"
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>
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>
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>
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>
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>
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>
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>
Code Review / opnfvdocs.git / log