summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
AgeCommit message (Collapse)AuthorFilesLines
2023-07-25Updating Installation and fixing the toc.treeHEADstable/orinocomasterEdit Koselak1-22/+19
Minor editorial changes in User guide Signed-off-by: Edit Koselak <edit.koselak@nokia.com> Change-Id: Ib0afb05062cc8e5e3c5ad5a61fc51aef258613f0
2023-06-21[root]: Adding remembrance of AlGergely Csatari1-0/+12
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Change-Id: I27e4d742c8e4e8a12ba570815fd1f4d0d7bbfe77
2022-12-16[pcac]: Reworking the langing pagestable/nileGergely Csatari1-23/+76
- Changing the intro text to be more clear and to refer all type of things Anuket delivers - Adding a figure about the Anuket project structure - Reorganizing the chapter structure beased on reader personas Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Change-Id: I4f5d5096abf45f782546b4621d016d2d03cf64d3
2022-12-13[pcac] clean-up of broken links and outdated textGeorg Kunz1-1/+0
This change fixes all broken links and updates outdated text. It also replaces OPNFV with Anuket in the testing documentation. Signed-off-by: Georg Kunz <georg.kunz@ericsson.com> Change-Id: I5187f19a5345ce19cfe03d1935b6213ff89d56a3
2022-09-28Fixing warnings to unclutter the build logGeorg Kunz1-1/+4
As part of cleaning up the Anuket/OPNFV documentation, this change fixes a few warnings to unclutter the build log. Signed-off-by: Georg Kunz <georg.kunz@ericsson.com> Change-Id: I90351d55b2def457b2180cf20d96b9035b5802ff
2022-09-22Fixed links to the Anuket SpecificationsEdit Koselak1-4/+7
Signed-off-by: Edit Koselak <edit.koselak@nokia.com> Change-Id: Iceb1821043f8cabbfff8548f6e1ab97e21b35a35
2022-08-08Consistent use of material theme across specs and impl project docsGeorg Kunz1-1/+1
This applies the same material theme and build dependencies to the implementation project documentation as used by the specs. It thereby creates a consistens look-and-feel across both set of docs. Signed-off-by: Georg Kunz <georg.kunz@ericsson.com> Change-Id: I16f8bf2b500260549bab8b21d1ab58d76cb103c6
2021-07-07Update glossary to make it link-ableEmma Foley1-0/+5
Using the sphinx glossary directive [1], the terms in the glossary can now be linked from the main docs. To link a glossary term, use the following syntax to link to term Anuket:: :term:`Anuket` :term: `This project <Anuket>` [1] https://sublime-and-sphinx-guide.readthedocs.io/en/latest/glossary.html Signed-off-by: Emma Foley <efoley@redhat.com>
2021-07-02Update index.rstAl Morton1-2/+2
2021-07-02New Header for Installation Update index.rstAl Morton1-0/+3
2021-07-02Remove XCI from top-level index.rstAl Morton1-1/+1
2021-07-02Update index.rstAl Morton1-1/+4
2021-07-01Fix formatting, remove dead links/outdated docsTrevor Bramwell1-3/+3
- Removes the outdated scenario documentation These docs included links to images that no longer exist - Removes the broken links to apex, sfc, clover, doctor, and ipv6 These no longer work as the infersphinx linking has been removedA - Removes links to missing documents - Fixes a minor issues with the index header - Updates the docs-linkcheck tox environment with the correct path to requirements.txt - Replaces the IRC link to Slack Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2021-06-25Update index.rst "implementations"Al Morton1-2/+2
2021-06-24Update index.rst for Anuket projectAl Morton1-5/+7
2020-10-27fix headingSofia Wallin1-2/+2
Change-Id: Ifa9e8d41a3cbcd1017bf7662a58376fc9d16ea86 Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
2020-10-27Doc structure updateSofia Wallin1-10/+8
Updating the landing page according to the new structure. Change-Id: I68cef5330df3f7093f456b8abdb56efc75c7d8ed Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
2020-01-28Iruya updatesSofia Wallin1-6/+0
Removed Calipso Removed section 'OPNFV projects' since it's an unmaintained list and does not add any value. Change-Id: I73b6212ce60cfdafdc50108da092767f5b0e900f Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
2018-11-10removing the documentation guideSofia Wallin1-1/+0
not needed twice, it's placed under 'developer' Change-Id: I059e2d711e51daffdc5e4c8d75be058d75dedca7 Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
2018-11-09Merge "Fix minor Documentation Formatting Errors"Aric Gardner1-1/+1
2018-11-09Fix Calipso link on indexTrevor Bramwell1-4/+1
This was missing the title for the link and included in a toctree. Change-Id: Ifd28a1dc1b6a771d28a898b2dd97f0c456ae4034 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-11-06Fix minor Documentation Formatting ErrorsTrevor Bramwell1-1/+1
These include wrongly indented bullet points, title underlines, and malfomed links. Templates which are used for project documentation are also excluded from builds as they are orphaned pages. Change-Id: Iaabfb5f2bbf0b9bdfabec622e0b75dd23ea9e472 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-11-06Change submodules for :doc: for feature projectsAric Gardner1-1/+1
In feature projects there were tons of broken links It does not make sense to link to anything but the projects index file here, as we do not control what the project does past having a doc/index.rst The infrastructure guide is in a better shape but has two broken links The projects that are inactive will show greyed out links untill they add an index.rst Change-Id: I9cba2cc7dd355e3ed90cfe72b3646f25cd76558a Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2018-03-27Removing broken linkSofia Wallin1-1/+0
Change-Id: Id20dc62e151ed3954b0334224a81a19cf026e68f Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2018-02-05Improvements for landing pageSofia Wallin1-0/+2
Adding 'getting started' for users and a link to the wiki for 'developer on bording' for developers/contributors. Change-Id: I8a84a36fb11deb09ddf5ad26a8c6233a60513278 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-12-15Adding Calipso docs to landing pageSofia Wallin1-0/+8
I needed to add submodules/calipso/docs/release/index This fixed the puking of the docs over the main page https://gerrit.opnfv.org/gerrit/49113 Fix calipso index. Must be merged after https://gerrit.opnfv.org/gerrit/#/c/48997/ Change-Id: I2287944cd34c404f23e0d391d09b167c0c0d2064 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-12-07Fix IRC Link on OPNFV Docs Overview PageTrevor Bramwell1-1/+1
Change-Id: I0ee1bf803df58e15a036cc02cc8d905ff18d0f2e Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2017-12-06Update Documentation Landing PageTrevor Bramwell1-7/+7
Change-Id: Ic6e4aabac17fd77888938a050ca5d93bdab40ce7 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2017-09-29Adjust infra documentationFatih Degirmenci1-2/+0
Change-Id: I93028410a11309a5726b5b0ca47d70007dd26ac0 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2017-09-29Adjust the structure for infra documentationFatih Degirmenci1-1/+5
Change-Id: Id2901b810a967ecbf8f6af84604e4839890e44e4 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2017-09-29Put initial structure for infra documentationFatih Degirmenci1-0/+2
Change-Id: I4d8ed269cbf0eeedaa0ee540ac2fd6bca5e429b0 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2017-04-27Updates on landing pageSofia1-6/+13
Added 'Infrastructure' Removed documentation from each subheading Renamed 'Test' to 'Test Frameworks' Change-Id: I1c67c47dc5e5a37037236458c5e373b1f3bf5b8f Signed-off-by: Sofia <sofia.wallin@ericsson.com>
2017-04-04Add Scenario for OVSNFVShubhamRathi1-1/+1
1. Add OVSNFV Scenarios 2. Remove ONOSFW links since patch is still not merged in Danube branch. 3. Change Development to Developer in index Change-Id: Ia206a832e46540c08bfc6b577f84fb7c9eb32d68 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-31Final Misc Changs before D1ShubhamRathi1-1/+2
1. Update pharos link in installation 2. Update/ remove projects in config-user guide 3. Update/ remove projects from release notes 4. Update/ remove feature projects 5. Remove warning atop index page Change-Id: I9f685c39a711fdd12ab4c6ce573e03679a0c7a01 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-22Segregating Testing docShubhamRathi1-5/+2
Testing documentation has been segregated under 'User Guides' & 'Developer Guides' as decided by the test teams. Change-Id: I04a11ff88b329f4daad2ef020aefd0779d5a7ca5 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-19Misc ChangesShubhamRathi1-1/+2
1. Renamed ‘How to work with Documentation’ to Documentation Guide 2. Add Test Overview documentation breneath ‘Testing’ 3. Removed the index off Release Notes Change-Id: Iaef364f5ee59a99f906270271c1daf49cfae4c4f Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-14Merge "Add release notes page"Sofia Wallin1-1/+1
2017-03-13Misc ChangesShubhamRathi1-5/+5
1. Testing on index page points to <project>/docs/testing/user/index 2. Update all artifact links to RTD using labels 3. 'OPNFV Userguide' renamed as 'OPNFV User Guide & Config Guide' Change-Id: I47837bac86feba0ae6f319b87315d38b4ef3229e Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-08Add release notes pageShubhamRathi1-1/+1
Added new composite document which shall collate all release notes from projects. This document points to release notes of <project>/docs/release/release-notes/index.rst Change-Id: I5c545b3f7c91012131a4d5eeb73842432ce0a51a Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-02Fixed trailing markupShubhamRathi1-2/+2
Change-Id: I8ce9b278dc3d0d9b376104f753c168ba9a478aa7 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-01Merge "StorPerf Documentation"Sofia Wallin1-0/+2
2017-02-27Misc changesShubhamRathi1-2/+3
1. Added onvo, snaps, barometer submodules 2. Renamed a few titles Change-Id: I8b47e68d64a9a16576abbc2891a39b6dacf164ca Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-23StorPerf Documentationmbeierl1-0/+2
Adds link to StorPerf documentation Change-Id: I7d59478792867e47e7627f203015b9a1d716c404 Signed-off-by: mbeierl <mark.beierl@dell.com>
2017-02-11Added steps to build documentationShubhamRathi1-0/+2
Added steps to build composite & discreet documentation in include-documentation. Added development in progress label atop index. Change-Id: I28526f157a09e10faf17307445c4d90a3903be03 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-31Misc ChangesShubhamRathi1-16/+7
Renamed developer/ to development/ in templates. Corrected chapter level markup in docs/release/ Moved testing above developement in index Change-Id: I950f69bf2ac60e97b260ecfbb4b870a42f8a233b Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-26Removing RTD HackShubhamRathi1-4/+1
Eliminated rm -rf * from conf.py file & time, date of generation from index. Change-Id: I1c2c3da15a11b59659b9fbb46982bf71d7ec2ba9 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-20RTD Workaround to delete old filesShubhamRathi1-1/+4
Workaround to delete old files in RTD: We are callling a subprocess from conf.py file to rm -rf *.The builds on RTD are failing but documentation is being updated nonetheless, to check - we are seeing the build time and date in index. Change-Id: I278490e322e97e263d90f568fe4331bcc40ff4ad Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-14Add index with submodulesShubhamRathi1-28/+31
Index page updated to point to feature, testing and installer projects. This is in tandem with the plan to divide documentation in Release, Developer and Testing. Change-Id: I7e54190d402a6c241a358c9e13ce477d496f23a3 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-11Add submodules and .gitmoduleShubhamRathi1-1/+1
Adding submodules of all OPNFV projects in order to create a unified repository for documentation. By using submodules we will be able to maintain a single conf.py file and theme to be used across all projects Change-Id: I65ec1a85f074f142bc335e8611e9636b5e4cb3a9 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2016-11-24Adjusted the docs repo structure for D release workSofia Wallin1-0/+37
Change-Id: I9befe06c424c726e17d754bc480413b2430549ba Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>