diff options
| author | Ali <fakoor@gmail.com> | 2019-12-31 02:18:23 +0330 |
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2019-12-30 23:48:23 +0100 |
| commit | bd7a52fbcc98ae06568baf1795cd2b7f6ec950a9 (patch) | |
| tree | b92781bf3b47a35e451a51b47445080002dae5f9 /docs/contributing/documentation.rst | |
| parent | 0567858714bc3306ac09aba2c167268a30e29d2b (diff) | |
| download | vyos-documentation-bd7a52fbcc98ae06568baf1795cd2b7f6ec950a9.tar.gz vyos-documentation-bd7a52fbcc98ae06568baf1795cd2b7f6ec950a9.zip | |
documentation: fix contribution guideline typos
Diffstat (limited to 'docs/contributing/documentation.rst')
| -rw-r--r-- | docs/contributing/documentation.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index 5714fb00..2d9f14d1 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -5,12 +5,12 @@ Documentation As most software projects we also have a lack in documentation. We encourage every VyOS user to help us improve our documentation. This will not only be -benefical four you (when reading something up) but also for the whole world. +beneficial for you (when reading something up) but also for the whole world. -If you are willing to contribute to our documentation this is the definate -guid how to do so. +If you are willing to contribute to our documentation this is the definite +guide how to do so. -.. note:: In contrast to submitting code patches there is no requirement that +.. note:: In contrast to submitting code patches, there is no requirement that you open up a Phabricator_ task prior to submitting a Pull-Request to the documentation. @@ -150,9 +150,9 @@ Please don't use other public address space. Custom Sphinx-doc Markup ^^^^^^^^^^^^^^^^^^^^^^^^ -When writing the cducmentation custom commands have been developed. Please -make yourself comfortable with those commands as this eases the way how we -can render the ducumentation. +When writing the documentation custom commands have been developed. Please +make yourself comfortable with those commands as this eases the way we +render the documentation. cfgcmd """""" @@ -184,13 +184,13 @@ descriptive way in the resulting HTML/PDF manual. .. opcmd:: show protocols static arp - Display all known ARP table entries spanning accross all interfaces + Display all known ARP table entries spanning across all interfaces vytask """""" When referencing to VyOS Phabricator Tasks, there is a custom Spinx Markup -command called ``vytask`` which automatically reners to a proper Phabricator +command called ``vytask`` which automatically renders to a proper Phabricator URL. This is heavily used in the :ref:`release-notes` section. .. code-block:: none |