Age | Commit message (Collapse) | Author | Files | Lines |
|
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
|
|
- 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>
|
|
Updates on the guide guide according to new
document structure approved by the TSC.
Change-Id: I321dd2f243f958e14e4d0434add76c4fc13fdb74
Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
|
|
Software and Hardware Infrastructure documentation will be contained in
the infrastructure/overview document.
The 'template' structure included the infrastructure section from
opnfvdocs, which doesn't actually exist in the templates directory.
Change-Id: I6b05771eafb7ed2ca9715a4786967d50b3dd04e2
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
|
|
Deleted the submodule transition section. Add local
build and setting up CI jobs is covered in the LFN documentation
guide linked in the getting started section.
Change-Id: Ie37e32a44b7f83b6b1f0b8274fd77a891ea56844
Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
|
|
Change-Id: I6f599945839e69a64616f1b29c4df02729a83f0c
Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
|
|
Removed old/outdated content
Added link to the LFN doc guide
Change-Id: Ifb0f2fa77f328ccf29c2df610e73b1999822f20f
Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
|
|
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>
|
|
|
|
- add linter whitelist for unused includes in conf.py template;
- remove duplicate git module entry;
Change-Id: I88b7cd77a09ed7f4c19b4c277e5642185e830e0b
Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
|
|
Adding missing step in the submodule transition
Change-Id: Ibfbe1993c78183f73d1cd061559e62dd60237df5
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
|
|
|
|
Adds headers for each section, updates the jobs config needed for
projects, adds an example for updating references in opnfvdocs, and
clarifies a few changes such as where the intersphinx link should go.
Change-Id: I9b1c09bdc5df776e36f0f14bc80d19dd3f8c679e
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
|
|
Change-Id: I489daaa1c5736948277629a852e0351898ee5742
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
|
|
These changes will hopefully make it clearer to people working on
transitioning their docs over.
Change-Id: I6f9857e53b5981fde4286f1208363a004c7bcbf9
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
|
|
Adds documentation for current projects on how to migrate to using local
doc builds, along with steps for new projects to setup their builds.
Issue: DOCS-191
Change-Id: I1c850457dec1006199d095ad63469af1ca02a760
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
|
|
Change-Id: I4d8ed269cbf0eeedaa0ee540ac2fd6bca5e429b0
Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
|
|
|
|
Change-Id: Ic2ff79ef9d9937466183bfeacc9fec92116dca02
Signed-off-by: agardner <agardner@linuxfoundation.org>
|
|
This change proposes addition of infrastructure to OPNFV Documentation
on RTD.
Proposed sections are
- software-infrastructure: proposal to move documentation for OPNFV
software infrastructure such as Gerrit, Artifact Repository, Jenkins, and
so on, from OPNFV Wiki [1] to RTD.
- continuous-integration: proposal to move documentation for OPNFV
Continuous Integration from OPNFV Wiki [2] to RTD.
- cross-community-continuous-integration: proposal to move documentation
for OPNFV XCI from OPNFV Wiki [3] to RTD.
Proposal for including the documentation for hardware infrastructure is not
included in this change as there is already documentation in different place
on RTD. It will be clarified later.
[1] https://wiki.opnfv.org/display/INF/Software+Infrastructure
[2] https://wiki.opnfv.org/display/INF/Continuous+Integration
[3] https://wiki.opnfv.org/pages/viewpage.action?pageId=8687635
Change-Id: I4f22d9f22135c70b55b5e92aa3338a4c3889bee1
Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
|
|
Note: This PS also solve a trivial doc8 error below:
Warning: rst validation (doc8) has failed, please fix the following error(s).
docs/how-to-use-docs/addendum.rst:79: D005 No newline at end of file
Change-Id: Ia1d677e8f893b1e228962e35d6b0da4a185db676
Signed-off-by: Zhijiang Hu <hu.zhijiang@zte.com.cn>
|
|
Change-Id: If6ea180c77e24ed07eb66ffdc92067e25c8144b3
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
|
|
Added the SPDX license according to recommendation from LF.
Change-Id: Ic0fbdde46d28ef6bfe8ccf975572403d0356e170
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
|
|
document how to add submodules
clean up some spacing
Change-Id: I7640f123911650dcf31933ed2fbfbdd26620798a
Signed-off-by: agardner <agardner@linuxfoundation.org>
|
|
1. Add sidebar akin to ODL
2. Remove redundant 'OPNFV' from all
composite document titles
3. Edit documentation-example for the
updated toolchain. Renamed this file as
'addendum.rst'. Eliminated obsolete content.
4. Listed test projects in alphabetic order
Change-Id: Ica1c4aa89e3c8f8bcb960fcd4574971960dc52dc
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
|
|
Change-Id: I1b543c7f6236d72e627a0bebe174f915f607d907
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
|
|
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>
|
|
Updated structure for test docs
Updates done according to agreement with test projects.
Change-Id: I2f9b5783ef4e42fd26b357e0aad2e187bcf61777
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
|
|
The directory layout diagram in the documentation guide showed a
"developer" directory instead of "development".
Change-Id: Ie056a47ebcca65d5307d35543009bfb9c6d0a335
Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
|
|
1. Added note about eliminating conf.py etc
from include-documentation.
2. Eliminated content about enabling toolchain
since its irrelevant after migration to RTD
3. Added steps to validate using doc8
4. Populated index page.
Change-Id: I80c8354fd4da4bca0b8f338c178f0773d834b6ee
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
|
|
|
|
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>
|
|
Edited content to enforce the new changes.
Added label to include-documentation.rst file
which is referenced from the documentation guide.
Change-Id: I6e81288062716231ece5934a0be934ed0dbb60dc
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
|
|
This documentation elucidates the revised procedure
to include project documentation.
Change-Id: Icfcab3a07e386453ae7faf9fa737fe726ff70f0c
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
|
|
Moving all content out of the wiki,
plan is to keep document build instructions
in the opnfvdocs repo too. This file shall be
edited with the new instruction.
Change-Id: Ie2e441be1810182c101bd3819ddc6587e1c6b2c2
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
|
|
This patch also adds description of html_sidebars in how-to doc.
Change-Id: I904ceca3847a085754aacc8d0d0a388f2606c880
JIRA: DOCS-156
Co-Authored-By: Aric Gardner <agardner@linuxfoundation.org>
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
Change-Id: I58fd9e9382932ebc2521765bb665dcf0473d6a68
JIRA: DOCS-152
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
- execute pre-hook after required python package installed
- remove execution flag of docs/pre-hook.sh as it's unnecessary
- add howto document regarding 'Hooks'
Change-Id: Ib94888b018347ce8660d53db93dba3586c098948
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
A developer was asked to copy all contents in the base config file in
order to set all parameters properly, even if the change is partial.
This patch improves this config by setting all default parameters based
on users' custom config file, so that they can write parameters just
which they want to change.
Change-Id: Ide459c8e9f416b29b114a4bf2a432e8eae1f841e
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
JIRA: DOCS-153
Change-Id: I568192dbb6653eb8fd8518abebf3558dc00dcee8
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
Change-Id: I48b4017c5fb012c7119b0685a71320c518694815
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
|
|
I have removed it from the releng repo
This documentation on how to use the document tool chain
belongs in opnfv-docs
Change-Id: Iad621b394f03511649a1edc21501ca524f0506e4
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
|