diff options
| author |   Sofia Wallin <sofia.wallin@est.tech> | 2020-09-09 10:49:38 +0200 |
|---|---|---|
| committer | Sofia Wallin <sofia.wallin@est.tech> | 2020-09-09 10:49:38 +0200 |
| commit | c9ac0f955cf72a189a0b2c10f003d3973d56a6fc (patch) | |
| tree | 6a56bf9fb1d75c47ba85171b431f1572691b2d1f /docs/how-to-use-docs/documentation-guide.rst | |
| parent | 76ffa4a5013fd503a64fbcf013083355a0c9e5ef (diff) | |
Update: documentation guide
Removed old/outdated content
Added link to the LFN doc guide
Change-Id: Ifb0f2fa77f328ccf29c2df610e73b1999822f20f
Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
Diffstat (limited to 'docs/how-to-use-docs/documentation-guide.rst')
| -rw-r--r-- | docs/how-to-use-docs/documentation-guide.rst | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/how-to-use-docs/documentation-guide.rst index 9315a47b1..59a54253b 100644 --- a/docs/how-to-use-docs/documentation-guide.rst +++ b/docs/how-to-use-docs/documentation-guide.rst @@ -15,14 +15,18 @@ Getting Started with Documentation for Your Project OPNFV documentation is automated and integrated into our git & gerrit toolchains. We use RST document templates in our repositories and automatically render to HTML and PDF versions of the documents in our artifact -store, our Wiki is also able to integrate these rendered documents directly allowing projects to use the revision controlled documentation +store, our Wiki is also able to integrate these rendered documents directly allowing projects to use the revision controlled +documentation process for project information, content and deliverables. -Read :ref:`this page <include-documentation>` which elaborates on how documentation is to be included within opnfvdocs. +The `LFN documenatation guide <https://docs.releng.linuxfoundation.org/en/latest/project-documentation.html>` explains how to enable +your documenation build. Licencing your documentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -All contributions to the OPNFV project are done in accordance with the OPNFV licensing requirements. Documentation in OPNFV is contributed -in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_ and the `SPDX <https://spdx.org/>`_ licence. +All contributions to the OPNFV project are done in accordance with the OPNFV licensing requirements. Documentation in OPNFV is +contributed +in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_ and the `SPDX <https://spdx.org/>`_ +licence. All documentation files need to be licensed using the text below. The license may be applied in the first lines of all contributed RST files: |