Add incremental RST-to-MyST swap mechanism (#1857)

* feat: add swap_sources.py for incremental RST-to-MyST migration

Pre-build swap/restore script that renames md-{name}.md → {name}.md
before Sphinx builds and restores after. Includes state tracking,
exclude file generation, collision detection, and partial-failure
rollback. 10 tests cover all specified behaviors plus rollback path.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* feat: add import_myst.py for importing MyST files from myst/* branches

Adds scripts/import_myst.py with import_page, git_show, list_myst_files,
list_rst_files, and do_import. Imported files are written as md-{name}.md
alongside existing RST files; importing is decoupled from swap activation.

Adds tests/test_import_myst.py covering single-page write, identical-skip,
warn-on-different-without-force, force-overwrite, and nested-path creation.
All 5 tests pass on Python 3.9.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* feat: add MyST swap exclude patterns and directive config to conf.py

🤖 Generated by [robots](https://vyos.io)

* feat: add swap-wrapped rendering targets to Makefile

🤖 Generated by [robots](https://vyos.io)

* feat: add swap pre/post build hooks for ReadTheDocs

🤖 Generated by [robots](https://vyos.io)

* feat: add empty _swap.txt, remove atexit from swap script

The atexit handler in --swap mode caused immediate restore on process
exit, breaking standalone usage. Makefile trap and RTD post_build
handle restore reliably.

🤖 Generated by [robots](https://vyos.io)

* feat: activate quick-start as MyST canary via swap mechanism

Imports docs/md-quick-start.md from origin/myst/current and adds
quick-start to docs/_swap.txt. Validates the swap pipeline end-to-end
on one page: import_myst pulls the MD via git show, swap_sources
renames md-quick-start.md to quick-start.md, sphinx-build renders
quick-start.html with zero MD-specific warnings, and restore reverses
the rename cleanly.

🤖 Generated by [robots](https://vyos.io)

* feat: activate 106 visual-validated canaries via swap

Imports 105 MD files (plus quick-start already present) from
origin/myst/current and adds them to docs/_swap.txt. The selection
is the BackstopJS visual-passers cohort: pages with <5% rendered
diff vs the live RST docs at docs.vyos.io/en/latest/, filtered to
those with an RST counterpart on current and no cmdincludemd usage
(template-format reconciliation pending).

Local sphinx-build with all 106 swapped: succeeded with 100
warnings (vs 95 baseline). The 5 new warnings are all undefined
cross-reference labels, not build failures:
- contributing/development.md (missing 'coding-guidelines')
- operation/upgrade-recovery.md (3 missing 'how_it_works' /
  'cancelling_recovery')
- vpp/configuration/dataplane/{buffers,memory,unix}.md (missing
  'vpp_config_dataplane_*' labels)

Source list: ~/.claude/projects/-Users-vybot-GitHub-vyos-documentation/docs/2026-04-29-myst-conversion-audit/visual-passers-under-5pct.txt
BackstopJS report: claude/gifted-hertz-74b9f9 worktree
(visual-compare/), 2026-04-23 vs vyos--1838.org.readthedocs.build.

🤖 Generated by [robots](https://vyos.io)

* fix: re-import 4 canary md-*.md files with xref label fixes

Re-imports the dash-form-corrected versions of:
- contributing/md-development.md (added (coding-guidelines)= anchor)
- operation/md-upgrade-recovery.md (3 ref renames: how_it_works /
  cancelling_recovery -> dash form)
- vpp/configuration/dataplane/md-buffers.md (vpp_config_dataplane_physmem
  -> vpp-config-dataplane-physmem)
- vpp/configuration/dataplane/md-unix.md
  (vpp_config_dataplane_interface_rx_mode
  -> vpp-config-dataplane-interface-rx-mode)

Source: origin/myst/current commit 59fbe3ea. Verified locally: clean
swap-build no longer reports any of the 5 target labels (1 of 6 —
vpp-config-hugepages — remains because system.md isn't in the canary
swap list; that anchor lives there).

🤖 Generated by [robots](https://vyos.io)

* fix: re-add 4 canary md-*.md files deleted by 242b334a

Commit 242b334a accidentally staged deletions instead of modifications
because the working tree had unprefixed *.md files left over from an
incomplete swap-restore cycle. Re-imports the same 4 files from
origin/myst/current with the xref label fixes applied:

- contributing/md-development.md       — (coding-guidelines)= anchor
- operation/md-upgrade-recovery.md     — how_it_works → how-it-works,
                                         cancelling_recovery → cancelling-recovery
- vpp/configuration/dataplane/md-buffers.md — vpp_config_dataplane_physmem
                                              → vpp-config-dataplane-physmem
- vpp/configuration/dataplane/md-unix.md   — vpp_config_dataplane_interface_rx_mode
                                              → vpp-config-dataplane-interface-rx-mode

Source: origin/myst/current commit 59fbe3ea.

🤖 Generated by [robots](https://vyos.io)

* fix: resolve remaining xref label gaps in swap-active build

Three small additions clear the cross-reference warnings tied to
underscore-vs-dash label form mismatches and the vpp-config-hugepages
reference that previously needed system.md in the canary set.

- system.rst: add .. _vpp-config-hugepages: alongside the existing
  underscore label so memory.md references resolve regardless of
  whether system.md is swap-active.
- md-lcp.md: add (vpp_config_dataplane_lcp_ignore-kernel-routes)=
  alongside dash form (carries upstream from myst/current 079fa786).
- md-memory.md: add (vpp_config_dataplane_memory)= alongside dash
  form (also from myst/current 079fa786).

Local clean swap-build with 106 canaries:
  before: 305 warnings, 8 undefined-label entries in our scope
  after:  300 warnings, 0 undefined-label entries in our scope

Remaining undefined-label warnings (release-notes, prepare_commit)
are in documentation.rst and unrelated to the canary swap mechanism.

🤖 Generated by [robots](https://vyos.io)

* fix: re-add md-lcp.md and md-memory.md (deleted by 870c9e7e)

Same disaster pattern as 242b334a: a swap-restore cycle left
unprefixed *.md files in the working tree, and the subsequent
git add staged deletions instead of modifications. Restoring the
two affected md-*.md files from origin/myst/current 079fa786
(which has the dual underscore+dash anchors needed for the
swap-active build).

🤖 Generated by [robots](https://vyos.io)

* feat: expand canaries to 114; refresh 3 with cfgcmd body fix

Adds 8 new visual-validated canaries from the post-cfgcmd-fix
BackstopJS run (2026-04-29):

- configuration/policy/as-path-list
- configuration/policy/community-list
- configuration/policy/extcommunity-list
- configuration/policy/large-community-list
- configuration/policy/local-route
- configuration/policy/prefix-list
- configuration/service/salt-minion
- configuration/system/updates

Refreshes 3 existing canaries whose MD content changed via the
cfgcmd/opcmd single-line body fix on myst/current fc19ab5c:

- configuration/firewall/global-options
- configuration/firewall/groups
- configuration/policy/route

All 11 sourced from origin/myst/current. Net: 106 -> 114 canaries.

🤖 Generated by [robots](https://vyos.io)

* fix: re-import md-cloud-init.md (block 3 fix from myst/current)

🤖 Generated by [robots](https://vyos.io)

* feat(swap): import .md files and webp transition from myst/current

Selective import from origin/myst/current (cf9c9b34):
- Add/update 255 .md files (full MyST conversion plus webp ref updates)
- Delete 175 PNG/JPG from docs/_static/images (webp twins already present)
- Delete 5 autotest topology.png (webp twins already present)

Preserved on swap (untouched):
- All .rst files (incremental swap pattern)
- conf.py, _ext/, _include/*.txt, .gitignore
- 115 canary md-*.md files
- 7 superpowers/specs/*.md design docs
- Logos vyos-logo.png / vyos-logo-icon.png (referenced by conf.py)

🤖 Generated by [robots](https://vyos.io)

* chore(swap): remove canary md-*.md files and docs/superpowers

- Remove 115 canary md-*.md files (incremental swap helpers no longer needed)
- Remove 8 files under docs/superpowers (project planning/design docs that
  shouldn't ship in the documentation tree)

🤖 Generated by [robots](https://vyos.io)

* docs: address Copilot review feedback on imported MyST pages

Fix issues flagged by Copilot review on PR #1857 (the same content lives
in myst/current as the canonical source):

Real bugs:
- site-2-site-cisco.md: replace curly quote (U+2019) with ASCII apostrophe
- rsa-keys.md: fix typo "key-pair nam>>" → "key-pair name>"
- vmware.md: lowercase admonition directive (:::{NOTE} → :::{note})
- vpp/configuration/nat/index.md: remove blank line inside {include} fence

Grammar:
- vpp/configuration/interfaces/loopback.md: "bounded" → "bound"
- vpp/configuration/sflow.md: "VyOS support" → "VyOS supports"
- vpp/requirements.md: "bypass" → "bypasses"
- vpp/configuration/dataplane/interface.md: "configures" → "configure"

CI linter (IP addresses):
- nmp.md: wrap 8.8.8.8 example with stop/start_vyoslinter
- lac-lns.md: wrap LNS config block (contains 8.8.8.8)
- wan-load-balancing.md: wrap whole file (illustrative non-RFC IPs)
- policy/examples.md: replace 192.0.1.1 with RFC 5737 192.0.2.1

🤖 Generated by [robots](https://vyos.io)

* fix(swap): address Copilot review feedback on swap infrastructure

Category D — drop obsolete canary mechanism settings:
- conf.py: remove '**/md-*.md' from exclude_patterns (no canaries left)
- Makefile: replace malformed '*/_build/*' with '$(BUILDDIR)/**' and drop
  the '*/md-*' ignore (canary files no longer exist)

Category C — script robustness:
- import_myst.py:
  * list_myst_files() now raises SystemExit on git ls-tree failure instead
    of silently returning [] (would have masked typo'd --source refs)
  * list_rst_files() skips _build/ when scanning for .rst stems
  * import_page() rejects stems containing '..' or absolute paths and
    re-checks that the resolved destination stays under docs_dir
  * --dry-run uses a separate "would_import" counter; summary line now
    distinguishes dry-run from actual imports
- swap_sources.py:
  * parse_swap_list() reads with explicit encoding='utf-8'
  * do_restore() validates state file version + entry shape before
    renaming files; raises with actionable message on corruption
  * State file reads/writes use explicit encoding='utf-8' throughout

_swap.txt:
- Wrap long comment line to satisfy 80-character doc-linter limit

🤖 Generated by [robots](https://vyos.io)

* refactor(swap): rename imported .md files to md- prefix for swap mechanism

Restore the canary file naming convention that swap_sources.py expects:
the imported MyST pages now live as docs/<dir>/md-<name>.md alongside
the existing docs/<dir>/<name>.rst, so swap_sources.py --swap can rename
them into place at build time.

- 254 .md files renamed (every page with a matching .rst counterpart)
- 2 MyST-only pages left at their final names (no .rst exists, no swap
  needed): docs/copyright.md, docs/automation/terraform/terraformvyos.md

All 114 stems listed in docs/_swap.txt now have a corresponding
md-<name>.md source file ready to swap in.

🤖 Generated by [robots](https://vyos.io)

* docs: address CodeRabbit review feedback on imported MyST pages

Fix issues flagged by CodeRabbit on PR #1857. All issues are pre-existing
in the upstream RST docs and inherited by the MyST conversion.

Real bugs:
- inter-vrf-routing-vrf-lite.md: invalid IPv6 next-hop "2001:db8::*" →
  "2001:db8::1"
- ipsec-pa-route-based.md: vendor mislabel "Cisco" → "Palo Alto"
  (header on line 39 and "Monitoring on Cisco side" section heading)
- bgp-ipv6-unnumbered.md: AS number mismatch between configuration and
  verification output for both routers (Router A: 65020 → 64496;
  Router B: 65021 → 64499)
- qos.md: class 30 used "match ADDRESS20" instead of ADDRESS30 — broke
  the documented pattern (classes 10/20/30 → ADDRESS10/20/30)

Security:
- OpenVPN_with_LDAP.md: redact full PEM private key material from the
  three "set pki ... private key '...'" lines and from the embedded
  OpenVPN client <key> block; replace with <REDACTED> / ...REDACTED...
  placeholders. Public certificates retained.

🤖 Generated by [robots](https://vyos.io)

* feat(swap): default to serving MyST for all swapped pages

Replace the previously-curated 114-stem _swap.txt with the full set of
254 imported md-prefixed pages, so MD is served by default at build
time. To revert any specific page back to RST, remove its stem from
_swap.txt (or comment it out).

🤖 Generated by [robots](https://vyos.io)

* fix(ext): handle RST fallback in CmdInclude when _renderer absent

`cmdincludemd` is in `myst_fence_as_directive`, so MyST routes
fence blocks through `render_fence → render_restructuredtext →
MockRSTParser`. In that path `self.state` is a plain docutils Body
with no `_renderer`, crashing the build.

Fall back to `nested_parse` when `_renderer` is unavailable so the
directive works in both MyST and RST/MockRSTParser contexts.

🤖 Generated by [robots](https://vyos.io)

* feat(conf): copy .md sources into HTML output for plain-text serving

Adds a build-finished hook that mirrors every .md file from the Sphinx
source tree into the HTML output directory verbatim, making unrendered
MyST sources accessible alongside HTML renders at the same URL path.

🤖 Generated by [robots](https://vyos.io)

* docs: address review feedback from PR #1857

Fix conversion artifacts, typos, grammar errors, and technical
inaccuracies flagged by automated code review (Copilot + CodeRabbit).

Infrastructure: add root-level md-*.md exclusion to conf.py,
fix sphinx-autobuild ignore globs in Makefile.

Content: fix curly quotes, invalid Go panic() calls, shell quoting
in cURL examples, incorrect firewall command paths, typos across
22 documentation files, remove duplicate sections.

🤖 Generated by [robots](https://vyos.io)

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

1 files changed, 442 insertions, 0 deletions

diff --git a/docs/md-documentation.md b/docs/md-documentation.md
new file mode 100644
index 00000000..6a25a413
--- /dev/null
+++ b/docs/md-documentation.md
@@ -0,0 +1,442 @@
+---
+lastproofread: '2021-06-25'
+---
+
+(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
+but also everyone else.
+
+:::{warning}
+Please read and sign the
+{doc}`Contributor License Agreement<contributing/cla>` before submitting any
+documentation updates.
+:::
+
+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
+you open up a [Phabricator](https://vyos.dev/) task prior to submitting a Pull-Request to the
+documentation.
+:::
+
+VyOS documentation is written in reStructuredText and generated to Read the Docs
+pages with Sphinx, as per the Python tradition. We welcome all sorts of
+contributions to the documentation.
+Not just new additions but also corrections to existing documentation.
+
+The documentation source is kept in the Git repository at
+<https://github.com/vyos/vyos-documentation> and you can follow the instructions
+in the [README.md] to build and test your changes.
+
+You can either install Sphinx and build the documentation locally,
+or use the [Dockerfile] to build it in a container.
+
+## Guidelines
+
+There are a few things to keep in mind when contributing to the
+documentation, for the sake of consistency and readability.
+
+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.
+
+## Page content
+
+All RST files must follow the same TOC Level syntax and have to start with
+
+```{eval-rst}
+.. code-block::
+
+   #####
+   Title
+   #####
+```
+
+The configuration mode folder and the articles cover the specific level of
+the commands. The exact level depends on the command. This should provide
+stability for URLs used in the forum or blogpost.
+
+For example:
+
+> - `set firewall zone` is written in `firewall/zone.rst`
+> - `set interfaces ethernet` is written in `interfaces/ethernet.rst`
+
+In the configuration part of the page, all possible configuration options
+should be documented. Use `.. cfgcmd::` described above.
+
+Related operation command must be documented in the next part of the article.
+Use `::opcmd..` for these commands.
+
+Each page must contain the following parts:
+
+### 1. Theoretical information
+
+Theoretical information required for users to understand the next document sections:
+
+> - a simple explanation of what is this page about, why or when it is required to be used
+> - references to standards, RFCs
+
+### 2. Configuration description
+
+> Describe CLI items related to the service or use case. Each config line
+> or section must be explained, using information provided in the 1st part
+> of the page.
+
+### 3. Configuration examples
+
+> Practical examples of the service or use case configuration. They must
+> contain topology maps (if applicable) and short descriptions.
+
+### 4. Known issues
+
+This section must contain a list of:
+
+> - known issues or potential problems for the service or use case
+> - workarounds for known issues (if any exist)
+
+### 5. Debugging
+
+Described procedures for debugging a service:
+
+> - how to collect logs or other debugging information (like `show` commands output)
+> - how to read and what to search for in logs and collected information
+> - what are indicators of good and bad states in debugging outputs
+
+## Style Guide
+
+### Formatting and Sphinxmarkup
+
+#### TOC Level
+
+We use the following syntax for Headlines.
+
+```none
+#####
+Title
+#####
+
+********
+Chapters
+********
+
+Sections
+========
+
+Subsections
+-----------
+
+Subsubsections
+^^^^^^^^^^^^^^
+
+Paragraphs
+""""""""""
+```
+
+
+#### Cross-References
+
+A plugin will be used to generate a reference label for each headline.
+To reference a page or a section in the documentation use the
+`{ref}` command.
+
+For example, you want to reference the headline **VLAN** in the
+**ethernet.rst** page. The plugin generates the label based on
+the headline and the file path.
+
+`` {ref}`configuration/interfaces/ethernet:vlan ``
+
+to use an alternative hyperlink use it this way:
+
+`` {ref}`Check out VLAN<configuration/interfaces/ethernet:vlan> ``
+
+##### handle build errors
+
+The plugin will warn on build if a headline has a duplicate name in the
+same document. To prevent this warning, you have to put a custom link on
+top of the headline.
+
+```none
+Section A
+==========
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr
+
+Example
+-------
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr
+
+Section B
+==========
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr
+
+.. _section B example:
+
+Example
+-------
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr
+```
+
+
+#### Address space
+
+Note the following RFCs ({rfc}`5737`, {rfc}`3849`, {rfc}`5389` and
+{rfc}`7042`), which describe the reserved public IP addresses and autonomous
+system numbers for the documentation:
+
+> - `192.0.2.0/24`
+> - `198.51.100.0/24`
+> - `203.0.113.0/24`
+> - `2001:db8::/32`
+> - 16bit ASN: `64496 - 64511`
+> - 32bit ASN: `65536 - 65551`
+> - Unicast MAC Addresses: `00-53-00` to `00-53-FF`
+> - Multicast MAC-Addresses: `90-10-00` to `90-10-FF`
+
+Please do not use other public address space.
+
+#### Line length
+
+Limit all lines to a maximum of 80 characters.
+
+Except in `.. code-block::` because it uses the html tag `<pre>` and
+renders the same line format from the source rst file.
+
+#### Autolinter
+
+Each GitHub pull request is automatically linted to check the address space and
+line length.
+
+Sometimes it is necessary to provide real IP addresses like in the
+{ref}`examples`. For this, please use the sphinx comment syntax
+`.. stop_vyoslinter` to stop the linter and `.. start_vyoslinter` to start.
+
+#### Custom Sphinx-doc Markup
+
+Custom commands have been developed for writing the documentation. Please
+make yourself comfortable with those commands as this eases the way we
+render the documentation.
+
+##### cfgcmd
+
+When documenting CLI commands, use the ``.. cfgcmd::`` directive
+for all configuration mode commands. An explanation of the described command
+should be added below this statement.
+Replace all variable contents with \<value> or something similar.
+
+With those custom commands, it will be possible to render them in a more
+descriptive way in the resulting HTML/PDF manual.
+
+```none
+.. cfgcmd:: protocols static arp <ipaddress> hwaddr <macaddress>
+
+   This will configure a static ARP entry, always resolving `192.0.2.100` to
+   `00:53:27:de:23:aa`.
+```
+
+For an inline configuration level command, use ``:cfgcmd:``
+
+```none
+:cfgcmd:`set interface ethernet eth0`
+```
+
+
+To extract a defaultvalue from the XML definitions add a ``:defaultvalue:``
+to ``.. cfgcmd::`` directive.
+To have this feature locally, the vyos-1x submodule must be initialized before.
+Please be aware to not update the submodule in your PR.
+
+```none
+.. cfgcmd:: set system conntrack table-size <1-50000000>
+    :defaultvalue:
+
+    The connection tracking table contains one entry for each connection being
+    tracked by the system.
+```
+
+
+##### opcmd
+
+When documenting operational level commands, use the ``.. opcmd::`` directive.
+An explanation of the described command should be added below this statement.
+
+With those custom commands, it is possible to render them in a more
+descriptive way in the resulting HTML/PDF manual.
+
+```none
+.. opcmd:: show protocols static arp
+
+   Display all known ARP table entries spanning across all interfaces
+```
+
+For an inline operational level command, use ``:opcmd:``
+
+```none
+:opcmd:`add system image`
+```
+
+##### cmdinclude
+
+To minimize redundancy, there is a special include directive. It includes a txt
+file and replace the `{{ var0 }}` - `{{ var9 }}` with the correct value.
+
+```none
+.. cmdinclude:: /_include/interface-address.txt
+   :var0: ethernet
+   :var1: eth1
+```
+
+the content of interface-address.txt looks like this
+
+```none
+.. cfgcmd:: set interfaces {{ var0 }} <interface> address <address | dhcp |
+   dhcpv6>
+
+   Configure interface `<interface>` with one or more interface
+   addresses.
+
+   * **address** can be specified multiple times as IPv4 and/or IPv6
+   address, e.g. 192.0.2.1/24 and/or 2001:db8::1/64
+   * **dhcp** interface address is received by DHCP from a DHCP server
+   on this segment.
+   * **dhcpv6** interface address is received by DHCPv6 from a DHCPv6
+   server on this segment.
+
+   Example:
+
+   .. code-block:: none
+
+      set interfaces {{ var0 }} {{ var1 }} address 192.0.2.1/24
+      set interfaces {{ var0 }} {{ var1 }} address 192.0.2.2/24
+      set interfaces {{ var0 }} {{ var1 }} address 2001:db8::ffff/64
+      set interfaces {{ var0 }} {{ var1 }} address 2001:db8:100::ffff/64
+```
+##### vytask
+
+When referencing to VyOS Phabricator Tasks, there is a custom Sphinx Markup
+command called `vytask` that automatically renders to a proper Phabricator
+URL. This is heavily used in the {ref}`release-notes` section.
+
+```none
+* {vytask}`T1605` Fixed regression in L2TP/IPsec server
+* {vytask}`T1613` Netflow/sFlow captures IPv6 traffic correctly
+```
+
+## Forking Workflow
+
+The Forking Workflow is fundamentally different from other popular Git
+workflows. Instead of using a single server-side repository to act as the
+"central" codebase, it gives every developer their own server-side repository.
+This means that each contributor has not one, but two Git repositories: a
+private local one and a public server-side one.
+
+The main advantage of the Forking Workflow is that contributions can be
+integrated without the need for everybody to push to a single central
+repository. Developers push to their own server-side repositories, and only the
+project maintainer can push to the official repository. This allows the
+maintainer to accept commits from any developer without giving them write
+access to the official codebase.
+
+:::{note}
+Updates to our documentation should be delivered by a GitHub
+pull-request. This requires you already have a GitHub account.
+:::
+
+
+- Fork this project on GitHub <https://github.com/vyos/vyos-documentation/fork>
+
+- Clone fork to local machine, then change to that directory
+  `$ cd vyos-documentation`
+
+- Install the requirements `$ pip install -r requirements.txt`
+  (or something similar)
+
+- Create a new branch for your work, use a descriptive name of your work:
+  `$ git checkout -b <branch-name>`
+
+- Make all your changes - please keep our commit rules in mind
+  ({ref}`prepare_commit`). This mainly applies to proper commit messages
+  describing your change (how and why). Please check out the documentation of
+  [Sphinx-doc] or [reStructuredText] if you are not familiar with it. This is used
+  for writing our docs. Additional directives how to write in RST can be
+  obtained from [reStructuredTextDirectives].
+
+- Check your changes by locally building the documentation `$ make livehtml`.
+  Sphinx will build the html files in the `docs/_build` folder. We provide
+  you with a Docker container for an easy-to-use user experience. Check the
+  [README.md] file of this repository.
+
+- View modified files by calling `$ git status`. You will get an overview of
+  all files modified by you. You can add individual files to the Git Index in
+  the next step.
+
+- Add modified files to Git index `$ git add path/to/filename` or add all
+  unstaged files `$ git add .`. All files added to the Git index will be part
+  of you following Git commit.
+
+- Commit your changes with the message, `$ git commit -m "<commit message>"`
+  or use `$ git commit -v` to have your configured editor launched. You can
+  type in a commit message. Again please make yourself comfortable without
+  rules ({ref}`prepare_commit`).
+
+- Push commits to your GitHub project: `$ git push -u origin <branch-name>`
+
+- Submit pull-request. In GitHub visit the main repository and you should
+  see a banner suggesting to make a pull request. Fill out the form and
+  describe what you do.
+
+- Once pull requests have been approved, you may want to locally update
+  your forked repository too. First you'll have to add a second remote
+  called `upstream` which points to our main repository. `$ git remote add
+  upstream https://github.com/vyos/vyos-documentation.git`
+
+  Check your configured remote repositories:
+
+  ```none
+  $ git remote -v
+  origin    https://github.com/<username>/vyos-documentation.git (fetch)
+  origin    https://github.com/<username>/vyos.documentation.git (push)
+  upstream  https://github.com/vyos/vyos-documentation.git (fetch)
+  upstream  https://github.com/vyos/vyos-documentation.git (push)
+
+  ```
+
+  Your remote repo on Github is called `origin`, while the original repo you
+  have forked is called `upstream`. Now you can locally update your forked
+  repo.
+
+  ```none
+  $ git fetch upstream
+  $ git checkout current
+  $ git merge upstream/current
+```
+
+- If you also want to update your fork on GitHub, use the following: `$ git
+  push origin current`
+
+[dockerfile]: https://github.com/vyos/vyos-documentation/blob/current/docker/Dockerfile
+[grammarly]: https://www.grammarly.com/
+[readme.md]: https://github.com/vyos/vyos-documentation/blob/current/README.md
+[restructuredtext]: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
+[restructuredtextdirectives]: https://docutils.sourceforge.io/docs/ref/rst/directives.html
+[sphinx-doc]: https://www.sphinx-doc.org