summary |
shortlog | log |
commit |
commitdiff |
review |
tree
first ⋅ prev ⋅ next
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>
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>
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>
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>
Christopher Price [Mon, 11 May 2015 09:01:41 +0000 (09:01 +0000)]
Merge "Add Wiki - how update works in enable_docu_gen.rst"
Christopher Price [Mon, 11 May 2015 09:00:40 +0000 (09:00 +0000)]
Merge "Documentation templates for: LICENCE Installation Build Release-notes"
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Aric Gardner [Wed, 1 Apr 2015 16:02:06 +0000 (16:02 +0000)]
Initial empty repository
Code Review / opnfvdocs.git / log