Age | Commit message (Collapse) | Author | Files | Lines |
|
'*' 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>
|
|
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>
|
|
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>
|
|
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>
|
|
Change-Id: Ie8e4806686a251ee45e11a8b0447edd6a7407168
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
|
|
Added template for config-overview to be used by the featuers.
Change-Id: I4ed713bb1b4a257a70cba7a6ed51d6f71feb3bcd
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
|
|
Added template for config-overview to be used by the featuers.
Change-Id: Id9d63af4f3f6ab469243800982e46aad236c2030
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
|
|
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>
|
|
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>
|
|
Change-Id: I73fa92f3fd782920486e364818b69e12974f4292
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
Change-Id: Ie358ef46d9bd46e66e4562e05b0fec20b3f1d3c2
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
Added reference sections without local placeholders.
Restructured the user-guide index template.
Change-Id: I8b2e6abbe151a8fb9f3721e761a65f70fada1e85
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
|
|
Change-Id: Idf58d22ea0db6835c7d71570fdd2a413de3c6fc3
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
This patch also adds xtrace for debug.
Change-Id: Ic0642f31ba256ea768f7e7c3a767d2bd3f7f3ba8
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
Change-Id: Ia0182184ea8e2fa528d7ffaba9beaf39e5768be1
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
Change-Id: I82440989202c8b0f5ff36b54965f3269c3ff2d66
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
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>
|
|
Change-Id: I7d70348cea93dddaeefc251554cbe564f8720c40
Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
|
|
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>
|
|
|
|
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>
|
|
|
|
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>
|
|
|
|
|
|
Change-Id: I1accfa33b28b00724e175b1e08a5cd34c1d85245
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
|
|
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>
|
|
|
|
Change-Id: I68bffb1a0803d8aabb95d88ab70e243fb3fc75be
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
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>
|
|
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>
|
|
Modified conf.py to include RTD theme.... html_theme = 'sphinx_rtd_theme'
Change-Id: I9b004725ba4ca6606ad8b9e8700f4395ccdeafaa
Signed-off-by: Luke Hinds <luke.hinds@nokia.com>
|
|
added index.rst
Change-Id: I5af95b40afd5443176c1054085b597a435c31b1b
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
|
|
rst files.
JIRA: BGS-48
Change-Id: I6dfd566af582d8da416065f7e4db728076d62a12
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
|
|
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>
|
|
JIRA: OPNFVDOCS-XXX
Change-Id: I1f1b349fe8f80d6d5c9c8fbbc9750cf92e78a51a
Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
|
|
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>
|
|
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>
|
|
|
|
|
|
JIRA: DOCS-27 - Add Wiki - how update works in enable_docu_gen.rst
Change-Id: Ifcf96ffecbffc539a92ea43167ee81f44733f659
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
|
|
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>
|
|
Change-Id: Ie77e13aa5358f13011852739e792ab23ce5026c4
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
|
|
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>
|
|
JIRA: Including "node: master" for jjb enable-docu-gen jobs
Change-Id: Ib6817d6cf8cad51c292f1347e030842050617432
Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
|
|
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>
|
|
LICENCE
Installation
Build
Release-notes
JIRA:
Change-Id: Ia0ed1ef2042c2ee84ae0b9db78bd117e3ca8de6a
Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
|
|
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>
|
|
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>
|
|
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>
|