Christian Poessinger
fcfded7cc5
Merge pull request #225 from niklasea/fix-docker-group-recommendation
...
build.rst: Do not recommend using docker group
2020-04-01 18:24:07 +02:00
Niklas Elmose Andersen
4742b8117b
Docs: Fix typo and code-block errors
...
Typo removed from CONTRIBUTING.md
arp.rst properly displays example command
build-vyos.rst troubleshooting diff has proper highlighting
2020-03-31 19:39:56 +02:00
Niklas Elmose Andersen
c62cf4e425
build.rst: Do not recommend using docker group
...
The documentation for building VyOS currently recommends adding a
non-root user to the docker group. Doing so is equivalent to making
that user root and thus should at least carry a warning.
2020-03-31 19:18:00 +02:00
John Estabrook
c9c11633e3
T2132: Document kernel boot parameter 'vyos-config-debug'
2020-03-16 20:58:09 -05:00
Christian Poessinger
9d10db0049
contribution: build: document ISO build with custom DEB package
2020-03-03 18:08:15 +01:00
Christian Poessinger
9240db979d
contribution: build: remove outdated branch reference on equuleus
2020-03-03 18:04:31 +01:00
Christian Poessinger
502452ffab
contribution: build: add troubleshooting section for APT
2020-03-01 17:34:57 +01:00
BananaWanted
ec3b620cb8
Update build-vyos.rst
...
the kernel patch link is outdated
2020-02-11 05:02:47 +08:00
Christian Poessinger
2e1d435ec3
contribution: build: add missind "cd" operation
2020-02-09 09:54:01 +01:00
Thomas Mangin
e787aa87ab
quiet vs quite
2020-02-08 15:42:22 +00:00
Thomas Mangin
df4a61adcc
more information about building on Mac/Windows
2020-02-08 15:42:22 +00:00
Thomas Mangin
d87a2feac0
fix note due to : vs :: typo
2020-02-08 15:42:17 +00:00
Stephen James
74c5a1fc3c
Fix some typos and capitalizations
2020-01-11 23:37:28 -05:00
Robert Göhler
52595595f7
Merge branch 'master' into newdirectives
2020-01-04 14:12:53 +01:00
Robert Göhler
156eef1779
Documentation: add :cfgcmd: and :opcmd: inline commands
2020-01-04 14:09:08 +01:00
Ali
bd7a52fbcc
documentation: fix contribution guideline typos
2019-12-30 23:48:23 +01:00
Christian Poessinger
0567858714
documentation: add new custom command: vytask
2019-12-30 13:36:56 +01:00
Christian Poessinger
3a8e3b1e9c
documentation: split cfgcmd/opcmd description
2019-12-30 13:36:42 +01:00
Christian Poessinger
63d79bfbc8
issue-feature: fix title overline & underline mismatch
2019-12-29 17:13:44 +01:00
Christian Poessinger
ed82d6b00e
issue-feature: use documented section style guide
2019-12-29 11:10:38 +01:00
Christian Poessinger
1499918804
common-references: migrate all VyOS Phabricator references
2019-12-29 11:07:24 +01:00
Christian Poessinger
3918aefbee
vytask: migrate all task references to new command
2019-12-29 10:44:14 +01:00
Jernej Jakob
fe343f5a82
contribution: build: add section about building packages
...
This is copied from the vyos-build README.md with some changes and updates.
2019-12-21 19:31:31 +01:00
Christian Poessinger
32652cce15
install: overall chapter improvement
2019-12-21 18:03:01 +01:00
Christian Poessinger
e747ad40df
contributing: clicmd and opcmd definitions should be indented by 3
2019-12-19 17:56:10 +01:00
Christian Poessinger
c713d63379
development: T1843: add information about GNU preprocessor on XML files
2019-12-12 21:57:24 +01:00
Christian Poessinger
6076282d1b
development: improve information about commit messages
...
... to make it more easy for upcoming contributors
2019-12-12 21:42:45 +01:00
Robert Göhler
b4506f2f56
Issues and Features: correct broken link
2019-12-10 15:00:13 +01:00
Robert Göhler
8eb93e2633
Development: correct redirect link
2019-12-10 14:58:10 +01:00
Robert Göhler
7c5ad425d9
Build VyOS: correct redirect link
2019-12-10 14:46:18 +01:00
Christian Poessinger
457420f0e7
development: adjust headlines to new level syntax
2019-12-07 18:37:26 +01:00
Christian Poessinger
d247468e03
development: reword of commit messages
2019-12-07 18:31:53 +01:00
Robert Göhler
4ebc8e0387
Fix: correct directive
2019-12-02 21:48:46 +01:00
Christian Poessinger
1f417f7ba3
contributing: improve Git Workflow on documentation
2019-12-01 10:10:05 +01:00
Christian Poessinger
269023845a
Refactor "code-block:: console" to "code-block:: none"
2019-11-28 21:41:32 +01:00
Christian Poessinger
a71cdcec33
docs: remove all trailing whitespaces
...
Done via:
$ find . -name "*.rst" | xargs sed -i 's/[ \t]*$//'
2019-11-28 21:26:14 +01:00
Christian Poessinger
6aa3cbb611
Refactor "code-block:: sh" to "code-block:: console"
...
This will add proper new-lines into the rendered PDF. Before if it has
been a long line, not all content was preserved in the PDF.
2019-11-27 17:20:38 +01:00
Christian Poessinger
76bbe2744d
development: fix wrong Python ConfigError import statement
2019-11-26 23:16:21 +01:00
Christian Poessinger
d497d30747
Merge pull request #150 from rebortg/cfgcmd
...
cfgcmd for better typing feeling
2019-11-24 21:40:39 +01:00
Robert Göhler
0c19693d3d
Style: change .. cfcmd:: to ..cfgcmd::
2019-11-24 21:26:34 +01:00
Robert Göhler
6a776ece0f
contributing: add section to style guide
2019-11-24 21:13:46 +01:00
Christian Poessinger
d57d6969f6
Revert "prevent douple heading"
...
This reverts commit c1ab520c4264227b5fc053aa917fdbc7d7e667af.
2019-11-23 20:55:16 +01:00
Robert Göhler
c1ab520c42
prevent douple heading
2019-11-23 20:16:11 +01:00
Christian Poessinger
101449f304
documentation: fix generation error in "code-block" directive
...
docs/contributing/documentation.rst:115: ERROR: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::
.. opcmd:: show protocols static arp
Display all known ARP table entries spanning accross all interfaces
There is a missing "sh" statement after "code-block::"
2019-11-23 14:03:44 +01:00
Robert Göhler
f4c414ce4d
add new directives "cfcmd" and "opcmd"
2019-11-23 14:00:52 +01:00
Christian Poessinger
db7ece47f0
contribution: fix code-block in documentation
2019-11-19 20:38:41 +01:00
Christian Poessinger
73edff0a21
Replace all RFC links with proper :rfc: syntax
2019-11-17 20:20:16 +01:00
Christian Poessinger
5cccf4c70c
contribution: beautify documentation directory name
2019-11-17 19:37:19 +01:00
Christian Poessinger
cbaecb30c2
build: fix branch reference on equuleus
2019-11-17 12:56:28 +01:00
Christian Poessinger
4b31556c1c
development: add chapter about Jenkins CI
2019-11-12 07:26:43 +01:00
