diff options
Diffstat (limited to 'docs/contributing')
| -rw-r--r-- | docs/contributing/development.rst | 10 | ||||
| -rw-r--r-- | docs/contributing/documentation.rst | 50 | ||||
| -rw-r--r-- | docs/contributing/index.rst | 1 |
3 files changed, 5 insertions, 56 deletions
diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst index 7b66b0cc..e59910d5 100644 --- a/docs/contributing/development.rst +++ b/docs/contributing/development.rst @@ -295,7 +295,7 @@ device if you happen to be a crazy scientist. conf = config else: conf = Config() - + # Base path to CLI nodes base = ['...', '...'] # Convert the VyOS config to an abstract internal representation @@ -320,7 +320,7 @@ device if you happen to be a crazy scientist. c = get_config() verify(c) generate(c) - apply(c) + apply(c) except ConfigError as e: print(e) sys.exit(1) @@ -685,9 +685,9 @@ Migrating old CLI Continuous Integration ====================== -VyOS makes use of Jenkins_ as our Continuous Integration (CI) service. Our CI -server is publicly accessible here: https://ci.vyos.net. You can get a brief -overview of all required components shipped in a VyOS ISO. +VyOS makes use of Jenkins_ as our Continuous Integration (CI) service. Our +`VyOS CI`_ server is publicly accessible here: https://ci.vyos.net. You can get +a brief overview of all required components shipped in a VyOS ISO. To build our modules we utilize a CI/CD Pipeline script. Each and every VyOS component comes with it's own ``Jenkinsfile`` which is (more or less) a copy. 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/ diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 481c6da8..a5942f96 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -7,6 +7,5 @@ Contributing build-vyos development - documentation issues-features upstream-packages |