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
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
bace22c690
upstream packages: rename chapter reference
2019-11-09 12:35:59 +01:00
Christian Poessinger
e67aa0019c
contribution: build: fix headline
2019-11-09 12:29:13 +01:00
Christian Poessinger
c1c736ff6e
contribution: build: use 80 char line breaks
2019-11-09 11:19:21 +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
Christian Poessinger
7d3a19bcad
index: reformat table of contents
...
Make TOC sections more obvious and remove single include file for
contribution and development.
2019-11-08 17:42:00 +01:00
kroy
d7f81e784e
contribution: build cleanup
2019-11-06 21:34:48 +01:00
Christian Poessinger
bdf0451c61
contribution: add Python node about 80 character limit
2019-11-06 19:27:50 +01:00
Christian Poessinger
1066322084
contribution: elaborate on Docker container versions
2019-11-06 19:23:01 +01:00
Christian Poessinger
0884d46252
contribution: improve Docker build documentation
...
Add notes about Dockerhub and that rebuilding the container will take a
long long time.
2019-11-06 19:17:53 +01:00
