summaryrefslogtreecommitdiff
path: root/docs/contributing/documentation.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2021-08-16 12:03:34 +0200
committerChristian Poessinger <christian@poessinger.com>2021-08-16 12:05:40 +0200
commit7b5ece6880c87e665ba61ee840466bade4b1fbe5 (patch)
tree25d342c27ba061de96150e12265c2114b842d9e7 /docs/contributing/documentation.rst
parent0a3b780c296c13d485a43a5ba2e1c2005d19d678 (diff)
downloadvyos-documentation-7b5ece6880c87e665ba61ee840466bade4b1fbe5.tar.gz
vyos-documentation-7b5ece6880c87e665ba61ee840466bade4b1fbe5.zip
Merge contribution documentation and documentation chapter
(cherry picked from commit 848c538299fe0098166e052d3238caff60a61915)
Diffstat (limited to 'docs/contributing/documentation.rst')
-rw-r--r--docs/contributing/documentation.rst50
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst
deleted file mode 100644
index eb8db3e1..00000000
--- a/docs/contributing/documentation.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-.. _contrib-documentation:
-
-Documentation
--------------
-
-VyOS documentation is written in reStructuredText and generated to Read the Docs
-pages with Sphinx, as per the Python tradition, as well as PDF files for offline
-use through LaTeX.
-
-We welcome all sorts of contributions to the documentation. Not just
-new additions but also corrections to existing documentation.
-
-Guidelines
-^^^^^^^^^^
-
-There are a few things to keep in mind when contributing to the
-documentation, for the sake of consistency and readability.
-
-Take a look at the :doc:`/documentation` page for an intricate explanation
-of the documentation process.
-
-The following is a quick summary of the rules:
-
-- Use American English at all times. It's always a good idea to run
- your text through a grammar and spell checker, such as `Grammarly`_.
-- Don't forget to update ``index.rst`` when adding a new node.
-- Try not to exceed 80 characters per line, but don't break URLs over this.
-- Properly quote commands, filenames and brief code snippets with double backticks.
-- Use literal blocks for longer snippets.
-- Leave a newline before and after a header.
-- Indent with two spaces.
-- When in doubt, follow the style of existing documentation.
-
-And finally, remember that the reStructuredText files aren't
-exclusively for generating HTML and PDF. They should be human-readable
-and easily perused from a console.
-
-Building
-^^^^^^^^
-
-The source is kept in the Git repository
-https://github.com/vyos/vyos-documentation
-
-You can follow the instructions in the README to build and test your changes.
-
-You can either install Sphinx (and TeX Live for PDF output) and build the
-documentation locally, or use the `Dockerfile`_ to build it in a container.
-
-.. _Dockerfile: https://github.com/vyos/vyos-documentation/blob/master/docker/Dockerfile
-.. _Grammarly: https://www.grammarly.com/