summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2016-05-13docs/install-instr: Add target specific cfg sect.Alexandru Avadanii3-1/+50
Fuel 8.0 adds support for setting up "Offloading Modes" for target nodes. Document how this features should be used (and why/when it's necessary), and also its common limitation of not being applied during Verify Networks step (see related Fuel bug report [1]). While at it, fix minor reference to branch in git tag checkout instructions, as we'd be in detached HEAD and not on a new branch. [1] https://jira.opnfv.org/browse/FUEL-134 [Alexandru.Avadanii@enea.com] Only minor edits and prepared for upstreaming, this is mostly based on previous work from Florin. Change-Id: If7a8ca44541903dbeb6db36bc64fe56b132165cb Signed-off-by: Florin Dumitrascu <florin.dumitrascu@enea.com> Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2016-05-12Merge "docs/release-notes: Add protocol handler to ref."Jonas Bjurel2-2/+2
2016-05-12docs/release-notes: Add protocol handler to ref.Alexandru Avadanii2-2/+2
Doc build fails to create a link for www.opnfv.org because it does not explicitly specify the protocol handler. Make doc build happy by adding "http://" prefix. Change-Id: I7dc9c362f13bac1687d139942826eb1208556a37 Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2016-05-12docs/install-instr: Fix git clone URL for HTTPS.Alexandru Avadanii1-2/+2
Drop unnecessary <user>@, not needed for http downloads. Also, fix typo (missing letter) in opnfv.org domain name. While we're at it, fix small typo in Ceilometer name too. Change-Id: I2c3341689b7a7808863906700342e62e707246e9 Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2016-05-11docs/build-instr: Fix git clone URL for HTTPS.Alexandru Avadanii1-4/+11
Fix wrong https git clone URL, 29418 port should be used only for SSH. While we're at it, add some bash code-block markup to bash commands. Change-Id: Ie95a4c170b70bcc3da5d4d59260d61fbd5f2a9f3 Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2016-04-27Updated documentation for Brahmaputra 3.0 follow-up releaseJonas Bjurel5-44/+58
READY TO MERGE Change-Id: Ic481f02375af9be1642791fa6d96856a453c4f29 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-02-24Merge "docs: fix figure placement and old format"Jonas Bjurel6-34/+38
2016-02-23Merge "Final release notes for Fuel Brahmaputra SR0"Jonas Bjurel1-9/+8
2016-02-23Final Fuel Brahmaputra SR0 documentation updateJonas Bjurel1-3/+3
Change-Id: Iee51378f3689c32e82ce179885c2be1bb07ac2ae Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-02-23docs: fix figure placement and old formatRyota MIBU6-34/+38
This patch makes figures in the same place written in source rst files, and also fixes old format of rst files and logo images. Note: lisence headers should be added in another change with relevant copyrights. Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> Change-Id: Ibc5ca44031ef5946079bdf251935100f762a87b6
2016-02-23Final release notes for Fuel Brahmaputra SR0Jonas Bjurel1-9/+8
Change-Id: Id5286c2a7e11eb29d7a7f187decfe475ae6acd6c Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-02-16Final documentation review for Brahmaputra releaseJonas Bjurel5-127/+240
Issue of the Fuel documentation for Brahmaputra for final review as proposed by Sofia and me. This patch will constantly be amended with improvements, corrections, etc as we go. From time to time we will, merge this patch to generate consolidated scraped results. But we will re-issue a review patch with the same topic-branch and commit headline until we have a taged Brahmaputra release. To view/review the entire files from gerrit, click the settings icon almost at the top right, and select "lines of context: entire file" - Note: There is still unknowns highlighted by <TODO> - Please comment on disposition, content, directory placing, etc. - You can find the rendered versions of the Fuel@OPNFV specific docs from the CI-job for this patch. These include: - installation-instruction.rst - build-instruction.rst - release-notes.rst - Scraped document composit rendering are placed - TBD. These include: - installerconfig.rst - postinstall.rst Change-Id: I5e28141cf03d80e5da9c5e10f5e75a3a26994f38 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-02-10Documentation according to new template provided by the Docs teamJonas Bjurel27-527/+677
- The Config guide is not an atonomos document, but will be scraped into a bigger context. - The post install guide is not an atonomos document, but will be scraped into a bigger context. - Installation instructions is an atonomos document describing details on how to install Fuel@OPNFV - Build instructions is an atonomos document describing how to build Fuel@OPNFV - Release notes - Agreed with the community that binary image files shall be in the repo, as much as I hate it. DO NOT MERGE JIRA: FUEL-38 Change-Id: I88a93e20ef2c67a2c973147a7a1e332e3da55674 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-02-04Correcting license and copyright terms throughout the repoJonas Bjurel3-0/+17
Please review this carefully! Strategy: 1) No strict research on copyright/who did what (if you want it changed contact the Fuel team or Jonas Bjurel) 2) Licence statements will not be added to the following file types: - Patch files or orig files for patches - Config files generated by ordinary tools, like libvirt/visrsh - GIT dierctive file - Other auto-generated files Change-Id: I48504c6f27925445dc44683a27a575bcab78d828 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-01-22Added template for postinstallSofia Wallin1-0/+26
Added template for postinstall as part of the configuration guide. Change-Id: I212baa59b071fd785e70a9f018dc004ba79ec9fa Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-01-20Small updates to build-requirements for docker stuff.Daniel Smith1-5/+11
fixed whitespace x2 Change-Id: Ie9d52f820400df10d88ade035f2900aecab0c66d JIRA:0 Signed-off-by: Daniel Smith <daniel.smith@ericsson.com>
2016-01-05Templates for configuration guideSofia Wallin1-0/+0
Please use the installerconfig.rst to describe the configuration for each installer. Removed configoptions from the patch, we will provide patches for the post install procedures template during the day. Change-Id: If315520f153c60e12e6d188fc5e5ba8c1a5bd865 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2015-12-21Created a template for installer configurationSofia Wallin1-0/+23
Change-Id: Ia47d104773987f6517eac2a198994d63c9f8122c Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2015-12-17Updated Installation Instruction for FUEL B-REL WP1 (FUEL 7.0 rebasing)Sofia Wallin3-125/+317
Updates include: - MTU Fix (JIRA FUEL-84) - Updates for FUEL config (admin pwd, HTTP proxy option) - Updates for FUEL 7.0 UI Elements - Tagged areas for updated when ODL is available in next WP - Corrected typo - Changed name installation-intruction - Changed name build-instruction JIRA: FUEL-84 replacing change: https://gerrit.opnfv.org/gerrit/#/c/3449/ Change-Id: Ib855c67e7fbe93781a4252f43f2911d9c5fa0645 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2015-12-03Support for selecting which plugins to buildStefan K. Berg1-0/+21
In order to cut the build time for unofficial builds, this change supports setting the environment variable "BUILD_FUEL_PLUGINS" prior to building. Only the plugin targets from fuel/build/f_isoroot/Makefile that are specified will then be built. In order to completely disable the building of plugins, the environment variable is set to " ". When using this functionality, the resulting iso file will be prepended with the prefix "unofficial-" to clearly indiciate that this is not a full build. Change-Id: Ib0a914ed6577f54f31b056a752691316302081dc Signed-off-by: Stefan K. Berg <stefan.k.berg@ericsson.com>
2015-11-29Remove doc configuration in order to use common configFatih Degirmenci3-35/+1
Common doc generation configuration will be controlled from releng. Change-Id: I4e79a9b7b620fd556eedafbfdc7b3eee223c98eb Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2015-11-29Enable new doc generation for fuelFatih Degirmenci7-0/+63
The work to unify the doc generation for all OPNFV projects is currently ongoing. This change adjusts docs directory structure for fuel project. Trigger the fuel-verify build without cache. verify: no-cache Change-Id: Ie430b662c5b50d38efe0c8a1eb50aa8f01c85e85 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2015-11-27Restructcture of the directory layoutJonas Bjurel4-0/+971
Restructure of the directory layout due to move of Fuel into it's own repo JIRA: FUEL-85 Change-Id: I3647e1992a508f29dce06a5d6c790725c527f6f5 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>