rebortg
9ce7bae14b
contribution: fix duplicate label error
2021-01-26 20:53:26 +01:00
erkin
a8aafe6517
docs: Mention proofreading in documentation contribution page
2021-01-23 15:28:00 +03:00
erkin
eef1d599f8
docs: Fix cross-reference
2021-01-23 15:18:08 +03:00
erkin
79435c3b3c
docs: Refer to the larger set of documentation guidelines
2021-01-23 15:11:15 +03:00
erkin
981cf62960
docs: Add contribution guidelines
2021-01-23 14:58:47 +03:00
rebortg
8bd516a5ff
rearrange development part
2020-12-10 13:35:30 +01:00
rebortg
763324b0c1
styleguide: specify line lenght and exception
2020-12-10 11:59:42 +01:00
rebortg
b8a2fd5e57
fix build error after merge
2020-12-08 15:12:56 +01:00
rebortg
f0d6a0cbb8
contributing: improve documentation
2020-12-07 20:47:32 +01:00
rebortg
6f6950d14e
fix build errors after arrange
2020-12-07 20:29:11 +01:00
rebortg
ce090a4ced
arrange examples
2020-12-06 21:41:10 +01:00
rebortg
e33e1268f9
change include to absolute path
2020-11-30 19:46:59 +01:00
rebortg
371bf8185f
rearange changelog, cli, contributing
2020-11-29 19:08:35 +01:00
rebortg
c46473a849
docs: add ..cmdinclude:: directive
2020-11-09 21:29:03 +01:00
Christian Poessinger
58ab5850f3
documentation: add link to RST directives
2020-11-08 09:07:48 +01:00
Noah Spahn
8295342ac1
revisions to the forking instructions
...
main changes include a consistent reference to the branch name
installing requirements before building locally
an alternate method for adding a commit message
2020-10-22 12:07:04 -07: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
1499918804
common-references: migrate all VyOS Phabricator references
2019-12-29 11:07:24 +01:00
Christian Poessinger
e747ad40df
contributing: clicmd and opcmd definitions should be indented by 3
2019-12-19 17:56:10 +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
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
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
9ca193f52a
contribution: fix call to ..note::
2019-11-11 17:01:10 +01:00
Christian Poessinger
0e33d4179a
contribution: restructure entire chapter
...
- move subchapters to sub-sub chapters and try to have more internal
references to e.g. commit rules.
2019-11-11 17:00:12 +01:00
Rob Thomas
b66cdf17ad
contribution: fix Markdown leftovers
2019-11-10 20:42:50 +01:00
Christian Poessinger
4d42f5bfee
contribution: fix errors when generating documentation chapter
2019-11-08 19:17:47 +01:00
Christian Poessinger
dc495cfb89
contribution: add guide how to participate in the documentation
2019-11-08 18:52:09 +01:00
