summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authormergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2026-05-14 05:06:02 +0000
committerGitHub <noreply@github.com>2026-05-14 05:06:02 +0000
commitf26533d4f878c9faaeccbc4d07cb370d8c585297 (patch)
treebe018e3ca67bf1212ada6cac3b8d75816fad322c /docs/contributing
parent90f7c6527c98a147b6cf54d801d100a1cee5b4b9 (diff)
parente2f7627157009694eb6b155b175ed109d6bdad22 (diff)
downloadvyos-documentation-f26533d4f878c9faaeccbc4d07cb370d8c585297.tar.gz
vyos-documentation-f26533d4f878c9faaeccbc4d07cb370d8c585297.zip
Merge pull request #2040 from vyos/yuriy/common-references-cleanup-sagitta
docs: drop unused {include} of _include/common-references.txt from 11 sagitta MD pages + rewrap long lines
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/debugging.md6
-rw-r--r--docs/contributing/development.md19
-rw-r--r--docs/contributing/issues-features.md2
-rw-r--r--docs/contributing/testing.md13
4 files changed, 20 insertions, 20 deletions
diff --git a/docs/contributing/debugging.md b/docs/contributing/debugging.md
index 73b622c6..4671c748 100644
--- a/docs/contributing/debugging.md
+++ b/docs/contributing/debugging.md
@@ -183,9 +183,7 @@ you can use the `/opt/vyatta/sbin/priority.pl` script which lists to you
the execution order of the scripts.
-```{include} /_include/common-references.txt
-```
-
-
+% stop_vyoslinter
[bootchart.conf]: https://github.com/vyos/vyos-build/blob/current/data/live-build-config/includes.chroot/etc/systemd/bootchart.conf
+% start_vyoslinter
[vyatta-cfg]: https://github.com/vyos/vyatta-cfg
diff --git a/docs/contributing/development.md b/docs/contributing/development.md
index dcfe257a..42a1bb97 100644
--- a/docs/contributing/development.md
+++ b/docs/contributing/development.md
@@ -99,7 +99,8 @@ It is also worth reading <https://chris.beams.io/posts/git-commit/>
Limits:
-- We only accept bugfixes in packages other than <https://github.com/vyos/vyos-1x>
+- We only accept bugfixes in packages other than
+ <https://github.com/vyos/vyos-1x>
as no new functionality should use the old style templates (`node.def` and
Perl/BASH code. Use the new style XML/Python interface instead.
@@ -158,8 +159,8 @@ record them in your created Git commit:
Follow the above steps on how to "Fork repository to submit a Patch". Instead
of uploading "pushing" your changes to GitHub you can export the patches/
-commits and send it to <mailto:maintainers@vyos.net> or attach it directly to the bug
-(preferred over email)
+commits and send it to <mailto:maintainers@vyos.net> or attach it
+directly to the bug (preferred over email)
- Export last commit to patch file: `git format-patch` or export the last two
commits into its appropriate patch files: `git format-patch -2`
@@ -651,6 +652,7 @@ C++ backend library \[vyatta-cfg\](<https://github.com/vyos/vyatta-cfg>). This
section is a reference of common CLI commands and the respective entry point
in the C/C++ code.
+% stop_vyoslinter
- `set`
- <https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/cstore/cstore.cpp#L352>
@@ -659,6 +661,7 @@ in the C/C++ code.
- `commit`
- <https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/commit/commit-algorithm.cpp#L1252>
+% start_vyoslinter
## Continuous Integration
@@ -678,17 +681,19 @@ to our Debian repository which is used during build time. It is located here:
<http://dev.packages.vyos.net/repositories/>.
-```{include} /_include/common-references.txt
-```
-
-
[dockerhub]: https://hub.docker.com/u/vyos/
+% stop_vyoslinter
[ipv4, ipv6]: https://github.com/vyos/vyos-1x/blob/current/interface-definitions/include/interface/address-ipv4-ipv6.xml.i
[ipv4, ipv6 and dhcp(v6)]: https://github.com/vyos/vyos-1x/blob/current/interface-definitions/include/interface/address-ipv4-ipv6-dhcp.xml.i
+% start_vyoslinter
[jenkins]: https://jenkins.io/
[jinja2]: https://jinja.palletsprojects.com/
+% stop_vyoslinter
[mac address]: https://github.com/vyos/vyos-1x/blob/current/interface-definitions/include/interface/mac.xml.i
+% start_vyoslinter
[process]: https://blog.vyos.io/vyos-development-digest-10
+% stop_vyoslinter
[vlan (vif)]: https://github.com/vyos/vyos-1x/blob/current/interface-definitions/include/interface/vif.xml.i
+% start_vyoslinter
[vyconf]: https://github.com/vyos/vyconf/tree/master/data/schemata
[vyos-1x]: https://github.com/vyos/vyos-1x/tree/current/schema
diff --git a/docs/contributing/issues-features.md b/docs/contributing/issues-features.md
index 6a748f36..7c5d52cb 100644
--- a/docs/contributing/issues-features.md
+++ b/docs/contributing/issues-features.md
@@ -65,8 +65,6 @@ please search [Phabricator] if there is already a request pending. You can
enhance it or if you don't find one, create a new one by use the quick link in
the left side under the specific project.
-```{include} /_include/common-references.txt
-```
[documentation]: https://docs.vyos.io
[forum]: https://forum.vyos.io
diff --git a/docs/contributing/testing.md b/docs/contributing/testing.md
index b2929936..5ef8b919 100644
--- a/docs/contributing/testing.md
+++ b/docs/contributing/testing.md
@@ -155,8 +155,9 @@ as member ports.
## Config Load Tests
-The other part of our tests are called "config load tests". The config load tests
-will load - one after another - arbitrary configuration files to test if the
+The other part of our tests are called "config load tests". The config
+load tests will load - one after another - arbitrary configuration
+files to test if the
configuration migration scripts work as designed and that a given set of
functionality still can be loaded with a fresh VyOS ISO image.
@@ -165,8 +166,9 @@ as a testcase but also as reference if one wants to enable a certain feature.
The configurations can be found here:
<https://github.com/vyos/vyos-1x/tree/current/smoketest/configs>
-The entire test is controlled by the main wrapper script `/usr/bin/vyos-configtest`
-which behaves in the same way as the main smoketest script. It scans the folder
+The entire test is controlled by the main wrapper script
+`/usr/bin/vyos-configtest` which behaves in the same way as the main
+smoketest script. It scans the folder
for potential configuration files and issues a `load` command one after another.
### Manual config load test
@@ -209,6 +211,3 @@ can be applied - you will get a commit error otherwise. If you are interested
how those preconditions are fulfilled check the [vyos-build] repository and
the `scripts/check-qemu-install` file.
:::
-
-```{include} /_include/common-references.txt
-```