diff options
| author | rebortg <github@ghlr.de> | 2021-09-13 19:45:06 +0200 |
|---|---|---|
| committer | rebortg <github@ghlr.de> | 2021-09-13 19:45:06 +0200 |
| commit | e8bd02d5f8018698f656ce7a176157efdaac8c60 (patch) | |
| tree | 77bb8a28aa5c953421b3fe1f68c746726f532bcb | |
| parent | c2c50708ba9dcc2f86e1baec5931fd0809fd780e (diff) | |
| download | vyos-documentation-e8bd02d5f8018698f656ce7a176157efdaac8c60.tar.gz vyos-documentation-e8bd02d5f8018698f656ce7a176157efdaac8c60.zip | |
contributing: clear structure
| -rw-r--r-- | docs/contributing/debugging.rst (renamed from docs/debugging.rst) | 5 | ||||
| -rw-r--r-- | docs/contributing/index.rst | 11 | ||||
| -rw-r--r-- | docs/contributing/testing.rst (renamed from docs/testing.rst) | 0 | ||||
| -rw-r--r-- | docs/documentation.rst | 6 | ||||
| -rw-r--r-- | docs/index.rst | 16 |
5 files changed, 16 insertions, 22 deletions
diff --git a/docs/debugging.rst b/docs/contributing/debugging.rst index 5a25639d..fec73257 100644 --- a/docs/debugging.rst +++ b/docs/contributing/debugging.rst @@ -29,11 +29,6 @@ Kernel an unexpected delay during manual or boot commit, this may be useful in identifying bottlenecks. The internal flag is ``VYOS_DEBUG``, and is found in vyatta-cfg_. Output is directed to ``/var/log/vyatta/cfg-stdout.log``. - - In addition this setting creates the runtime debug files for some Live system - components (see below). Those files are: ``/tmp/vyos-config-status``, - ``/tmp/vyos.container.debug``, ``/tmp/vyos.frr.debug``, - ``/tmp/vyos.ifconfig.debug``. * ``vyos-config-debug`` - During development, coding errors can lead to a commit failure on boot, possibly resulting in a failed initialization of the diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst deleted file mode 100644 index a5942f96..00000000 --- a/docs/contributing/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -############ -Contributing -############ - -.. toctree:: - :maxdepth: 2 - - build-vyos - development - issues-features - upstream-packages diff --git a/docs/testing.rst b/docs/contributing/testing.rst index d5df9d59..d5df9d59 100644 --- a/docs/testing.rst +++ b/docs/contributing/testing.rst diff --git a/docs/documentation.rst b/docs/documentation.rst index f3103f94..00db6e56 100644 --- a/docs/documentation.rst +++ b/docs/documentation.rst @@ -2,9 +2,9 @@ .. _documentation: -############# -Documentation -############# +################### +Write Documentation +################### We encourage every VyOS user to help us improve our documentation as we have a deficit like most software projects. This not only helps you when reading diff --git a/docs/index.rst b/docs/index.rst index f81adfc8..f4c562d1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -39,9 +39,19 @@ VyOS User Guide :includehidden: :caption: Development - contributing/index - debugging - testing + contributing/build-vyos + contributing/development + contributing/issues-features + contributing/upstream-packages + contributing/debugging + contributing/testing + + +.. toctree:: + :maxdepth: 2 + :includehidden: + :caption: Misc + documentation coverage copyright |