summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-09-18Local Documentation BuildsHEADmasterAric Gardner3-0/+6
This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: I8f472b3f2fd6f5fbad97a728166b17f33cf5cb24 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2017-03-07Adding LabelsShubhamRathi7-0/+14
Labels serve as anchors/ refs when referenced from other documents This patch adds labels to docs/*/*/index.rst Change-Id: I4a2497b4fd65e98e364cfa5f90d7b1bdbf3da61a Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-07Updated to use new docs structure WIPAimee Ukasick31-108/+287
JIRA: COPPER-1 WIP - not sure how to fill in the docs/release/scenarios section Change-Id: I8684e4647e7b943ca05dc77131a54338ff932b78 Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2017-02-01Update for DanubeAimee Ukasick10-102/+105
JIRA: COPPER-1 Updated several files for continuity in capitalization and punctuation. Updated release notes. Updated or removed invalid URLs. Generated documentation locally to verify HTML output. Change-Id: I50bc0886f502c26c8fc0539e7e8104763d1a06a2 Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2016-12-07Add network bridging use caseBryan Sullivan1-0/+50
JIRA: COPPER-10 Change-Id: Iede124d2737820820bc48531ec139f92a0f80944 Signed-off-by: Bryan Sullivan <bryan.sullivan@att.com>
2016-09-20Fix typo in titleYujun Zhang1-1/+1
Change-Id: I2583e15b8386070bcceb982d4333a318b5143630 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-09-20Add release limitationsblsaws1-0/+15
JIRA: COPPER-1 Tailing whitespace! Auuugh! Change-Id: I0144deec1676865fff7d5a298e6b3d594871d0d2 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-09-16Correct titleblsaws1-3/+3
JIRA: COPPER-1 Change-Id: I1e656aff0e489c9dddf469c64946769e60e5145d Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-09-16Correct titleblsaws1-3/+3
JIRA: COPPER-1 Change-Id: Ib92eac8f44194176509502fede080d256be5dee2 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-09-08Update copyrightblsaws10-10/+10
JIRA: COPPER-1 Change-Id: I20924b317c47d20b04b6a648456621efd29250b6 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-09-08Update to new docs folders and names.blsaws13-24/+45
JIRA: COPPER-1 Remove trailing whitespace Change-Id: I6291106ca6133034cdee6551df1b7b075ea5ee69 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-08-31Add licenseblsaws9-5/+47
JIRA: COPPER-1 Fix table in definitions Change-Id: Icfd3d004b5d0241d400f2acda88127e6d09fbe60 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-08-31Include config and usage guidelines in main docblsaws4-0/+9
JIRA: COPPER-1 Try 2, the links to docs in other folders are not accepted Try 3, using an include file Try 4, individual include files Change-Id: I57e7b797ce31fc6f248dc42fea33d768ba44ed81 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-08-31Add index fileblsaws4-6/+25
JIRA: COPPER-1 Fix spaces for the very picky parser Change-Id: I5379b01eae2ed402ad5dec1d4846c9dfc9083499 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-08-18Fix link issuesblsaws2-44/+44
JIRA: COPPER-1 More issues... Change-Id: I0bf14d6e6b91c57fb8c132bee991d472ef8c8f31 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-08-18Update docs for Coloradoblsaws8-410/+417
JIRA: COPPER-1 Change-Id: I2c0b1fa29c7129aceff6779ca48f7fb26f288063 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-02-24Align with current congress install scripts.blsaws1-7/+9
JIRA: COPPER-7 Change-Id: I209a27f6ba25183e894204c6a2fa22dd73128254 Signed-off-by: blsaws <bs3131@att.com>
2016-02-19Align install guide with latest developments in bash scripts.Bryan Sullivan1-340/+19
JIRA: COPPER-7 Change-Id: I68fa9bdb789cb83073560e3352709a6b7fc02a6c Signed-off-by: Bryan Sullivan <bs3131@att.com>
2016-02-09fix docsRyota MIBU8-60/+126
- doc8 violations - use latest index.rst format - move userguide.rst to featureusage.rst Change-Id: I73e0a8a45418e197b973537d4f2856bd98c9a06c Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-02Fix more whitespace etc...SULLIVAN3-80/+80
JIRA: COPPER-1 Change-Id: I1edfdbc55d4d3fd0c43cddba45e26eb515728cca Signed-off-by: SULLIVAN <bs3131@att.com>
2016-01-29Baseline of userguide.rstblsaws1-6/+4
JIRA: COPPER-8 Change-Id: Ib4205c178a706996991455efa2dc0f1bea84454b Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-01-29Baseline of postinstall.rstblsaws1-20/+204
JIRA: COPPER-7 Change-Id: Ifbaf72022c0afe1e40077dbe94d316af16e74927 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-01-29Baseline of the featureconfig.rst fileblsaws1-15/+381
JIRA: COPPER-7 Change-Id: I13820a26f09a5c5a002700ee22da5976f49f04e3 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-01-26Address RST formattting issues (extra spaces etc)blsaws5-158/+158
JIRA: COPPER-1 Fix more pesky "errors" Change-Id: I65e722f8969a58e32cde1e4651dfc62fd45c18a7 Signed-off-by: blsaws <bryan.sullivan@att.com>
2016-01-25Include license info in all filesblsaws1-0/+20
JIRA: COPPER-13 Change-Id: Ia3b19854a13d593cc15e51b3460598e61bf66ab0 Signed-off-by: blsaws <blsaws@hotmail.com>
2016-01-20Created a template for the User GuideSofia Wallin1-0/+7
Please use the userguide.rst to desribce the <Feature> capabilities and usage. This information will be part of the OPNFV user guide. Feel free to use this as a good example, https://gerrit.opnfv.org/gerrit/#/c/7397/ Renamed config-overview.rst to userguide.rst Change-Id: I4947f1d57ed05f4b2e39fedbd705cb694e4891be Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-01-13Added 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 test cases for respective feature. Change-Id: I3a2939cfcd733b1346bd9e459fbb70c855699bb8 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2015-12-03Kickoff new docs buildblsaws1-1/+2
JIRA: COPPER-1 Change-Id: I9a00251715bb31c265e7684305b06789d4f062e8 Signed-off-by: blsaws <blsaws@hotmail.com>
2015-12-03Restore conf.pyblsaws1-0/+30
JIRA: COPPER-1 Change-Id: I7d899f6f5ed7ce977da5a9efe9a9404776d199bc Signed-off-by: blsaws <blsaws@hotmail.com>
2015-12-03Merge "Use common documentation configuration from releng"Bryan Sullivan3-37/+2
2015-12-03Use common documentation configuration from relengFatih Degirmenci3-37/+2
Change-Id: I4b5e8debb6195241a2a434d3fc42c4e98b121e16 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2015-12-03Add Release 1 scope to introductionblsaws1-0/+9
JIRA: COPPER-9 Change-Id: I600055f7a298c0db05c840847a353413ad8ab9ba Signed-off-by: blsaws <blsaws@hotmail.com>
2015-11-16Expanded introduction.blsaws1-1/+51
JIRA: COPPER-9 Fix table formatting. Change-Id: I3e9aa7a356d7d5905323d6080146a42aebf41701 Signed-off-by: blsaws <blsaws@hotmail.com>
2015-11-12Add Resource Use Limits use caseblsaws1-3/+23
JIRA: COPPER-3 Change-Id: I1fcb4df3b5e7c24fdf34802e3f3f1ecbda842cd6 Signed-off-by: blsaws <blsaws@hotmail.com>
2015-11-11Add untested use case disclaimer to more use cases.blsaws1-0/+4
Change-Id: I5c4aae09d63b42dac790b1529210d2eff22577c2 Signed-off-by: blsaws <blsaws@hotmail.com>
2015-11-11Move design_docs into docs/designblsaws11-116/+381
Change HTML theme for sphinx Fix makefile reference to old design_docs dir Change-Id: I848115c5901db8dc33aa4157bdbc8af430695f31 Signed-off-by: blsaws <blsaws@hotmail.com>
2015-09-10Example as code, documentation template for sphinx buildAric Gardner4-0/+150
This code will be pushed to each project creating a docs/ directory This servers as an example and template for you (the developers) to create your own project documentation Change-Id: Icef399d11e6f1f1313fa93de7f257e13125c5d5a JIRA:RELENG-15 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-06-10Align folder structure with Doctor. Split docs into sections.blsaws3-147/+0
JIRA:COPPER-1 Change-Id: Ic006eb2780be671b96545865950b831cffbed86d Signed-off-by: blsaws <bs3131@att.com>
2015-06-09Try again due to some unknown jenkins errorblsaws1-1/+1
JIRA:COPPER-1 Change-Id: Ic006eb2780be671b96545865950b831cffbed86d Signed-off-by: blsaws <bs3131@att.com>
2015-06-09Reformat per RST syntaxblsaws1-13/+23
JIRA:COPPER-1 Change-Id: Ic006eb2780be671b96545865950b831cffbed86d Signed-off-by: blsaws <bs3131@att.com>
2015-06-09Fix tabs for the picky rst2html script :-(blsaws1-7/+7
JIRA:COPPER-1 Change-Id: Ic006eb2780be671b96545865950b831cffbed86d Signed-off-by: blsaws <bs3131@att.com>
2015-06-09Kickoff doc builtd testblsaws1-35/+53
JIRA:COPPER-1 Change-Id: Ic006eb2780be671b96545865950b831cffbed86d Signed-off-by: blsaws <bs3131@att.com>
2015-06-08Kickoff doc builtd testblsaws1-1/+1
JIRA:COPPER-1 Change-Id: Ic006eb2780be671b96545865950b831cffbed86d Signed-off-by: blsaws <bs3131@att.com>
2015-05-14JIRA:COPPER-1 Documentation toolchain test for copper. Add version to file ↵blsaws1-0/+2
to kick off documentation build. Signed-off-by: blsaws <bs3131@att.com>
2015-05-14JIRA:COPPER-1 Baseline architecture analysis for toolchain testing.blsaws3-0/+117
Signed-off-by: blsaws <bs3131@att.com>