summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2015-12-28Updated the config guide templatesSofia Wallin4-9/+44
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>
2015-12-17Created a template for installer configurationSofia Wallin1-0/+23
Change-Id: I1accfa33b28b00724e175b1e08a5cd34c1d85245 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2015-12-09Adding structure to the Config guideSofia Wallin5-9/+40
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>
2015-11-24JIRA: DOCS64ChristopherPrice6-0/+89
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>
2015-11-10Added opnfv-security-guideLuke Hinds14-0/+169
Modified conf.py to include RTD theme.... html_theme = 'sphinx_rtd_theme' Change-Id: I9b004725ba4ca6606ad8b9e8700f4395ccdeafaa Signed-off-by: Luke Hinds <luke.hinds@nokia.com>
2015-11-10Move documents to new directory structureAric Gardner9-0/+102
added index.rst Change-Id: I5af95b40afd5443176c1054085b597a435c31b1b Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-09-13Updatng the doc tracking text to show _sha1_ and _date_ as required in the ↵ChristopherPrice1-5/+2
rst files. JIRA: BGS-48 Change-Id: I6dfd566af582d8da416065f7e4db728076d62a12 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2015-07-24Add syntax highlighting for bash blocksAric Gardner2-3/+7
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>
2015-05-27Test docu-build.sharno.2015.2.0arno.2015.1.0stable/arnoFatih Degirmenci1-1/+1
JIRA: OPNFVDOCS-XXX Change-Id: I1f1b349fe8f80d6d5c9c8fbbc9750cf92e78a51a Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2015-05-25Small fix for sed _sha1_ and _date_ replacementVictor Laza1-5/+16
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>
2015-05-14Update docs/enable_docu_gen.rst scripts to include "rst2html --halt=warning"Victor Laza1-17/+74
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>
2015-05-11Merge "Add Wiki - how update works in enable_docu_gen.rst"Christopher Price1-0/+6
2015-05-11Merge "Documentation templates for: LICENCE Installation Build Release-notes"Christopher Price4-4/+241
2015-05-05Add Wiki - how update works in enable_docu_gen.rstVictor Laza1-0/+6
JIRA: DOCS-27 - Add Wiki - how update works in enable_docu_gen.rst Change-Id: Ifcf96ffecbffc539a92ea43167ee81f44733f659 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-04-30Update opnfvdocs/docs/enable_docu_gen.rst with latest scriptsVictor Laza2-18/+21
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>
2015-04-28JIRA: #2 update docs/enable_docu_gen.rst with latest image include codeVictor Laza1-21/+19
Change-Id: Ie77e13aa5358f13011852739e792ab23ce5026c4 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-04-28Updated docs/enable_docu_gen.rst with latest image include codeVictor Laza1-0/+35
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>
2015-04-27Including "node: master" for jjb enable-docu-gen jobsVictor Laza1-0/+6
JIRA: Including "node: master" for jjb enable-docu-gen jobs Change-Id: Ib6817d6cf8cad51c292f1347e030842050617432 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-04-27Upload and include a smiley face into one of the documentationsVictor Laza2-0/+10
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>
2015-04-23Documentation templates for:Jonas Bjurel4-4/+241
LICENCE Installation Build Release-notes JIRA: Change-Id: Ia0ed1ef2042c2ee84ae0b9db78bd117e3ca8de6a Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2015-04-20Updated docs/enable_docu_gen.rst to include the new updated scriptVictor Laza7-69/+170
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>
2015-04-17Removed requirements/main.rst to rest if build-docu.sh skips missingsVictor Laza3-7/+5
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>
2015-04-17Improved cosmetics of enable_docu_gen.rst & other_options_for_docu_gen.rstVictor Laza3-36/+42
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>
2015-04-16Added dummy .rst files and folders for opnfvdocsVictor Laza1-0/+1
JIRA: Added dummy .rst files and folders for opnfvdocs Change-Id: Icae9326dee1ac49a33ef084e05efa08e57ca8fc1 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-04-16Added docs/opnfv-jjb-usage.rst under opnfvdocsVictor Laza1-0/+164
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>
2015-04-16Removed a redundant comment in the guide related to PDFVictor Laza1-3/+2
JIRA: Removed a redundant comment in the guide related to PDF download Change-Id: I044d94f4095d32dd514446b7042283375519843c Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-04-16Split/improved the documentation to enable docu-gen for projectsVictor Laza2-109/+119
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>
2015-04-15Cosmetical operations in enable_docu_gen.rst to make a better looking documentVictor Laza1-46/+72
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>
2015-04-15Added extra code and explanations + some fixes for enable_docu_gen.rstVictor Laza1-45/+60
JIRA: Added extra code and explanations + some fixes for enable_docu_gen.rst Change-Id: Ic15fb871b4fcaa7281bad0312f48457baa163768 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-04-15Moved main.rst & enable_docu_gen.rst under docs/Victor Laza2-0/+282
JIRA: Moved main.rst & enable_docu_gen.rst under docs/ Change-Id: I597a465e8f5cc915430b3f39163434e6a981b666 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-04-15Enable docu-gen for projects & main.rstVictor Laza1-95/+0
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>
2015-04-14First version of release-notes template.rstJonas Bjurel2-26/+241
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>
2015-04-14First version of release-notes templateJonas Bjurel1-0/+256
JIRA: Change-Id: I28e36486cfbbb5dac26d0b773ac9eee6462ece55 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2015-04-09JIRA: DOCS-2 - docs/main.rst file for docu-generation in opnfvdocsVictor Laza1-0/+95
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>