path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2019-08-06Merge "Update release notes"HEADmasterManuel Buil1-33/+11
2019-05-10Allow TCs to consume config info from user's filePanagiotis Karalis1-0/+11
The SFC TCs are bound by the installers. This means that the SFC TCs could not run on server or VM which all components (e.g. OS, ODL, etc) are deployed manually and not by an installer, because some information are retrieved directly from installer through deploy factory module. A new yaml file is created by user in order for the important information to be consumed by the respective test scenario during test execution. JIRA: SFC-142 Change-Id: I051bb6406b8aa433c19e4df10396b4789448d42b Signed-off-by: Panagiotis Karalis <pkaralis@intracom-telecom.com>
2019-05-06Update release notesManuel Buil1-33/+11
Change-Id: I2c896aa33f05d68d28cdb33ca4709009ccddbdb2 Signed-off-by: Manuel Buil <mbuil@suse.com>
2019-01-23Update release notesManuel Buil1-4/+4
Change-Id: I480506dcbea94ddc4cd35ea0f0c042cc4b958a3e Signed-off-by: Manuel Buil <mbuil@suse.com>
2018-11-13Correct the links to releng-xci and compassManuel Buil2-4/+4
Change-Id: I2285118eafc3059ffa7d1c7e1fba2e3981613c77 Signed-off-by: Manuel Buil <mbuil@suse.com>
2018-11-07Include "how to deploy scenario" sectionManuel Buil2-0/+26
According to the new documentation rules, we should include a section that describes how to deploy de scenario Change-Id: I7f5897e4e1af225ee91defafd65aa99e69684d93 Signed-off-by: Manuel Buil <mbuil@suse.com>
2018-11-06Update documentationManuel Buil7-185/+46
Change-Id: Ic7af81de3d93462f8ee626576cd4f007d5b95f83 Signed-off-by: Manuel Buil <mbuil@suse.com>
2018-09-14Fix links to remove references to submodulesAric Gardner2-20/+11
All references to submodules must be removed for docs to work going forward. Can be tested once your project has a local tox file Change-Id: I8953e7bece19cb5ab733ce15733e4668ca8d6bc1 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2018-06-27Update release notes for Fraser 6.2Manuel Buil1-3/+3
Change-Id: I0d56aa4d5f494a25db92e61415a24b4257c71a04 Signed-off-by: Manuel Buil <mbuil@suse.com>
2018-06-18[Bug fix] Fix broken urlsDimitrios Markou3-4/+4
Change-Id: Ide4d6f8a2a54f70522a01a7467bddcd69daf8531 Signed-off-by: Dimitrios Markou <mardim@intracom-telecom.com>
2018-06-12Merge "Enable local documentation builds"Dimitrios Markou6-0/+55
2018-06-06Enable local documentation buildsTrevor Bramwell6-0/+55
Adds a local conf.py and conf.yaml (using lfdocs-conf), to enable local docs build. Change-Id: Iaab750983f02476d9bccb6c9bcf2b38544d54d8c Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-05-23Update the release notesManuel Buil1-3/+3
Change-Id: I31506971cf57d761f966841029e3a878d2a0d284 Signed-off-by: Manuel Buil <mbuil@suse.com>
2018-04-25Update docs for FraserManuel Buil7-247/+61
Change-Id: Ie53eb812c9111a2f75342470b10ef3376e43b5fb Signed-off-by: Manuel Buil <mbuil@suse.com>
2017-10-02Update the documentation for the releaseManuel Buil2-214/+9
Change-Id: Ief3908496bd6809c412bd394e7fd744f2ee796ae Signed-off-by: Manuel Buil <mbuil@suse.com>
2017-10-02Release notes updateManuel Buil1-67/+98
This is an update of the release notes for the Euphrates release Change-Id: Ia74839aceb53f6a647b4695c0cc3f7cf8d8e8282 Signed-off-by: Manuel Buil <mbuil@suse.com>
2017-08-24Replace artifacts.opnfv links by docs.opnfv linksManuel Buil4-39/+11
artifacts.opnfv is not used anymore. We are using now docs.opnfv Apart from that, I removed the OVS-NSH workaround explanation as we don't use it anymore Change-Id: Iaf4f2d97a4252754f5b22709aef653fff0777eae Signed-off-by: Manuel Buil <mbuil@suse.com>
2017-08-23Added new fdio scenarios descriptionsManuel Buil8-31/+264
As part of MS6 we must have an updated directory structure. I added the two new scenarios using fdio Change-Id: If74dade8c75c59d452b034b98fff5dc0791b2191 Signed-off-by: Manuel Buil <mbuil@suse.com>
2017-08-21Update the docs/development directoryManuel Buil6-30/+21
MS6 requires to have the docs directory structure ready and a preliminary versio of the documents inside it. - Moved requirements file to the requirements folder - Removed the NSH workaround info as we don't need it anymore - Added some new requirements Change-Id: Icca89c738b1eb1865adff510ca2850c592c7a14a Signed-off-by: Manuel Buil <mbuil@suse.com>
2017-07-14Update release notes for Danube 3.0Manuel Buil1-5/+5
Change-Id: I5c4185c41b8baf3e243152b31322a326a07a5d5e Signed-off-by: Manuel Buil <mbuil@suse.com>
2017-06-28Fix typos and other errors in documentationMiguel Lavalle3-6/+6
While reading the documentation, I found typos and other errors. This patchset fixes them. Change-Id: I2bf83a26da58845337dd77e56a8c77aa63084f2f Signed-off-by: Miguel Lavalle <malavall@us.ibm.com>
2017-03-31Fix label nameShubhamRathi1-1/+1
Label was incorrectly named causing it to not link from the composite doc. Change-Id: I9c31209ef81e79547978198ad22f5acd14163de5 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-30Remove references to older releases on documentationroot7-34/+53
- Rename all Brahmaputra/Colorado links to Danube - Bumped OvS version from 2.5.90 to 2.6.1 - Bumped ODL version from Boron to Boron SR2 - Changed release date Change-Id: I4286cbd074b377b4b33e25f33646bb05075f10f5 Signed-off-by: Juan Vidal <juan.vidal.allende@ericsson.com>
2017-03-30Release notes update“Manuel Buil”1-43/+54
Release notes updated Waiting for the official documents to be created to change the links (e.g. user guide, installation guide...) Change-Id: If6569585aaa6362938d5a83633ad8d8a0dd63fa2 Signed-off-by: “Manuel Buil” <mbuil@suse.com>
2017-03-29Corrected a typo on OpenDaylight and made the spelling consistent. Also ↵Ray Paik1-6/+6
used the SPDX shorthand in license header. Change-Id: If91a4ece37bd68a9e7ce413157fd462e88fcc81c Signed-off-by: Ray Paik <rpaik@linuxfoundation.org>
2017-03-16Add Scenario LabelsShubhamRathi2-0/+4
Change-Id: Id585f05597bdea2820a787ca8650a2ad07698426 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-08Adding LabelsShubhamRathi4-0/+8
Labels serve as anchors/ refs when referenced from other documents This patch adds labels to docs/*/*/index.rst Change-Id: I22964ee60952047ca20d8d4c54db790b9c01ee5a Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-16Moving installation docs to configguideBrady Johnson4-50/+0
- After talking to Sofia Wallin, we agreed that this is a better approach for the documentation. Change-Id: Ie3edcb11e4d7823b0d3362395a15bf73aeaaaf4b Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
2017-02-10Migrate docs to the new Danube dir structureBrady Johnson23-0/+0
Change-Id: I6bdfd21add4d04f0fee988f83888c1edcc488951 Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
2016-11-04Release notes updated for Colorado 2.0Manuel Buil1-15/+7
Change-Id: I9ebc7c4c7d780833e9b1b8a8a6cbce360b95655a Signed-off-by: Manuel Buil <manuel.buil@ericsson.com>
2016-09-21Updating limitations in SFC scenario: os-odl_l2-sfc-haBrady Johnson2-2/+4
- The scenario is not working since Tacker isnt available in HA Change-Id: Ic439758487a3cce9f1603fb2392f4b30e7d4a957 Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
2016-09-21Release notes updatedManuel Buil1-1/+18
Limitations were added Change-Id: I3cb08f2c236ac8313632d6d8cf368fceb0e5c777 Signed-off-by: Manuel Buil <manuel.buil@ericsson.com>
2016-09-08Minor, cosmetic changesFerenc Cserepkei1-2/+2
Change-Id: Ic2b7f72a973d2197b8ee84ada9f62a6a9c79c1d8 Signed-off-by: Ferenc Cserepkei <ferenc.cserepkei@ericsson.com>
2016-09-08Installation document addedFerenc Cserepkei1-12/+247
Change-Id: I2a6b3b04091f2a593f4734fc981fc989d34b1236 Signed-off-by: Ferenc Cserepkei <ferenc.cserepkei@ericsson.com>
2016-09-07Update from Brahmaputra to ColoradoBrady Johnson4-23/+16
- Patch Set 2 : fixed broken link Change-Id: Iec5356ad7fcce4b3125e117b6d14f31ca461bf5d Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
2016-09-07SFC User Guide docsBrady Johnson1-3/+34
- Patch Set 2 : added links to Tacker help - Patch Set 3 : fixed hyper links - Patch Set 4 : addressed code review comments Change-Id: I3c279b2c7cf97bdde0567f204296fa76140e6f2c Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
2016-09-07Updating the release notes for SFC ColoradoBrady Johnson1-43/+62
- Patch Set 2: minor correction - Patch Set 3: addressed code review comments - Patch Set 4: more code review comments fixed - Patch Set 6: improved the known issues/limitations section Change-Id: I52c24fea48cb0a107c6aa36bc656148d6525f3ed Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
2016-09-02Adding SFC Scenario documentationBrady Johnson4-0/+266
- For scenarios: os-odl_l2-sfc-ha and os-odl_l2-sfc-noha - Patch Set 2: fixed minor validation warnings Change-Id: Ifc861f6de834b3e49471873fb6ffd36c9d97c3d5 Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
2016-09-02Fixing problems with merge from previous commitBrady Johnson1-10/+0
- Some <<< HEAD tags were left over from a previous merge that wasnt completely resolved. Change-Id: I2dbafdde44a4099f172aecc94ec8dc1435855570 Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
2016-08-31Updated docs structure according to directivesSofia Wallin6-7/+89
Created a sub directory /installationprocedure and added a template for installation and configuration /feature.configuration.rst together with an index.rst Added a /feature.userguide.rst and index.rst under /userguide. Adjusted the releasenotes, renamed the index.rst to releasenotes.rst and added a separate index.rst. Change-Id: I95583558bee739ea1a62e3a4692e872b8025b1b8 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-02-26migrate new docs template and fix pdf viewRyota MIBU8-70/+24
JIRA: SFC-31 Change-Id: I9e46c799083553b8c6142f018cd71a638006a449 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-25Checking to see if the build works with the correct structure.ChristopherPrice1-0/+0
Change-Id: Iaf0aa189ba33a63f7fa89c48fce3ac34dcec5aec Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-25OPNFV SFC release notesBrady Johnson1-0/+183
Change-Id: I64650e3a5eddf0d1115408dacf90720af71792f5 Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
2016-01-21SFC design Documents for Brahmaptura releaseBrady Johnson11-25/+192
- Patch set 9 : Addressed Jim Guichard's review comments. - Patch set 10 : Removed date and revision as its duplicated, according to Chris' review comments. Change-Id: Idca9696c4b703a3ef93b553fe785449cea0935f0 Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
2016-01-11Added templates for feature configuration description/referenceSofia Wallin2-0/+50
The featureconfig.rst document should be used to describe the configuration of the <XYZ> feature. The content will be added to the Brahmaputra configuration guide which intends to describe how to configure the Brahmaputra release to a stable and ready state. For feature projects this should refer to the use of deployment tool scenario selections and post deployment configuration specific to the feature. Also added is the postinstall.rst document for features to describe how to check and analyze the result of ran test cases for respective feature. Change-Id: Ia78659dedd8da5c57aa6e6b21db9ac597fb5eb88 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2015-11-10Correct structureblsaws8-0/+161
Add docs folder Update HTML theme Remove example docs JIRA: SFC-3 Change-Id: If0158796aee5f020f3bb4403b8a67952f9e6bb26 Signed-off-by: blsaws <blsaws@hotmail.com>