ofs | hex dump | ascii |
---|
0000 | de 12 04 95 00 00 00 00 7d 00 00 00 1c 00 00 00 04 04 00 00 a7 00 00 00 ec 07 00 00 00 00 00 00 | ........}....................... |
0020 | 88 0a 00 00 1a 00 00 00 89 0a 00 00 1c 00 00 00 a4 0a 00 00 1c 00 00 00 c1 0a 00 00 19 00 00 00 | ................................ |
0040 | de 0a 00 00 1c 00 00 00 f8 0a 00 00 0f 00 00 00 15 0b 00 00 0c 00 00 00 25 0b 00 00 97 00 00 00 | ........................%....... |
0060 | 32 0b 00 00 b4 00 00 00 ca 0b 00 00 0d 00 00 00 7f 0c 00 00 4a 00 00 00 8d 0c 00 00 d4 00 00 00 | 2...................J........... |
0080 | d8 0c 00 00 a6 00 00 00 ad 0d 00 00 0d 00 00 00 54 0e 00 00 5e 00 00 00 62 0e 00 00 0a 00 00 00 | ................T...^...b....... |
00a0 | c1 0e 00 00 06 01 00 00 cc 0e 00 00 2a 00 00 00 d3 0f 00 00 56 00 00 00 fe 0f 00 00 01 01 00 00 | ............*.......V........... |
00c0 | 55 10 00 00 18 00 00 00 57 11 00 00 6b 00 00 00 70 11 00 00 10 00 00 00 dc 11 00 00 18 00 00 00 | U.......W...k...p............... |
00e0 | ed 11 00 00 aa 00 00 00 06 12 00 00 9d 00 00 00 b1 12 00 00 2d 00 00 00 4f 13 00 00 3c 00 00 00 | ....................-...O...<... |
0100 | 7d 13 00 00 5c 00 00 00 ba 13 00 00 2b 00 00 00 17 14 00 00 7f 00 00 00 43 14 00 00 3b 00 00 00 | }...\.......+...........C...;... |
0120 | c3 14 00 00 38 00 00 00 ff 14 00 00 9e 00 00 00 38 15 00 00 0c 00 00 00 d7 15 00 00 4b 00 00 00 | ....8...........8...........K... |
0140 | e4 15 00 00 10 00 00 00 30 16 00 00 1a 00 00 00 41 16 00 00 1b 00 00 00 5c 16 00 00 53 00 00 00 | ........0.......A.......\...S... |
0160 | 78 16 00 00 0a 00 00 00 cc 16 00 00 63 00 00 00 d7 16 00 00 60 00 00 00 3b 17 00 00 5f 00 00 00 | x...........c.......`...;..._... |
0180 | 9c 17 00 00 5e 00 00 00 fc 17 00 00 9d 00 00 00 5b 18 00 00 84 00 00 00 f9 18 00 00 17 00 00 00 | ....^...........[............... |
01a0 | 7e 19 00 00 55 00 00 00 96 19 00 00 2a 00 00 00 ec 19 00 00 2e 00 00 00 17 1a 00 00 0b 00 00 00 | ~...U.......*................... |
01c0 | 46 1a 00 00 90 01 00 00 52 1a 00 00 35 00 00 00 e3 1b 00 00 b5 00 00 00 19 1c 00 00 0e 01 00 00 | F.......R...5................... |
01e0 | cf 1c 00 00 85 00 00 00 de 1d 00 00 14 00 00 00 64 1e 00 00 0c 00 00 00 79 1e 00 00 2d 00 00 00 | ................d.......y...-... |
0200 | 86 1e 00 00 84 00 00 00 b4 1e 00 00 51 00 00 00 39 1f 00 00 4b 00 00 00 8b 1f 00 00 73 00 00 00 | ............Q...9...K.......s... |
0220 | d7 1f 00 00 d2 00 00 00 4b 20 00 00 0b 00 00 00 1e 21 00 00 a3 00 00 00 2a 21 00 00 09 00 00 00 | ........K........!......*!...... |
0240 | ce 21 00 00 68 00 00 00 d8 21 00 00 59 01 00 00 41 22 00 00 8e 00 00 00 9b 23 00 00 c6 00 00 00 | .!..h....!..Y...A".......#...... |
0260 | 2a 24 00 00 86 00 00 00 f1 24 00 00 ba 00 00 00 78 25 00 00 2e 00 00 00 33 26 00 00 90 01 00 00 | *$.......$......x%......3&...... |
0280 | 62 26 00 00 a5 00 00 00 f3 27 00 00 54 00 00 00 99 28 00 00 7b 00 00 00 ee 28 00 00 24 00 00 00 | b&.......'..T....(..{....(..$... |
02a0 | 6a 29 00 00 f1 00 00 00 8f 29 00 00 9c 00 00 00 81 2a 00 00 49 00 00 00 1e 2b 00 00 33 00 00 00 | j).......).......*..I....+..3... |
02c0 | 68 2b 00 00 7b 00 00 00 9c 2b 00 00 86 00 00 00 18 2c 00 00 27 00 00 00 9f 2c 00 00 a7 00 00 00 | h+..{....+.......,..'....,...... |
02e0 | c7 2c 00 00 37 01 00 00 6f 2d 00 00 03 01 00 00 a7 2e 00 00 b1 00 00 00 ab 2f 00 00 2a 00 00 00 | .,..7...o-.............../..*... |
0300 | 5d 30 00 00 f4 00 00 00 88 30 00 00 9c 00 00 00 7d 31 00 00 3a 00 00 00 1a 32 00 00 d7 00 00 00 | ]0.......0......}1..:....2...... |
0320 | 55 32 00 00 75 00 00 00 2d 33 00 00 7a 00 00 00 a3 33 00 00 13 00 00 00 1e 34 00 00 93 00 00 00 | U2..u...-3..z....3.......4...... |
0340 | 32 34 00 00 75 00 00 00 c6 34 00 00 9d 00 00 00 3c 35 00 00 10 00 00 00 da 35 00 00 13 00 00 00 | 24..u....4......<5.......5...... |
0360 | eb 35 00 00 11 00 00 00 ff 35 00 00 12 00 00 00 11 36 00 00 40 00 00 00 24 36 00 00 30 00 00 00 | .5.......5.......6..@...$6..0... |
0380 | 65 36 00 00 39 00 00 00 96 36 00 00 45 00 00 00 d0 36 00 00 56 00 00 00 16 37 00 00 06 00 00 00 | e6..9....6..E....6..V....7...... |
03a0 | 6d 37 00 00 0a 00 00 00 74 37 00 00 13 00 00 00 7f 37 00 00 50 00 00 00 93 37 00 00 44 00 00 00 | m7......t7.......7..P....7..D... |
03c0 | e4 37 00 00 3e 00 00 00 29 38 00 00 05 00 00 00 68 38 00 00 1d 00 00 00 6e 38 00 00 34 00 00 00 | .7..>...)8......h8......n8..4... |
03e0 | 8c 38 00 00 30 00 00 00 c1 38 00 00 06 00 00 00 f2 38 00 00 3f 00 00 00 f9 38 00 00 2b 00 00 00 | .8..0....8.......8..?....8..+... |
0400 | 39 39 00 00 e2 00 00 00 65 39 00 00 1a 00 00 00 48 3a 00 00 1c 00 00 00 63 3a 00 00 1c 00 00 00 | 99......e9......H:......c:...... |
0420 | 80 3a 00 00 19 00 00 00 9d 3a 00 00 1c 00 00 00 b7 3a 00 00 0f 00 00 00 d4 3a 00 00 0c 00 00 00 | .:.......:.......:.......:...... |
0440 | e4 3a 00 00 97 00 00 00 f1 3a 00 00 b4 00 00 00 89 3b 00 00 0d 00 00 00 3e 3c 00 00 4a 00 00 00 | .:.......:.......;......><..J... |
0460 | 4c 3c 00 00 d4 00 00 00 97 3c 00 00 a6 00 00 00 6c 3d 00 00 0d 00 00 00 13 3e 00 00 5e 00 00 00 | L<.......<......l=.......>..^... |
0480 | 21 3e 00 00 0a 00 00 00 80 3e 00 00 06 01 00 00 8b 3e 00 00 2a 00 00 00 92 3f 00 00 56 00 00 00 | !>.......>.......>..*....?..V... |
04a0 | bd 3f 00 00 01 01 00 00 14 40 00 00 18 00 00 00 16 41 00 00 6b 00 00 00 2f 41 00 00 10 00 00 00 | .?.......@.......A..k.../A...... |
04c0 | 9b 41 00 00 18 00 00 00 ac 41 00 00 aa 00 00 00 c5 41 00 00 9d 00 00 00 70 42 00 00 2d 00 00 00 | .A.......A.......A......pB..-... |
04e0 | 0e 43 00 00 3c 00 00 00 3c 43 00 00 5c 00 00 00 79 43 00 00 2b 00 00 00 d6 43 00 00 7f 00 00 00 | .C..<...<C..\...yC..+....C...... |
0500 | 02 44 00 00 3b 00 00 00 82 44 00 00 38 00 00 00 be 44 00 00 9e 00 00 00 f7 44 00 00 0c 00 00 00 | .D..;....D..8....D.......D...... |
0520 | 96 45 00 00 4b 00 00 00 a3 45 00 00 10 00 00 00 ef 45 00 00 1a 00 00 00 00 46 00 00 1b 00 00 00 | .E..K....E.......E.......F...... |
0540 | 1b 46 00 00 53 00 00 00 37 46 00 00 0a 00 00 00 8b 46 00 00 63 00 00 00 96 46 00 00 60 00 00 00 | .F..S...7F.......F..c....F..`... |
0560 | fa 46 00 00 5f 00 00 00 5b 47 00 00 5e 00 00 00 bb 47 00 00 9d 00 00 00 1a 48 00 00 84 00 00 00 | .F.._...[G..^....G.......H...... |
0580 | b8 48 00 00 17 00 00 00 3d 49 00 00 55 00 00 00 55 49 00 00 2a 00 00 00 ab 49 00 00 2e 00 00 00 | .H......=I..U...UI..*....I...... |
05a0 | d6 49 00 00 0b 00 00 00 05 4a 00 00 90 01 00 00 11 4a 00 00 35 00 00 00 a2 4b 00 00 b5 00 00 00 | .I.......J.......J..5....K...... |
05c0 | d8 4b 00 00 0e 01 00 00 8e 4c 00 00 85 00 00 00 9d 4d 00 00 14 00 00 00 23 4e 00 00 0c 00 00 00 | .K.......L.......M......#N...... |
05e0 | 38 4e 00 00 2d 00 00 00 45 4e 00 00 84 00 00 00 73 4e 00 00 51 00 00 00 f8 4e 00 00 4b 00 00 00 | 8N..-...EN......sN..Q....N..K... |
0600 | 4a 4f 00 00 73 00 00 00 96 4f 00 00 d2 00 00 00 0a 50 00 00 0b 00 00 00 dd 50 00 00 a3 00 00 00 | JO..s....O.......P.......P...... |
0620 | e9 50 00 00 09 00 00 00 8d 51 00 00 68 00 00 00 97 51 00 00 59 01 00 00 00 52 00 00 8e 00 00 00 | .P.......Q..h....Q..Y....R...... |
0640 | 5a 53 00 00 c6 00 00 00 e9 53 00 00 86 00 00 00 b0 54 00 00 ba 00 00 00 37 55 00 00 2e 00 00 00 | ZS.......S.......T......7U...... |
0660 | f2 55 00 00 90 01 00 00 21 56 00 00 a5 00 00 00 b2 57 00 00 54 00 00 00 58 58 00 00 7b 00 00 00 | .U......!V.......W..T...XX..{... |
0680 | ad 58 00 00 24 00 00 00 29 59 00 00 f1 00 00 00 4e 59 00 00 9c 00 00 00 40 5a 00 00 49 00 00 00 | .X..$...)Y......NY......@Z..I... |
06a0 | dd 5a 00 00 33 00 00 00 27 5b 00 00 7b 00 00 00 5b 5b 00 00 86 00 00 00 d7 5b 00 00 27 00 00 00 | .Z..3...'[..{...[[.......[..'... |
06c0 | 5e 5c 00 00 a7 00 00 00 86 5c 00 00 37 01 00 00 2e 5d 00 00 03 01 00 00 66 5e 00 00 b1 00 00 00 | ^\.......\..7....]......f^...... |
06e0 | 6a 5f 00 00 2a 00 00 00 1c 60 00 00 f4 00 00 00 47 60 00 00 9c 00 00 00 3c 61 00 00 3a 00 00 00 | j_..*....`......G`......<a..:... |
0700 | d9 61 00 00 d7 00 00 00 14 62 00 00 75 00 00 00 ec 62 00 00 7a 00 00 00 62 63 00 00 13 00 00 00 | .a.......b..u....b..z...bc...... |
0720 | dd 63 00 00 93 00 00 00 f1 63 00 00 75 00 00 00 85 64 00 00 9d 00 00 00 fb 64 00 00 10 00 00 00 | .c.......c..u....d.......d...... |
0740 | 99 65 00 00 13 00 00 00 aa 65 00 00 11 00 00 00 be 65 00 00 12 00 00 00 d0 65 00 00 40 00 00 00 | .e.......e.......e.......e..@... |
0760 | e3 65 00 00 30 00 00 00 24 66 00 00 39 00 00 00 55 66 00 00 45 00 00 00 8f 66 00 00 56 00 00 00 | .e..0...$f..9...Uf..E....f..V... |
0780 | d5 66 00 00 06 00 00 00 2c 67 00 00 0a 00 00 00 33 67 00 00 13 00 00 00 3e 67 00 00 50 00 00 00 | .f......,g......3g......>g..P... |
07a0 | 52 67 00 00 44 00 00 00 a3 67 00 00 3e 00 00 00 e8 67 00 00 05 00 00 00 27 68 00 00 1d 00 00 00 | Rg..D....g..>....g......'h...... |
07c0 | 2d 68 00 00 34 00 00 00 4b 68 00 00 30 00 00 00 80 68 00 00 06 00 00 00 b1 68 00 00 3f 00 00 00 | -h..4...Kh..0....h.......h..?... |
07e0 | b8 68 00 00 2b 00 00 00 f8 68 00 00 01 00 00 00 0f 00 00 00 52 00 00 00 00 00 00 00 00 00 00 00 | .h..+....h..........R........... |
0800 | 35 00 00 00 00 00 00 00 00 00 00 00 3d 00 00 00 00 00 00 00 06 00 00 00 2b 00 00 00 0a 00 00 00 | 5...........=...........+....... |
0820 | 54 00 00 00 00 00 00 00 5f 00 00 00 69 00 00 00 68 00 00 00 09 00 00 00 00 00 00 00 31 00 00 00 | T......._...i...h...........1... |
0840 | 00 00 00 00 5a 00 00 00 26 00 00 00 63 00 00 00 38 00 00 00 0e 00 00 00 00 00 00 00 12 00 00 00 | ....Z...&...c...8............... |
0860 | 79 00 00 00 1a 00 00 00 17 00 00 00 00 00 00 00 25 00 00 00 65 00 00 00 20 00 00 00 27 00 00 00 | y...............%...e.......'... |
0880 | 16 00 00 00 70 00 00 00 00 00 00 00 00 00 00 00 5b 00 00 00 74 00 00 00 5d 00 00 00 00 00 00 00 | ....p...........[...t...]....... |
08a0 | 0d 00 00 00 00 00 00 00 55 00 00 00 64 00 00 00 2e 00 00 00 00 00 00 00 29 00 00 00 00 00 00 00 | ........U...d...........)....... |
08c0 | 77 00 00 00 00 00 00 00 58 00 00 00 00 00 00 00 00 00 00 00 6e 00 00 00 50 00 00 00 7d 00 00 00 | w.......X...........n...P...}... |
08e0 | 45 00 00 00 00 00 00 00 13 00 00 00 1e 00 00 00 3f 00 00 00 67 00 00 00 00 00 00 00 44 00 00 00 | E...............?...g.......D... |
0900 | 71 00 00 00 00 00 00 00 2c 00 00 00 08 00 00 00 04 00 00 00 4d 00 00 00 00 00 00 00 18 00 00 00 | q.......,...........M........... |
0920 | 33 00 00 00 00 00 00 00 00 00 00 00 15 00 00 00 6a 00 00 00 62 00 00 00 1c 00 00 00 6d 00 00 00 | 3...............j...b.......m... |
0940 | 4e 00 00 00 40 00 00 00 47 00 00 00 7c 00 00 00 73 00 00 00 60 00 00 00 4c 00 00 00 00 00 00 00 | N...@...G...|...s...`...L....... |
0960 | 41 00 00 00 1f 00 00 00 23 00 00 00 76 00 00 00 56 00 00 00 42 00 00 00 78 00 00 00 5e 00 00 00 | A.......#...v...V...B...x...^... |
0980 | 72 00 00 00 24 00 00 00 3a 00 00 00 05 00 00 00 03 00 00 00 7b 00 00 00 6b 00 00 00 4b 00 00 00 | r...$...:...........{...k...K... |
09a0 | 00 00 00 00 57 00 00 00 00 00 00 00 10 00 00 00 37 00 00 00 36 00 00 00 6f 00 00 00 14 00 00 00 | ....W...........7...6...o....... |
09c0 | 43 00 00 00 00 00 00 00 48 00 00 00 00 00 00 00 21 00 00 00 3b 00 00 00 00 00 00 00 32 00 00 00 | C.......H.......!...;.......2... |
09e0 | 0c 00 00 00 00 00 00 00 00 00 00 00 5c 00 00 00 46 00 00 00 6c 00 00 00 49 00 00 00 0b 00 00 00 | ............\...F...l...I....... |
0a00 | 4a 00 00 00 30 00 00 00 2f 00 00 00 66 00 00 00 07 00 00 00 02 00 00 00 2a 00 00 00 28 00 00 00 | J...0.../...f...........*...(... |
0a20 | 75 00 00 00 59 00 00 00 34 00 00 00 00 00 00 00 19 00 00 00 2d 00 00 00 61 00 00 00 7a 00 00 00 | u...Y...4...........-...a...z... |
0a40 | 1b 00 00 00 00 00 00 00 53 00 00 00 00 00 00 00 00 00 00 00 22 00 00 00 11 00 00 00 00 00 00 00 | ........S..........."........... |
0a60 | 3c 00 00 00 51 00 00 00 1d 00 00 00 00 00 00 00 3e 00 00 00 00 00 00 00 39 00 00 00 00 00 00 00 | <...Q...........>.......9....... |
0a80 | 4f 00 00 00 00 00 00 00 00 31 2e 20 54 68 65 6f 72 65 74 69 63 61 6c 20 69 6e 66 6f 72 6d 61 74 | O........1..Theoretical.informat |
0aa0 | 69 6f 6e 00 31 36 62 69 74 20 41 53 4e 3a 20 60 60 36 34 34 39 36 20 2d 20 36 34 35 31 31 60 60 | ion.16bit.ASN:.``64496.-.64511`` |
0ac0 | 00 32 2e 20 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 64 65 73 63 72 69 70 74 69 6f 6e 00 33 2e | .2..Configuration.description.3. |
0ae0 | 20 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 65 78 61 6d 70 6c 65 73 00 33 32 62 69 74 20 41 53 | .Configuration.examples.32bit.AS |
0b00 | 4e 3a 20 60 60 36 35 35 33 36 20 2d 20 36 35 35 35 31 60 60 00 34 2e 20 4b 6e 6f 77 6e 20 69 73 | N:.``65536.-.65551``.4..Known.is |
0b20 | 73 75 65 73 00 35 2e 20 44 65 62 75 67 67 69 6e 67 00 41 20 70 6c 75 67 69 6e 20 77 69 6c 6c 20 | sues.5..Debugging.A.plugin.will. |
0b40 | 62 65 20 75 73 65 64 20 74 6f 20 67 65 6e 65 72 61 74 65 20 61 20 72 65 66 65 72 65 6e 63 65 20 | be.used.to.generate.a.reference. |
0b60 | 6c 61 62 65 6c 20 66 6f 72 20 65 61 63 68 20 68 65 61 64 6c 69 6e 65 2e 20 54 6f 20 72 65 66 65 | label.for.each.headline..To.refe |
0b80 | 72 65 6e 63 65 20 61 20 70 61 67 65 20 6f 72 20 61 20 73 65 63 74 69 6f 6e 20 69 6e 20 74 68 65 | rence.a.page.or.a.section.in.the |
0ba0 | 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 75 73 65 20 74 68 65 20 60 60 3a 72 65 66 3a 60 60 | .documentation.use.the.``:ref:`` |
0bc0 | 20 63 6f 6d 6d 61 6e 64 2e 00 41 64 64 20 6d 6f 64 69 66 69 65 64 20 66 69 6c 65 73 20 74 6f 20 | .command..Add.modified.files.to. |
0be0 | 47 69 74 20 69 6e 64 65 78 20 60 60 24 20 67 69 74 20 61 64 64 20 70 61 74 68 2f 74 6f 2f 66 69 | Git.index.``$.git.add.path/to/fi |
0c00 | 6c 65 6e 61 6d 65 60 60 20 6f 72 20 61 64 64 20 61 6c 6c 20 75 6e 73 74 61 67 65 64 20 66 69 6c | lename``.or.add.all.unstaged.fil |
0c20 | 65 73 20 60 60 24 20 67 69 74 20 61 64 64 20 2e 60 60 2e 20 41 6c 6c 20 66 69 6c 65 73 20 61 64 | es.``$.git.add..``..All.files.ad |
0c40 | 64 65 64 20 74 6f 20 74 68 65 20 47 69 74 20 69 6e 64 65 78 20 77 69 6c 6c 20 62 65 20 70 61 72 | ded.to.the.Git.index.will.be.par |
0c60 | 74 20 6f 66 20 79 6f 75 20 66 6f 6c 6c 6f 77 69 6e 67 20 47 69 74 20 63 6f 6d 6d 69 74 2e 00 41 | t.of.you.following.Git.commit..A |
0c80 | 64 64 72 65 73 73 20 73 70 61 63 65 00 41 6c 6c 20 52 53 54 20 66 69 6c 65 73 20 6d 75 73 74 20 | ddress.space.All.RST.files.must. |
0ca0 | 66 6f 6c 6c 6f 77 20 74 68 65 20 73 61 6d 65 20 54 4f 43 20 4c 65 76 65 6c 20 73 79 6e 74 61 78 | follow.the.same.TOC.Level.syntax |
0cc0 | 20 61 6e 64 20 68 61 76 65 20 74 6f 20 73 74 61 72 74 20 77 69 74 68 00 41 6e 20 6f 70 74 69 6f | .and.have.to.start.with.An.optio |
0ce0 | 6e 61 6c 20 73 65 63 74 69 6f 6e 20 66 6f 6c 6c 6f 77 73 2e 20 53 6f 6d 65 20 63 6f 6d 6d 61 6e | nal.section.follows..Some.comman |
0d00 | 64 73 20 68 61 76 65 20 72 65 71 75 69 72 65 6d 65 6e 74 73 20 6c 69 6b 65 20 63 6f 6d 70 61 74 | ds.have.requirements.like.compat |
0d20 | 69 62 6c 65 20 68 61 72 64 77 61 72 65 20 28 65 2e 67 2e 20 57 69 66 69 29 20 6f 72 20 73 6f 6d | ible.hardware.(e.g..Wifi).or.som |
0d40 | 65 20 63 6f 6d 6d 61 6e 64 73 20 79 6f 75 20 68 61 76 65 20 74 6f 20 73 65 74 20 62 65 66 6f 72 | e.commands.you.have.to.set.befor |
0d60 | 65 2e 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 69 74 20 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65 | e..For.example,.it.is.recommende |
0d80 | 64 20 74 6f 20 73 65 74 20 61 20 72 6f 75 74 65 2d 6d 61 70 20 62 65 66 6f 72 65 20 63 6f 6e 66 | d.to.set.a.route-map.before.conf |
0da0 | 69 67 75 72 69 6e 67 20 42 47 50 2e 00 41 6e 64 20 66 69 6e 61 6c 6c 79 2c 20 72 65 6d 65 6d 62 | iguring.BGP..And.finally,.rememb |
0dc0 | 65 72 20 74 68 61 74 20 74 68 65 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 20 66 69 6c | er.that.the.reStructuredText.fil |
0de0 | 65 73 20 61 72 65 6e 27 74 20 65 78 63 6c 75 73 69 76 65 6c 79 20 66 6f 72 20 67 65 6e 65 72 61 | es.aren't.exclusively.for.genera |
0e00 | 74 69 6e 67 20 48 54 4d 4c 20 61 6e 64 20 50 44 46 2e 20 54 68 65 79 20 73 68 6f 75 6c 64 20 62 | ting.HTML.and.PDF..They.should.b |
0e20 | 65 20 68 75 6d 61 6e 2d 72 65 61 64 61 62 6c 65 20 61 6e 64 20 65 61 73 69 6c 79 20 70 65 72 75 | e.human-readable.and.easily.peru |
0e40 | 73 65 64 20 66 72 6f 6d 20 61 20 63 6f 6e 73 6f 6c 65 2e 00 41 6e 79 74 68 69 6e 67 20 65 6c 73 | sed.from.a.console..Anything.els |
0e60 | 65 00 41 6e 79 74 68 69 6e 67 20 65 6c 73 65 20 74 68 61 74 20 69 73 20 6e 6f 74 20 61 20 63 6f | e.Anything.else.that.is.not.a.co |
0e80 | 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 72 20 61 6e 20 6f 70 65 72 61 74 69 6f 6e 20 63 6f 6d 6d | nfiguration.or.an.operation.comm |
0ea0 | 61 6e 64 20 68 61 73 20 6e 6f 20 70 72 65 64 65 66 69 6e 65 64 20 73 74 72 75 63 74 75 72 65 2e | and.has.no.predefined.structure. |
0ec0 | 00 41 75 74 6f 6c 69 6e 74 65 72 00 43 68 65 63 6b 20 79 6f 75 72 20 63 68 61 6e 67 65 73 20 62 | .Autolinter.Check.your.changes.b |
0ee0 | 79 20 6c 6f 63 61 6c 6c 79 20 62 75 69 6c 64 69 6e 67 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 | y.locally.building.the.documenta |
0f00 | 74 69 6f 6e 20 60 60 24 20 6d 61 6b 65 20 6c 69 76 65 68 74 6d 6c 60 60 2e 20 53 70 68 69 6e 78 | tion.``$.make.livehtml``..Sphinx |
0f20 | 20 77 69 6c 6c 20 62 75 69 6c 64 20 74 68 65 20 68 74 6d 6c 20 66 69 6c 65 73 20 69 6e 20 74 68 | .will.build.the.html.files.in.th |
0f40 | 65 20 60 60 64 6f 63 73 2f 5f 62 75 69 6c 64 60 60 20 66 6f 6c 64 65 72 2e 20 57 65 20 70 72 6f | e.``docs/_build``.folder..We.pro |
0f60 | 76 69 64 65 20 79 6f 75 20 77 69 74 68 20 61 20 44 6f 63 6b 65 72 20 63 6f 6e 74 61 69 6e 65 72 | vide.you.with.a.Docker.container |
0f80 | 20 66 6f 72 20 61 6e 20 65 61 73 79 2d 74 6f 2d 75 73 65 20 75 73 65 72 20 65 78 70 65 72 69 65 | .for.an.easy-to-use.user.experie |
0fa0 | 6e 63 65 2e 20 43 68 65 63 6b 20 74 68 65 20 52 45 41 44 4d 45 2e 6d 64 5f 20 66 69 6c 65 20 6f | nce..Check.the.README.md_.file.o |
0fc0 | 66 20 74 68 69 73 20 72 65 70 6f 73 69 74 6f 72 79 2e 00 43 68 65 63 6b 20 79 6f 75 72 20 63 6f | f.this.repository..Check.your.co |
0fe0 | 6e 66 69 67 75 72 65 64 20 72 65 6d 6f 74 65 20 72 65 70 6f 73 69 74 6f 72 69 65 73 3a 00 43 6c | nfigured.remote.repositories:.Cl |
1000 | 6f 6e 65 20 66 6f 72 6b 20 74 6f 20 6c 6f 63 61 6c 20 6d 61 63 68 69 6e 65 2c 20 74 68 65 6e 20 | one.fork.to.local.machine,.then. |
1020 | 63 68 61 6e 67 65 20 74 6f 20 74 68 61 74 20 64 69 72 65 63 74 6f 72 79 20 60 60 24 20 63 64 20 | change.to.that.directory.``$.cd. |
1040 | 76 79 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 60 60 00 43 6f 6d 6d 69 74 20 79 6f 75 72 | vyos-documentation``.Commit.your |
1060 | 20 63 68 61 6e 67 65 73 20 77 69 74 68 20 74 68 65 20 6d 65 73 73 61 67 65 2c 20 60 60 24 20 67 | .changes.with.the.message,.``$.g |
1080 | 69 74 20 63 6f 6d 6d 69 74 20 2d 6d 20 22 3c 63 6f 6d 6d 69 74 20 6d 65 73 73 61 67 65 3e 22 60 | it.commit.-m."<commit.message>"` |
10a0 | 60 20 6f 72 20 20 75 73 65 20 60 60 24 20 67 69 74 20 63 6f 6d 6d 69 74 20 2d 76 60 60 20 74 6f | `.or..use.``$.git.commit.-v``.to |
10c0 | 20 68 61 76 65 20 79 6f 75 72 20 63 6f 6e 66 69 67 75 72 65 64 20 65 64 69 74 6f 72 20 6c 61 75 | .have.your.configured.editor.lau |
10e0 | 6e 63 68 65 64 2e 20 59 6f 75 20 63 61 6e 20 74 79 70 65 20 69 6e 20 61 20 63 6f 6d 6d 69 74 20 | nched..You.can.type.in.a.commit. |
1100 | 6d 65 73 73 61 67 65 2e 20 41 67 61 69 6e 20 70 6c 65 61 73 65 20 6d 61 6b 65 20 79 6f 75 72 73 | message..Again.please.make.yours |
1120 | 65 6c 66 20 63 6f 6d 66 6f 72 74 61 62 6c 65 20 77 69 74 68 6f 75 74 20 72 75 6c 65 73 20 28 3a | elf.comfortable.without.rules.(: |
1140 | 72 65 66 3a 60 70 72 65 70 61 72 65 5f 63 6f 6d 6d 69 74 60 29 2e 00 43 6f 6e 66 69 67 75 72 61 | ref:`prepare_commit`)..Configura |
1160 | 74 69 6f 6e 20 6d 6f 64 65 20 70 61 67 65 73 00 43 72 65 61 74 65 20 61 20 6e 65 77 20 62 72 61 | tion.mode.pages.Create.a.new.bra |
1180 | 6e 63 68 20 66 6f 72 20 79 6f 75 72 20 77 6f 72 6b 2c 20 75 73 65 20 61 20 64 65 73 63 72 69 70 | nch.for.your.work,.use.a.descrip |
11a0 | 74 69 76 65 20 6e 61 6d 65 20 6f 66 20 79 6f 75 72 20 77 6f 72 6b 3a 20 60 60 24 20 67 69 74 20 | tive.name.of.your.work:.``$.git. |
11c0 | 63 68 65 63 6b 6f 75 74 20 2d 62 20 3c 62 72 61 6e 63 68 2d 6e 61 6d 65 3e 60 60 00 43 72 6f 73 | checkout.-b.<branch-name>``.Cros |
11e0 | 73 2d 52 65 66 65 72 65 6e 63 65 73 00 43 75 73 74 6f 6d 20 53 70 68 69 6e 78 2d 64 6f 63 20 4d | s-References.Custom.Sphinx-doc.M |
1200 | 61 72 6b 75 70 00 43 75 73 74 6f 6d 20 63 6f 6d 6d 61 6e 64 73 20 68 61 76 65 20 62 65 65 6e 20 | arkup.Custom.commands.have.been. |
1220 | 64 65 76 65 6c 6f 70 65 64 20 66 6f 72 20 77 72 69 74 69 6e 67 20 74 68 65 20 64 6f 63 75 6d 65 | developed.for.writing.the.docume |
1240 | 6e 74 61 74 69 6f 6e 2e 20 50 6c 65 61 73 65 20 6d 61 6b 65 20 79 6f 75 72 73 65 6c 66 20 63 6f | ntation..Please.make.yourself.co |
1260 | 6d 66 6f 72 74 61 62 6c 65 20 77 69 74 68 20 74 68 6f 73 65 20 63 6f 6d 6d 61 6e 64 73 20 61 73 | mfortable.with.those.commands.as |
1280 | 20 74 68 69 73 20 65 61 73 65 73 20 74 68 65 20 77 61 79 20 77 65 20 72 65 6e 64 65 72 20 74 68 | .this.eases.the.way.we.render.th |
12a0 | 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 44 65 73 63 72 69 62 65 20 43 4c 49 20 69 74 | e.documentation..Describe.CLI.it |
12c0 | 65 6d 73 20 72 65 6c 61 74 65 64 20 74 6f 20 74 68 65 20 73 65 72 76 69 63 65 20 6f 72 20 75 73 | ems.related.to.the.service.or.us |
12e0 | 65 20 63 61 73 65 2e 20 45 61 63 68 20 63 6f 6e 66 69 67 20 6c 69 6e 65 20 6f 72 20 73 65 63 74 | e.case..Each.config.line.or.sect |
1300 | 69 6f 6e 20 6d 75 73 74 20 62 65 20 65 78 70 6c 61 69 6e 65 64 2c 20 75 73 69 6e 67 20 69 6e 66 | ion.must.be.explained,.using.inf |
1320 | 6f 72 6d 61 74 69 6f 6e 20 70 72 6f 76 69 64 65 64 20 69 6e 20 74 68 65 20 31 73 74 20 70 61 72 | ormation.provided.in.the.1st.par |
1340 | 74 20 6f 66 20 74 68 65 20 70 61 67 65 2e 00 44 65 73 63 72 69 62 65 64 20 70 72 6f 63 65 64 75 | t.of.the.page..Described.procedu |
1360 | 72 65 73 20 66 6f 72 20 64 65 62 75 67 67 69 6e 67 20 61 20 73 65 72 76 69 63 65 3a 00 44 6f 6e | res.for.debugging.a.service:.Don |
1380 | 27 74 20 66 6f 72 67 65 74 20 74 6f 20 75 70 64 61 74 65 20 60 60 69 6e 64 65 78 2e 72 73 74 60 | 't.forget.to.update.``index.rst` |
13a0 | 60 20 77 68 65 6e 20 61 64 64 69 6e 67 20 61 20 6e 65 77 20 6e 6f 64 65 2e 00 45 61 63 68 20 47 | `.when.adding.a.new.node..Each.G |
13c0 | 69 74 48 75 62 20 70 75 6c 6c 20 72 65 71 75 65 73 74 20 69 73 20 61 75 74 6f 6d 61 74 69 63 61 | itHub.pull.request.is.automatica |
13e0 | 6c 6c 79 20 6c 69 6e 74 65 64 20 74 6f 20 63 68 65 63 6b 20 74 68 65 20 61 64 64 72 65 73 73 20 | lly.linted.to.check.the.address. |
1400 | 73 70 61 63 65 20 61 6e 64 20 6c 69 6e 65 20 6c 65 6e 67 74 68 2e 00 45 61 63 68 20 70 61 67 65 | space.and.line.length..Each.page |
1420 | 20 6d 75 73 74 20 63 6f 6e 74 61 69 6e 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 70 61 72 74 | .must.contain.the.following.part |
1440 | 73 3a 00 45 78 63 65 70 74 20 69 6e 20 60 60 2e 2e 20 63 6f 64 65 2d 62 6c 6f 63 6b 3a 3a 60 60 | s:.Except.in.``...code-block::`` |
1460 | 20 62 65 63 61 75 73 65 20 69 74 20 75 73 65 73 20 74 68 65 20 68 74 6d 6c 20 74 61 67 20 60 60 | .because.it.uses.the.html.tag.`` |
1480 | 3c 70 72 65 3e 60 60 20 61 6e 64 20 72 65 6e 64 65 72 73 20 74 68 65 20 73 61 6d 65 20 6c 69 6e | <pre>``.and.renders.the.same.lin |
14a0 | 65 20 66 6f 72 6d 61 74 20 66 72 6f 6d 20 74 68 65 20 73 6f 75 72 63 65 20 72 73 74 20 66 69 6c | e.format.from.the.source.rst.fil |
14c0 | 65 2e 00 46 6f 72 20 61 6e 20 69 6e 6c 69 6e 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6c | e..For.an.inline.configuration.l |
14e0 | 65 76 65 6c 20 63 6f 6d 6d 61 6e 64 2c 20 75 73 65 20 60 60 3a 63 66 67 63 6d 64 3a 60 60 00 46 | evel.command,.use.``:cfgcmd:``.F |
1500 | 6f 72 20 61 6e 20 69 6e 6c 69 6e 65 20 6f 70 65 72 61 74 69 6f 6e 61 6c 20 6c 65 76 65 6c 20 63 | or.an.inline.operational.level.c |
1520 | 6f 6d 6d 61 6e 64 2c 20 75 73 65 20 60 60 3a 6f 70 63 6d 64 3a 60 60 00 46 6f 72 20 65 78 61 6d | ommand,.use.``:opcmd:``.For.exam |
1540 | 70 6c 65 2c 20 79 6f 75 20 77 61 6e 74 20 74 6f 20 72 65 66 65 72 65 6e 63 65 20 74 68 65 20 68 | ple,.you.want.to.reference.the.h |
1560 | 65 61 64 6c 69 6e 65 20 2a 2a 56 4c 41 4e 2a 2a 20 69 6e 20 74 68 65 20 2a 2a 65 74 68 65 72 6e | eadline.**VLAN**.in.the.**ethern |
1580 | 65 74 2e 72 73 74 2a 2a 20 70 61 67 65 2e 20 54 68 65 20 70 6c 75 67 69 6e 20 67 65 6e 65 72 61 | et.rst**.page..The.plugin.genera |
15a0 | 74 65 73 20 74 68 65 20 6c 61 62 65 6c 20 62 61 73 65 64 20 6f 6e 20 74 68 65 20 68 65 61 64 6c | tes.the.label.based.on.the.headl |
15c0 | 69 6e 65 20 61 6e 64 20 74 68 65 20 66 69 6c 65 20 70 61 74 68 2e 00 46 6f 72 20 65 78 61 6d 70 | ine.and.the.file.path..For.examp |
15e0 | 6c 65 3a 00 46 6f 72 6b 20 74 68 69 73 20 70 72 6f 6a 65 63 74 20 6f 6e 20 47 69 74 48 75 62 20 | le:.Fork.this.project.on.GitHub. |
1600 | 68 74 74 70 73 3a 2f 2f 67 69 74 68 75 62 2e 63 6f 6d 2f 76 79 6f 73 2f 76 79 6f 73 2d 64 6f 63 | https://github.com/vyos/vyos-doc |
1620 | 75 6d 65 6e 74 61 74 69 6f 6e 2f 66 6f 72 6b 00 46 6f 72 6b 69 6e 67 20 57 6f 72 6b 66 6c 6f 77 | umentation/fork.Forking.Workflow |
1640 | 00 46 6f 72 6d 61 74 69 6e 67 20 61 6e 64 20 53 70 68 69 6e 78 6d 61 72 6b 75 70 00 46 6f 72 6d | .Formating.and.Sphinxmarkup.Form |
1660 | 61 74 74 69 6e 67 20 61 6e 64 20 53 70 68 69 6e 78 6d 61 72 6b 75 70 00 47 65 6e 65 72 61 6c 20 | atting.and.Sphinxmarkup.General. |
1680 | 63 6f 6e 63 65 70 74 73 20 66 6f 72 20 74 72 6f 75 62 6c 65 73 68 6f 6f 74 69 6e 67 20 61 6e 64 | concepts.for.troubleshooting.and |
16a0 | 20 64 65 74 61 69 6c 65 64 20 70 72 6f 63 65 73 73 20 64 65 73 63 72 69 70 74 69 6f 6e 73 20 62 | .detailed.process.descriptions.b |
16c0 | 65 6c 6f 6e 67 20 68 65 72 65 2e 00 47 75 69 64 65 6c 69 6e 65 73 00 49 66 20 74 68 65 72 65 20 | elong.here..Guidelines.If.there. |
16e0 | 73 6f 6d 65 20 74 72 6f 75 62 6c 65 73 68 6f 6f 74 69 6e 67 20 67 75 69 64 65 73 20 72 65 6c 61 | some.troubleshooting.guides.rela |
1700 | 74 65 64 20 74 6f 20 74 68 65 20 63 6f 6d 6d 61 6e 64 73 2e 20 45 78 70 6c 61 69 6e 20 69 74 20 | ted.to.the.commands..Explain.it. |
1720 | 69 6e 20 74 68 65 20 6e 65 78 74 20 6f 70 74 69 6f 6e 61 6c 20 70 61 72 74 2e 00 49 66 20 79 6f | in.the.next.optional.part..If.yo |
1740 | 75 20 61 6c 73 6f 20 77 61 6e 74 20 74 6f 20 75 70 64 61 74 65 20 79 6f 75 72 20 66 6f 72 6b 20 | u.also.want.to.update.your.fork. |
1760 | 6f 6e 20 47 69 74 48 75 62 2c 20 75 73 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 3a 20 60 60 | on.GitHub,.use.the.following:.`` |
1780 | 24 20 67 69 74 20 70 75 73 68 20 6f 72 69 67 69 6e 20 63 75 72 72 65 6e 74 60 60 00 49 66 20 79 | $.git.push.origin.current``.If.y |
17a0 | 6f 75 20 61 6c 73 6f 20 77 61 6e 74 20 74 6f 20 75 70 64 61 74 65 20 79 6f 75 72 20 66 6f 72 6b | ou.also.want.to.update.your.fork |
17c0 | 20 6f 6e 20 47 69 74 48 75 62 2c 20 75 73 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 3a 20 60 | .on.GitHub,.use.the.following:.` |
17e0 | 60 24 20 67 69 74 20 70 75 73 68 20 6f 72 69 67 69 6e 20 6d 61 73 74 65 72 60 60 00 49 66 20 79 | `$.git.push.origin.master``.If.y |
1800 | 6f 75 20 61 72 65 20 77 69 6c 6c 69 6e 67 20 74 6f 20 63 6f 6e 74 72 69 62 75 74 65 20 74 6f 20 | ou.are.willing.to.contribute.to. |
1820 | 6f 75 72 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 74 68 69 73 20 69 73 20 74 68 65 20 64 65 | our.documentation.this.is.the.de |
1840 | 66 69 6e 69 74 65 20 67 75 69 64 65 20 68 6f 77 20 74 6f 20 64 6f 20 73 6f 2e 00 49 6e 20 63 6f | finite.guide.how.to.do.so..In.co |
1860 | 6e 74 72 61 73 74 20 74 6f 20 73 75 62 6d 69 74 74 69 6e 67 20 63 6f 64 65 20 70 61 74 63 68 65 | ntrast.to.submitting.code.patche |
1880 | 73 2c 20 74 68 65 72 65 20 69 73 20 6e 6f 20 72 65 71 75 69 72 65 6d 65 6e 74 20 74 68 61 74 20 | s,.there.is.no.requirement.that. |
18a0 | 79 6f 75 20 6f 70 65 6e 20 75 70 20 61 20 50 68 61 62 72 69 63 61 74 6f 72 5f 20 74 61 73 6b 20 | you.open.up.a.Phabricator_.task. |
18c0 | 70 72 69 6f 72 20 74 6f 20 73 75 62 6d 69 74 74 69 6e 67 20 61 20 50 75 6c 6c 2d 52 65 71 75 65 | prior.to.submitting.a.Pull-Reque |
18e0 | 73 74 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 49 6e 20 74 68 65 20 | st.to.the.documentation..In.the. |
1900 | 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 70 61 72 74 20 6f 66 20 74 68 65 20 70 61 67 65 2c 20 | configuration.part.of.the.page,. |
1920 | 61 6c 6c 20 70 6f 73 73 69 62 6c 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f | all.possible.configuration.optio |
1940 | 6e 73 20 73 68 6f 75 6c 64 20 62 65 20 64 6f 63 75 6d 65 6e 74 65 64 2e 20 55 73 65 20 60 60 2e | ns.should.be.documented..Use.``. |
1960 | 2e 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 65 73 63 72 69 62 65 64 20 61 62 6f 76 65 2e 00 49 6e | ..cfgcmd::``.described.above..In |
1980 | 64 65 6e 74 20 77 69 74 68 20 74 77 6f 20 73 70 61 63 65 73 2e 00 49 6e 73 74 61 6c 6c 20 74 68 | dent.with.two.spaces..Install.th |
19a0 | 65 20 72 65 71 75 69 72 65 6d 65 6e 74 73 20 60 60 24 20 70 69 70 20 69 6e 73 74 61 6c 6c 20 2d | e.requirements.``$.pip.install.- |
19c0 | 72 20 72 65 71 75 69 72 65 6d 65 6e 74 73 2e 74 78 74 60 60 20 28 6f 72 20 73 6f 6d 65 74 68 69 | r.requirements.txt``.(or.somethi |
19e0 | 6e 67 20 73 69 6d 69 6c 61 72 29 00 4c 65 61 76 65 20 61 20 6e 65 77 6c 69 6e 65 20 62 65 66 6f | ng.similar).Leave.a.newline.befo |
1a00 | 72 65 20 61 6e 64 20 61 66 74 65 72 20 61 20 68 65 61 64 65 72 2e 00 4c 69 6d 69 74 20 61 6c 6c | re.and.after.a.header..Limit.all |
1a20 | 20 6c 69 6e 65 73 20 74 6f 20 61 20 6d 61 78 69 6d 75 6d 20 6f 66 20 38 30 20 63 68 61 72 61 63 | .lines.to.a.maximum.of.80.charac |
1a40 | 74 65 72 73 2e 00 4c 69 6e 65 20 6c 65 6e 67 74 68 00 4d 61 6b 65 20 61 6c 6c 20 79 6f 75 72 20 | ters..Line.length.Make.all.your. |
1a60 | 63 68 61 6e 67 65 73 20 2d 20 70 6c 65 61 73 65 20 6b 65 65 70 20 6f 75 72 20 63 6f 6d 6d 69 74 | changes.-.please.keep.our.commit |
1a80 | 20 72 75 6c 65 73 20 69 6e 20 6d 69 6e 64 20 28 3a 72 65 66 3a 60 70 72 65 70 61 72 65 5f 63 6f | .rules.in.mind.(:ref:`prepare_co |
1aa0 | 6d 6d 69 74 60 29 2e 20 54 68 69 73 20 6d 61 69 6e 6c 79 20 61 70 70 6c 69 65 73 20 74 6f 20 70 | mmit`)..This.mainly.applies.to.p |
1ac0 | 72 6f 70 65 72 20 63 6f 6d 6d 69 74 20 6d 65 73 73 61 67 65 73 20 64 65 73 63 72 69 62 69 6e 67 | roper.commit.messages.describing |
1ae0 | 20 79 6f 75 72 20 63 68 61 6e 67 65 20 28 68 6f 77 20 61 6e 64 20 77 68 79 29 2e 20 50 6c 65 61 | .your.change.(how.and.why)..Plea |
1b00 | 73 65 20 63 68 65 63 6b 20 6f 75 74 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 6f | se.check.out.the.documentation.o |
1b20 | 66 20 53 70 68 69 6e 78 2d 64 6f 63 5f 20 6f 72 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 | f.Sphinx-doc_.or.reStructuredTex |
1b40 | 74 5f 20 69 66 20 79 6f 75 20 61 72 65 20 6e 6f 74 20 66 61 6d 69 6c 69 61 72 20 77 69 74 68 20 | t_.if.you.are.not.familiar.with. |
1b60 | 69 74 2e 20 54 68 69 73 20 69 73 20 75 73 65 64 20 66 6f 72 20 77 72 69 74 69 6e 67 20 6f 75 72 | it..This.is.used.for.writing.our |
1b80 | 20 64 6f 63 73 2e 20 41 64 64 69 74 69 6f 6e 61 6c 20 64 69 72 65 63 74 69 76 65 73 20 68 6f 77 | .docs..Additional.directives.how |
1ba0 | 20 74 6f 20 77 72 69 74 65 20 69 6e 20 52 53 54 20 63 61 6e 20 62 65 20 6f 62 74 61 69 6e 65 64 | .to.write.in.RST.can.be.obtained |
1bc0 | 20 66 72 6f 6d 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 44 69 72 65 63 74 69 76 65 73 | .from.reStructuredTextDirectives |
1be0 | 5f 2e 00 4d 75 6c 74 69 63 61 73 74 20 4d 41 43 2d 41 64 64 72 65 73 73 65 73 3a 20 60 60 39 30 | _..Multicast.MAC-Addresses:.``90 |
1c00 | 2d 31 30 2d 30 30 60 60 20 74 6f 20 60 60 39 30 2d 31 30 2d 46 46 60 60 00 4e 6f 74 65 20 74 68 | -10-00``.to.``90-10-FF``.Note.th |
1c20 | 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 52 46 43 73 20 28 3a 72 66 63 3a 60 35 37 33 37 60 2c 20 3a | e.following.RFCs.(:rfc:`5737`,.: |
1c40 | 72 66 63 3a 60 33 38 34 39 60 2c 20 3a 72 66 63 3a 60 35 33 38 39 60 20 61 6e 64 20 3a 72 66 63 | rfc:`3849`,.:rfc:`5389`.and.:rfc |
1c60 | 3a 60 37 30 34 32 60 29 2c 20 77 68 69 63 68 20 64 65 73 63 72 69 62 65 20 74 68 65 20 72 65 73 | :`7042`),.which.describe.the.res |
1c80 | 65 72 76 65 64 20 70 75 62 6c 69 63 20 49 50 20 61 64 64 72 65 73 73 65 73 20 61 6e 64 20 61 75 | erved.public.IP.addresses.and.au |
1ca0 | 74 6f 6e 6f 6d 6f 75 73 20 73 79 73 74 65 6d 20 6e 75 6d 62 65 72 73 20 66 6f 72 20 74 68 65 20 | tonomous.system.numbers.for.the. |
1cc0 | 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 3a 00 4f 6e 63 65 20 70 75 6c 6c 20 72 65 71 75 65 73 74 | documentation:.Once.pull.request |
1ce0 | 73 20 68 61 76 65 20 62 65 65 6e 20 61 70 70 72 6f 76 65 64 2c 20 79 6f 75 20 6d 61 79 20 77 61 | s.have.been.approved,.you.may.wa |
1d00 | 6e 74 20 74 6f 20 6c 6f 63 61 6c 6c 79 20 75 70 64 61 74 65 20 79 6f 75 72 20 66 6f 72 6b 65 64 | nt.to.locally.update.your.forked |
1d20 | 20 72 65 70 6f 73 69 74 6f 72 79 20 74 6f 6f 2e 20 46 69 72 73 74 20 79 6f 75 27 6c 6c 20 68 61 | .repository.too..First.you'll.ha |
1d40 | 76 65 20 74 6f 20 61 64 64 20 61 20 73 65 63 6f 6e 64 20 72 65 6d 6f 74 65 20 63 61 6c 6c 65 64 | ve.to.add.a.second.remote.called |
1d60 | 20 60 75 70 73 74 72 65 61 6d 60 20 77 68 69 63 68 20 70 6f 69 6e 74 73 20 74 6f 20 6f 75 72 20 | .`upstream`.which.points.to.our. |
1d80 | 6d 61 69 6e 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 60 60 24 20 67 69 74 20 72 65 6d 6f 74 65 20 | main.repository..``$.git.remote. |
1da0 | 61 64 64 20 75 70 73 74 72 65 61 6d 20 68 74 74 70 73 3a 2f 2f 67 69 74 68 75 62 2e 63 6f 6d 2f | add.upstream.https://github.com/ |
1dc0 | 76 79 6f 73 2f 76 79 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 67 69 74 60 60 00 4f 70 | vyos/vyos-documentation.git``.Op |
1de0 | 65 72 61 74 69 6f 6e 20 6d 6f 64 65 20 63 6f 6d 6d 61 6e 64 73 20 74 68 61 74 20 64 6f 20 6e 6f | eration.mode.commands.that.do.no |
1e00 | 74 20 66 69 74 20 69 6e 20 61 20 72 65 6c 61 74 65 64 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e | t.fit.in.a.related.configuration |
1e20 | 20 6d 6f 64 65 20 63 6f 6d 6d 61 6e 64 20 6d 75 73 74 20 62 65 20 64 6f 63 75 6d 65 6e 74 65 64 | .mode.command.must.be.documented |
1e40 | 20 69 6e 20 74 68 69 73 20 70 61 72 74 20 6f 66 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 | .in.this.part.of.the.documentati |
1e60 | 6f 6e 2e 00 4f 70 65 72 61 74 69 6f 6e 20 6d 6f 64 65 20 70 61 67 65 73 00 50 61 67 65 20 63 6f | on..Operation.mode.pages.Page.co |
1e80 | 6e 74 65 6e 74 00 50 6c 65 61 73 65 20 64 6f 20 6e 6f 74 20 75 73 65 20 6f 74 68 65 72 20 70 75 | ntent.Please.do.not.use.other.pu |
1ea0 | 62 6c 69 63 20 61 64 64 72 65 73 73 20 73 70 61 63 65 2e 00 50 72 61 63 74 69 63 61 6c 20 65 78 | blic.address.space..Practical.ex |
1ec0 | 61 6d 70 6c 65 73 20 6f 66 20 74 68 65 20 73 65 72 76 69 63 65 20 6f 72 20 75 73 65 20 63 61 73 | amples.of.the.service.or.use.cas |
1ee0 | 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2e 20 54 68 65 79 20 6d 75 73 74 20 63 6f 6e 74 61 | e.configuration..They.must.conta |
1f00 | 69 6e 20 74 6f 70 6f 6c 6f 67 79 20 6d 61 70 73 20 28 69 66 20 61 70 70 6c 69 63 61 62 6c 65 29 | in.topology.maps.(if.applicable) |
1f20 | 20 61 6e 64 20 73 68 6f 72 74 20 64 65 73 63 72 69 70 74 69 6f 6e 73 2e 00 50 72 6f 70 65 72 6c | .and.short.descriptions..Properl |
1f40 | 79 20 71 75 6f 74 65 20 63 6f 6d 6d 61 6e 64 73 2c 20 66 69 6c 65 6e 61 6d 65 73 20 61 6e 64 20 | y.quote.commands,.filenames.and. |
1f60 | 62 72 69 65 66 20 63 6f 64 65 20 73 6e 69 70 70 65 74 73 20 77 69 74 68 20 64 6f 75 62 6c 65 20 | brief.code.snippets.with.double. |
1f80 | 62 61 63 6b 74 69 63 6b 73 2e 00 50 75 73 68 20 63 6f 6d 6d 69 74 73 20 74 6f 20 79 6f 75 72 20 | backticks..Push.commits.to.your. |
1fa0 | 47 69 74 48 75 62 20 70 72 6f 6a 65 63 74 3a 20 60 60 24 20 67 69 74 20 70 75 73 68 20 2d 75 20 | GitHub.project:.``$.git.push.-u. |
1fc0 | 6f 72 69 67 69 6e 20 3c 62 72 61 6e 63 68 2d 6e 61 6d 65 3e 60 60 00 52 65 6c 61 74 65 64 20 6f | origin.<branch-name>``.Related.o |
1fe0 | 70 65 72 61 74 69 6f 6e 20 63 6f 6d 6d 61 6e 64 20 6d 75 73 74 20 62 65 20 64 6f 63 75 6d 65 6e | peration.command.must.be.documen |
2000 | 74 65 64 20 69 6e 20 74 68 65 20 6e 65 78 74 20 70 61 72 74 20 6f 66 20 74 68 65 20 61 72 74 69 | ted.in.the.next.part.of.the.arti |
2020 | 63 6c 65 2e 20 55 73 65 20 60 60 3a 3a 6f 70 63 6d 64 2e 2e 60 60 20 66 6f 72 20 74 68 65 73 65 | cle..Use.``::opcmd..``.for.these |
2040 | 20 63 6f 6d 6d 61 6e 64 73 2e 00 53 6f 6d 65 74 69 6d 65 73 20 69 74 20 69 73 20 6e 65 63 65 73 | .commands..Sometimes.it.is.neces |
2060 | 73 61 72 79 20 74 6f 20 70 72 6f 76 69 64 65 20 72 65 61 6c 20 49 50 20 61 64 64 72 65 73 73 65 | sary.to.provide.real.IP.addresse |
2080 | 73 20 6c 69 6b 65 20 69 6e 20 74 68 65 20 3a 72 65 66 3a 60 65 78 61 6d 70 6c 65 73 60 2e 20 46 | s.like.in.the.:ref:`examples`..F |
20a0 | 6f 72 20 74 68 69 73 2c 20 70 6c 65 61 73 65 20 75 73 65 20 74 68 65 20 73 70 68 69 6e 78 20 63 | or.this,.please.use.the.sphinx.c |
20c0 | 6f 6d 6d 65 6e 74 20 73 79 6e 74 61 78 20 60 60 2e 2e 20 73 74 6f 70 5f 76 79 6f 73 6c 69 6e 74 | omment.syntax.``...stop_vyoslint |
20e0 | 65 72 60 60 20 74 6f 20 73 74 6f 70 20 74 68 65 20 6c 69 6e 74 65 72 20 61 6e 64 20 60 60 2e 2e | er``.to.stop.the.linter.and.``.. |
2100 | 20 73 74 61 72 74 5f 76 79 6f 73 6c 69 6e 74 65 72 60 60 20 74 6f 20 73 74 61 72 74 2e 00 53 74 | .start_vyoslinter``.to.start..St |
2120 | 79 6c 65 20 47 75 69 64 65 00 53 75 62 6d 69 74 20 70 75 6c 6c 2d 72 65 71 75 65 73 74 2e 20 49 | yle.Guide.Submit.pull-request..I |
2140 | 6e 20 47 69 74 48 75 62 20 76 69 73 69 74 20 74 68 65 20 6d 61 69 6e 20 72 65 70 6f 73 69 74 6f | n.GitHub.visit.the.main.reposito |
2160 | 72 79 20 61 6e 64 20 79 6f 75 20 73 68 6f 75 6c 64 20 73 65 65 20 61 20 62 61 6e 6e 65 72 20 73 | ry.and.you.should.see.a.banner.s |
2180 | 75 67 67 65 73 74 69 6e 67 20 74 6f 20 6d 61 6b 65 20 61 20 70 75 6c 6c 20 72 65 71 75 65 73 74 | uggesting.to.make.a.pull.request |
21a0 | 2e 20 46 69 6c 6c 20 6f 75 74 20 74 68 65 20 66 6f 72 6d 20 61 6e 64 20 64 65 73 63 72 69 62 65 | ..Fill.out.the.form.and.describe |
21c0 | 20 77 68 61 74 20 79 6f 75 20 64 6f 2e 00 54 4f 43 20 4c 65 76 65 6c 00 54 61 6b 65 20 61 20 6c | .what.you.do..TOC.Level.Take.a.l |
21e0 | 6f 6f 6b 20 61 74 20 74 68 65 20 3a 64 6f 63 3a 60 2f 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 60 | ook.at.the.:doc:`/documentation` |
2200 | 20 70 61 67 65 20 66 6f 72 20 61 6e 20 69 6e 74 72 69 63 61 74 65 20 65 78 70 6c 61 6e 61 74 69 | .page.for.an.intricate.explanati |
2220 | 6f 6e 20 6f 66 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 70 72 6f 63 65 73 73 2e | on.of.the.documentation.process. |
2240 | 00 54 68 65 20 46 6f 72 6b 69 6e 67 20 57 6f 72 6b 66 6c 6f 77 20 69 73 20 66 75 6e 64 61 6d 65 | .The.Forking.Workflow.is.fundame |
2260 | 6e 74 61 6c 6c 79 20 64 69 66 66 65 72 65 6e 74 20 66 72 6f 6d 20 6f 74 68 65 72 20 70 6f 70 75 | ntally.different.from.other.popu |
2280 | 6c 61 72 20 47 69 74 20 77 6f 72 6b 66 6c 6f 77 73 2e 20 49 6e 73 74 65 61 64 20 6f 66 20 75 73 | lar.Git.workflows..Instead.of.us |
22a0 | 69 6e 67 20 61 20 73 69 6e 67 6c 65 20 73 65 72 76 65 72 2d 73 69 64 65 20 72 65 70 6f 73 69 74 | ing.a.single.server-side.reposit |
22c0 | 6f 72 79 20 74 6f 20 61 63 74 20 61 73 20 74 68 65 20 22 63 65 6e 74 72 61 6c 22 20 63 6f 64 65 | ory.to.act.as.the."central".code |
22e0 | 62 61 73 65 2c 20 69 74 20 67 69 76 65 73 20 65 76 65 72 79 20 64 65 76 65 6c 6f 70 65 72 20 74 | base,.it.gives.every.developer.t |
2300 | 68 65 69 72 20 6f 77 6e 20 73 65 72 76 65 72 2d 73 69 64 65 20 72 65 70 6f 73 69 74 6f 72 79 2e | heir.own.server-side.repository. |
2320 | 20 54 68 69 73 20 6d 65 61 6e 73 20 74 68 61 74 20 65 61 63 68 20 63 6f 6e 74 72 69 62 75 74 6f | .This.means.that.each.contributo |
2340 | 72 20 68 61 73 20 6e 6f 74 20 6f 6e 65 2c 20 62 75 74 20 74 77 6f 20 47 69 74 20 72 65 70 6f 73 | r.has.not.one,.but.two.Git.repos |
2360 | 69 74 6f 72 69 65 73 3a 20 61 20 70 72 69 76 61 74 65 20 6c 6f 63 61 6c 20 6f 6e 65 20 61 6e 64 | itories:.a.private.local.one.and |
2380 | 20 61 20 70 75 62 6c 69 63 20 73 65 72 76 65 72 2d 73 69 64 65 20 6f 6e 65 2e 00 54 68 65 20 61 | .a.public.server-side.one..The.a |
23a0 | 72 74 69 63 6c 65 20 73 74 61 72 74 73 20 77 69 74 68 20 61 20 73 68 6f 72 74 20 69 6e 74 72 6f | rticle.starts.with.a.short.intro |
23c0 | 64 75 63 74 69 6f 6e 20 61 62 6f 75 74 20 74 68 65 20 63 6f 6d 6d 61 6e 64 20 6f 72 20 74 68 65 | duction.about.the.command.or.the |
23e0 | 20 74 65 63 68 6e 6f 6c 6f 67 79 2e 20 50 6c 65 61 73 65 20 69 6e 63 6c 75 64 65 20 73 6f 6d 65 | .technology..Please.include.some |
2400 | 20 68 65 6c 70 66 75 6c 20 6c 69 6e 6b 73 20 6f 72 20 62 61 63 6b 67 72 6f 75 6e 64 20 69 6e 66 | .helpful.links.or.background.inf |
2420 | 6f 72 6d 61 74 69 6f 6e 2e 00 54 68 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 6f 64 65 | ormation..The.configuration.mode |
2440 | 20 66 6f 6c 64 65 72 20 61 6e 64 20 74 68 65 20 61 72 74 69 63 6c 65 73 20 63 6f 76 65 72 20 74 | .folder.and.the.articles.cover.t |
2460 | 68 65 20 73 70 65 63 69 66 69 63 20 6c 65 76 65 6c 20 6f 66 20 74 68 65 20 63 6f 6d 6d 61 6e 64 | he.specific.level.of.the.command |
2480 | 73 2e 20 54 68 65 20 65 78 61 63 74 20 6c 65 76 65 6c 20 64 65 70 65 6e 64 73 20 6f 6e 20 74 68 | s..The.exact.level.depends.on.th |
24a0 | 65 20 63 6f 6d 6d 61 6e 64 2e 20 54 68 69 73 20 73 68 6f 75 6c 64 20 70 72 6f 76 69 64 65 20 73 | e.command..This.should.provide.s |
24c0 | 74 61 62 69 6c 69 74 79 20 66 6f 72 20 55 52 4c 73 20 75 73 65 64 20 69 6e 20 74 68 65 20 66 6f | tability.for.URLs.used.in.the.fo |
24e0 | 72 75 6d 20 6f 72 20 62 6c 6f 67 70 6f 73 74 2e 00 54 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 | rum.or.blogpost..The.documentati |
2500 | 6f 6e 20 68 61 73 20 33 20 64 69 66 66 65 72 65 6e 74 20 74 79 70 65 73 20 6f 66 20 70 61 67 65 | on.has.3.different.types.of.page |
2520 | 73 2e 20 54 68 65 20 73 61 6d 65 20 6b 69 6e 64 20 6f 66 20 70 61 67 65 73 20 6d 75 73 74 20 68 | s..The.same.kind.of.pages.must.h |
2540 | 61 76 65 20 74 68 65 20 73 61 6d 65 20 73 74 72 75 63 74 75 72 65 20 74 6f 20 61 63 68 69 65 76 | ave.the.same.structure.to.achiev |
2560 | 65 20 61 20 72 65 63 6f 67 6e 69 74 69 6f 6e 20 66 61 63 74 6f 72 2e 00 54 68 65 20 64 6f 63 75 | e.a.recognition.factor..The.docu |
2580 | 6d 65 6e 74 61 74 69 6f 6e 20 73 6f 75 72 63 65 20 69 73 20 6b 65 70 74 20 69 6e 20 74 68 65 20 | mentation.source.is.kept.in.the. |
25a0 | 47 69 74 20 72 65 70 6f 73 69 74 6f 72 79 20 61 74 20 68 74 74 70 73 3a 2f 2f 67 69 74 68 75 62 | Git.repository.at.https://github |
25c0 | 2e 63 6f 6d 2f 76 79 6f 73 2f 76 79 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 61 6e 64 | .com/vyos/vyos-documentation.and |
25e0 | 20 79 6f 75 20 63 61 6e 20 66 6f 6c 6c 6f 77 20 74 68 65 20 69 6e 73 74 72 75 63 74 69 6f 6e 73 | .you.can.follow.the.instructions |
2600 | 20 69 6e 20 74 68 65 20 52 45 41 44 4d 45 2e 6d 64 5f 20 74 6f 20 62 75 69 6c 64 20 61 6e 64 20 | .in.the.README.md_.to.build.and. |
2620 | 74 65 73 74 20 79 6f 75 72 20 63 68 61 6e 67 65 73 2e 00 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 | test.your.changes..The.following |
2640 | 20 69 73 20 61 20 71 75 69 63 6b 20 73 75 6d 6d 61 72 79 20 6f 66 20 74 68 65 20 72 75 6c 65 73 | .is.a.quick.summary.of.the.rules |
2660 | 3a 00 54 68 65 20 6d 61 69 6e 20 61 64 76 61 6e 74 61 67 65 20 6f 66 20 74 68 65 20 46 6f 72 6b | :.The.main.advantage.of.the.Fork |
2680 | 69 6e 67 20 57 6f 72 6b 66 6c 6f 77 20 69 73 20 74 68 61 74 20 63 6f 6e 74 72 69 62 75 74 69 6f | ing.Workflow.is.that.contributio |
26a0 | 6e 73 20 63 61 6e 20 62 65 20 69 6e 74 65 67 72 61 74 65 64 20 77 69 74 68 6f 75 74 20 74 68 65 | ns.can.be.integrated.without.the |
26c0 | 20 6e 65 65 64 20 66 6f 72 20 65 76 65 72 79 62 6f 64 79 20 74 6f 20 70 75 73 68 20 74 6f 20 61 | .need.for.everybody.to.push.to.a |
26e0 | 20 73 69 6e 67 6c 65 20 63 65 6e 74 72 61 6c 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 44 65 76 65 | .single.central.repository..Deve |
2700 | 6c 6f 70 65 72 73 20 70 75 73 68 20 74 6f 20 74 68 65 69 72 20 6f 77 6e 20 73 65 72 76 65 72 2d | lopers.push.to.their.own.server- |
2720 | 73 69 64 65 20 72 65 70 6f 73 69 74 6f 72 69 65 73 2c 20 61 6e 64 20 6f 6e 6c 79 20 74 68 65 20 | side.repositories,.and.only.the. |
2740 | 70 72 6f 6a 65 63 74 20 6d 61 69 6e 74 61 69 6e 65 72 20 63 61 6e 20 70 75 73 68 20 74 6f 20 74 | project.maintainer.can.push.to.t |
2760 | 68 65 20 6f 66 66 69 63 69 61 6c 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 54 68 69 73 20 61 6c 6c | he.official.repository..This.all |
2780 | 6f 77 73 20 74 68 65 20 6d 61 69 6e 74 61 69 6e 65 72 20 74 6f 20 61 63 63 65 70 74 20 63 6f 6d | ows.the.maintainer.to.accept.com |
27a0 | 6d 69 74 73 20 66 72 6f 6d 20 61 6e 79 20 64 65 76 65 6c 6f 70 65 72 20 77 69 74 68 6f 75 74 20 | mits.from.any.developer.without. |
27c0 | 67 69 76 69 6e 67 20 74 68 65 6d 20 77 72 69 74 65 20 61 63 63 65 73 73 20 74 6f 20 74 68 65 20 | giving.them.write.access.to.the. |
27e0 | 6f 66 66 69 63 69 61 6c 20 63 6f 64 65 62 61 73 65 2e 00 54 68 65 20 70 6c 75 67 69 6e 20 77 69 | official.codebase..The.plugin.wi |
2800 | 6c 6c 20 77 61 72 6e 20 6f 6e 20 62 75 69 6c 64 20 69 66 20 61 20 68 65 61 64 6c 69 6e 65 20 68 | ll.warn.on.build.if.a.headline.h |
2820 | 61 73 20 61 20 64 75 70 6c 69 63 61 74 65 20 6e 61 6d 65 20 69 6e 20 74 68 65 20 73 61 6d 65 20 | as.a.duplicate.name.in.the.same. |
2840 | 64 6f 63 75 6d 65 6e 74 2e 20 54 6f 20 70 72 65 76 65 6e 74 20 74 68 69 73 20 77 61 72 6e 69 6e | document..To.prevent.this.warnin |
2860 | 67 2c 20 79 6f 75 20 68 61 76 65 20 74 6f 20 70 75 74 20 61 20 63 75 73 74 6f 6d 20 6c 69 6e 6b | g,.you.have.to.put.a.custom.link |
2880 | 20 6f 6e 20 74 6f 70 20 6f 66 20 74 68 65 20 68 65 61 64 6c 69 6e 65 2e 00 54 68 65 6f 72 65 74 | .on.top.of.the.headline..Theoret |
28a0 | 69 63 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 72 65 71 75 69 72 65 64 20 66 6f 72 20 75 73 | ical.information.required.for.us |
28c0 | 65 72 73 20 74 6f 20 75 6e 64 65 72 73 74 61 6e 64 20 74 68 65 20 6e 65 78 74 20 64 6f 63 75 6d | ers.to.understand.the.next.docum |
28e0 | 65 6e 74 20 73 65 63 74 69 6f 6e 73 3a 00 54 68 65 72 65 20 61 72 65 20 61 20 66 65 77 20 74 68 | ent.sections:.There.are.a.few.th |
2900 | 69 6e 67 73 20 74 6f 20 6b 65 65 70 20 69 6e 20 6d 69 6e 64 20 77 68 65 6e 20 63 6f 6e 74 72 69 | ings.to.keep.in.mind.when.contri |
2920 | 62 75 74 69 6e 67 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 66 6f 72 | buting.to.the.documentation,.for |
2940 | 20 74 68 65 20 73 61 6b 65 20 6f 66 20 63 6f 6e 73 69 73 74 65 6e 63 79 20 61 6e 64 20 72 65 61 | .the.sake.of.consistency.and.rea |
2960 | 64 61 62 69 6c 69 74 79 2e 00 54 68 69 73 20 73 65 63 74 69 6f 6e 20 6d 75 73 74 20 63 6f 6e 74 | dability..This.section.must.cont |
2980 | 61 69 6e 20 61 20 6c 69 73 74 20 6f 66 3a 00 54 6f 20 65 78 74 72 61 63 74 20 61 20 64 65 66 61 | ain.a.list.of:.To.extract.a.defa |
29a0 | 75 6c 74 76 61 6c 75 65 20 66 72 6f 6d 20 74 68 65 20 58 4d 4c 20 64 65 66 69 6e 69 74 69 6f 6e | ultvalue.from.the.XML.definition |
29c0 | 73 20 61 64 64 20 61 20 60 60 3a 64 65 66 61 75 6c 74 76 61 6c 75 65 3a 60 60 20 74 6f 20 60 60 | s.add.a.``:defaultvalue:``.to.`` |
29e0 | 2e 2e 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 69 72 65 63 74 69 76 65 2e 20 54 6f 20 68 61 76 65 | ...cfgcmd::``.directive..To.have |
2a00 | 20 74 68 69 73 20 66 65 61 74 75 72 65 20 6c 6f 63 61 6c 6c 79 2c 20 74 68 65 20 76 79 6f 73 2d | .this.feature.locally,.the.vyos- |
2a20 | 31 78 20 73 75 62 6d 6f 64 75 6c 65 20 6d 75 73 74 20 62 65 20 69 6e 69 74 69 61 6c 69 7a 65 64 | 1x.submodule.must.be.initialized |
2a40 | 20 62 65 66 6f 72 65 2e 20 50 6c 65 61 73 65 20 62 65 20 61 77 61 72 65 20 74 6f 20 6e 6f 74 20 | .before..Please.be.aware.to.not. |
2a60 | 75 70 64 61 74 65 20 74 68 65 20 73 75 62 6d 6f 64 75 6c 65 20 69 6e 20 79 6f 75 72 20 50 52 2e | update.the.submodule.in.your.PR. |
2a80 | 00 54 6f 20 6d 69 6e 69 6d 69 7a 65 20 72 65 64 75 6e 64 61 6e 63 79 2c 20 74 68 65 72 65 20 69 | .To.minimize.redundancy,.there.i |
2aa0 | 73 20 61 20 73 70 65 63 69 61 6c 20 69 6e 63 6c 75 64 65 20 64 69 72 65 63 74 69 76 65 2e 20 49 | s.a.special.include.directive..I |
2ac0 | 74 20 69 6e 63 6c 75 64 65 73 20 61 20 74 78 74 20 66 69 6c 65 20 61 6e 64 20 72 65 70 6c 61 63 | t.includes.a.txt.file.and.replac |
2ae0 | 65 20 74 68 65 20 60 60 7b 7b 20 76 61 72 30 20 7d 7d 60 60 20 2d 20 60 60 7b 7b 20 76 61 72 39 | e.the.``{{.var0.}}``.-.``{{.var9 |
2b00 | 20 7d 7d 60 60 20 77 69 74 68 20 74 68 65 20 63 6f 72 72 65 63 74 20 76 61 6c 75 65 2e 00 54 72 | .}}``.with.the.correct.value..Tr |
2b20 | 79 20 6e 6f 74 20 74 6f 20 65 78 63 65 65 64 20 38 30 20 63 68 61 72 61 63 74 65 72 73 20 70 65 | y.not.to.exceed.80.characters.pe |
2b40 | 72 20 6c 69 6e 65 2c 20 62 75 74 20 64 6f 6e 27 74 20 62 72 65 61 6b 20 55 52 4c 73 20 6f 76 65 | r.line,.but.don't.break.URLs.ove |
2b60 | 72 20 74 68 69 73 2e 00 55 6e 69 63 61 73 74 20 4d 41 43 20 41 64 64 72 65 73 73 65 73 3a 20 60 | r.this..Unicast.MAC.Addresses:.` |
2b80 | 60 30 30 2d 35 33 2d 30 30 60 60 20 74 6f 20 60 60 30 30 2d 35 33 2d 46 46 60 60 00 55 70 64 61 | `00-53-00``.to.``00-53-FF``.Upda |
2ba0 | 74 65 73 20 74 6f 20 6f 75 72 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20 | tes.to.our.documentation.should. |
2bc0 | 62 65 20 64 65 6c 69 76 65 72 65 64 20 62 79 20 61 20 47 69 74 48 75 62 20 70 75 6c 6c 2d 72 65 | be.delivered.by.a.GitHub.pull-re |
2be0 | 71 75 65 73 74 2e 20 54 68 69 73 20 72 65 71 75 69 72 65 73 20 79 6f 75 20 61 6c 72 65 61 64 79 | quest..This.requires.you.already |
2c00 | 20 68 61 76 65 20 61 20 47 69 74 48 75 62 20 61 63 63 6f 75 6e 74 2e 00 55 73 65 20 41 6d 65 72 | .have.a.GitHub.account..Use.Amer |
2c20 | 69 63 61 6e 20 45 6e 67 6c 69 73 68 20 61 74 20 61 6c 6c 20 74 69 6d 65 73 2e 20 49 74 27 73 20 | ican.English.at.all.times..It's. |
2c40 | 61 6c 77 61 79 73 20 61 20 67 6f 6f 64 20 69 64 65 61 20 74 6f 20 72 75 6e 20 79 6f 75 72 20 74 | always.a.good.idea.to.run.your.t |
2c60 | 65 78 74 20 74 68 72 6f 75 67 68 20 61 20 67 72 61 6d 6d 61 72 20 61 6e 64 20 73 70 65 6c 6c 20 | ext.through.a.grammar.and.spell. |
2c80 | 63 68 65 63 6b 65 72 2c 20 73 75 63 68 20 61 73 20 60 47 72 61 6d 6d 61 72 6c 79 60 5f 2e 00 55 | checker,.such.as.`Grammarly`_..U |
2ca0 | 73 65 20 6c 69 74 65 72 61 6c 20 62 6c 6f 63 6b 73 20 66 6f 72 20 6c 6f 6e 67 65 72 20 73 6e 69 | se.literal.blocks.for.longer.sni |
2cc0 | 70 70 65 74 73 2e 00 56 69 65 77 20 6d 6f 64 69 66 69 65 64 20 66 69 6c 65 73 20 62 79 20 63 61 | ppets..View.modified.files.by.ca |
2ce0 | 6c 6c 69 6e 67 20 60 60 24 20 67 69 74 20 73 74 61 74 75 73 60 60 2e 20 59 6f 75 20 77 69 6c 6c | lling.``$.git.status``..You.will |
2d00 | 20 67 65 74 20 61 6e 20 6f 76 65 72 76 69 65 77 20 6f 66 20 61 6c 6c 20 66 69 6c 65 73 20 6d 6f | .get.an.overview.of.all.files.mo |
2d20 | 64 69 66 69 65 64 20 62 79 20 79 6f 75 2e 20 59 6f 75 20 63 61 6e 20 61 64 64 20 69 6e 64 69 76 | dified.by.you..You.can.add.indiv |
2d40 | 69 64 75 61 6c 20 66 69 6c 65 73 20 74 6f 20 74 68 65 20 47 69 74 20 49 6e 64 65 78 20 69 6e 20 | idual.files.to.the.Git.Index.in. |
2d60 | 74 68 65 20 6e 65 78 74 20 73 74 65 70 2e 00 56 79 4f 53 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f | the.next.step..VyOS.documentatio |
2d80 | 6e 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 | n.is.written.in.reStructuredText |
2da0 | 20 61 6e 64 20 67 65 6e 65 72 61 74 65 64 20 74 6f 20 52 65 61 64 20 74 68 65 20 44 6f 63 73 20 | .and.generated.to.Read.the.Docs. |
2dc0 | 70 61 67 65 73 20 77 69 74 68 20 53 70 68 69 6e 78 2c 20 61 73 20 70 65 72 20 74 68 65 20 50 79 | pages.with.Sphinx,.as.per.the.Py |
2de0 | 74 68 6f 6e 20 74 72 61 64 69 74 69 6f 6e 2c 20 61 73 20 77 65 6c 6c 20 61 73 20 50 44 46 20 66 | thon.tradition,.as.well.as.PDF.f |
2e00 | 69 6c 65 73 20 66 6f 72 20 6f 66 66 6c 69 6e 65 20 75 73 65 20 74 68 72 6f 75 67 68 20 4c 61 54 | iles.for.offline.use.through.LaT |
2e20 | 65 58 2e 20 57 65 20 77 65 6c 63 6f 6d 65 20 61 6c 6c 20 73 6f 72 74 73 20 6f 66 20 63 6f 6e 74 | eX..We.welcome.all.sorts.of.cont |
2e40 | 72 69 62 75 74 69 6f 6e 73 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 | ributions.to.the.documentation.. |
2e60 | 4e 6f 74 20 6a 75 73 74 20 6e 65 77 20 61 64 64 69 74 69 6f 6e 73 20 62 75 74 20 61 6c 73 6f 20 | Not.just.new.additions.but.also. |
2e80 | 63 6f 72 72 65 63 74 69 6f 6e 73 20 74 6f 20 65 78 69 73 74 69 6e 67 20 64 6f 63 75 6d 65 6e 74 | corrections.to.existing.document |
2ea0 | 61 74 69 6f 6e 2e 00 56 79 4f 53 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 69 73 20 77 72 69 | ation..VyOS.documentation.is.wri |
2ec0 | 74 74 65 6e 20 69 6e 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 20 61 6e 64 20 67 65 6e | tten.in.reStructuredText.and.gen |
2ee0 | 65 72 61 74 65 64 20 74 6f 20 52 65 61 64 20 74 68 65 20 44 6f 63 73 20 70 61 67 65 73 20 77 69 | erated.to.Read.the.Docs.pages.wi |
2f00 | 74 68 20 53 70 68 69 6e 78 2c 20 61 73 20 70 65 72 20 74 68 65 20 50 79 74 68 6f 6e 20 74 72 61 | th.Sphinx,.as.per.the.Python.tra |
2f20 | 64 69 74 69 6f 6e 2e 20 57 65 20 77 65 6c 63 6f 6d 65 20 61 6c 6c 20 73 6f 72 74 73 20 6f 66 20 | dition..We.welcome.all.sorts.of. |
2f40 | 63 6f 6e 74 72 69 62 75 74 69 6f 6e 73 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 | contributions.to.the.documentati |
2f60 | 6f 6e 2e 20 4e 6f 74 20 6a 75 73 74 20 6e 65 77 20 61 64 64 69 74 69 6f 6e 73 20 62 75 74 20 61 | on..Not.just.new.additions.but.a |
2f80 | 6c 73 6f 20 63 6f 72 72 65 63 74 69 6f 6e 73 20 74 6f 20 65 78 69 73 74 69 6e 67 20 64 6f 63 75 | lso.corrections.to.existing.docu |
2fa0 | 6d 65 6e 74 61 74 69 6f 6e 2e 00 57 65 20 65 6e 63 6f 75 72 61 67 65 20 65 76 65 72 79 20 56 79 | mentation..We.encourage.every.Vy |
2fc0 | 4f 53 20 75 73 65 72 20 74 6f 20 68 65 6c 70 20 75 73 20 69 6d 70 72 6f 76 65 20 6f 75 72 20 64 | OS.user.to.help.us.improve.our.d |
2fe0 | 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 61 73 20 77 65 20 68 61 76 65 20 61 20 64 65 66 69 63 69 | ocumentation.as.we.have.a.defici |
3000 | 74 20 6c 69 6b 65 20 6d 6f 73 74 20 73 6f 66 74 77 61 72 65 20 70 72 6f 6a 65 63 74 73 2e 20 20 | t.like.most.software.projects... |
3020 | 54 68 69 73 20 6e 6f 74 20 6f 6e 6c 79 20 68 65 6c 70 73 20 79 6f 75 20 77 68 65 6e 20 72 65 61 | This.not.only.helps.you.when.rea |
3040 | 64 69 6e 67 20 62 75 74 20 61 6c 73 6f 20 65 76 65 72 79 6f 6e 65 20 65 6c 73 65 2e 00 57 65 20 | ding.but.also.everyone.else..We. |
3060 | 75 73 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 73 79 6e 74 61 78 20 66 6f 72 20 48 65 61 | use.the.following.syntax.for.Hea |
3080 | 64 6c 69 6e 65 73 2e 00 57 68 65 6e 20 64 6f 63 75 6d 65 6e 74 69 6e 67 20 43 4c 49 20 63 6f 6d | dlines..When.documenting.CLI.com |
30a0 | 6d 61 6e 64 73 2c 20 75 73 65 20 74 68 65 20 60 60 2e 2e 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 | mands,.use.the.``...cfgcmd::``.d |
30c0 | 69 72 65 63 74 69 76 65 20 66 6f 72 20 61 6c 6c 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d | irective.for.all.configuration.m |
30e0 | 6f 64 65 20 63 6f 6d 6d 61 6e 64 73 2e 20 41 6e 20 65 78 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 | ode.commands..An.explanation.of. |
3100 | 74 68 65 20 64 65 73 63 72 69 62 65 64 20 63 6f 6d 6d 61 6e 64 20 73 68 6f 75 6c 64 20 62 65 20 | the.described.command.should.be. |
3120 | 61 64 64 65 64 20 62 65 6c 6f 77 20 74 68 69 73 20 73 74 61 74 65 6d 65 6e 74 2e 20 52 65 70 6c | added.below.this.statement..Repl |
3140 | 61 63 65 20 61 6c 6c 20 76 61 72 69 61 62 6c 65 20 63 6f 6e 74 65 6e 74 73 20 77 69 74 68 20 3c | ace.all.variable.contents.with.< |
3160 | 76 61 6c 75 65 3e 20 6f 72 20 73 6f 6d 65 74 68 69 6e 67 20 73 69 6d 69 6c 61 72 2e 00 57 68 65 | value>.or.something.similar..Whe |
3180 | 6e 20 64 6f 63 75 6d 65 6e 74 69 6e 67 20 6f 70 65 72 61 74 69 6f 6e 61 6c 20 6c 65 76 65 6c 20 | n.documenting.operational.level. |
31a0 | 63 6f 6d 6d 61 6e 64 73 2c 20 75 73 65 20 74 68 65 20 60 60 2e 2e 20 6f 70 63 6d 64 3a 3a 60 60 | commands,.use.the.``...opcmd::`` |
31c0 | 20 64 69 72 65 63 74 69 76 65 2e 20 41 6e 20 65 78 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 74 68 | .directive..An.explanation.of.th |
31e0 | 65 20 64 65 73 63 72 69 62 65 64 20 63 6f 6d 6d 61 6e 64 20 73 68 6f 75 6c 64 20 62 65 20 61 64 | e.described.command.should.be.ad |
3200 | 64 65 64 20 62 65 6c 6f 77 20 74 68 69 73 20 73 74 61 74 65 6d 65 6e 74 2e 00 57 68 65 6e 20 69 | ded.below.this.statement..When.i |
3220 | 6e 20 64 6f 75 62 74 2c 20 66 6f 6c 6c 6f 77 20 74 68 65 20 73 74 79 6c 65 20 6f 66 20 65 78 69 | n.doubt,.follow.the.style.of.exi |
3240 | 73 74 69 6e 67 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 57 68 65 6e 20 72 65 66 65 72 65 | sting.documentation..When.refere |
3260 | 6e 63 69 6e 67 20 74 6f 20 56 79 4f 53 20 50 68 61 62 72 69 63 61 74 6f 72 20 54 61 73 6b 73 2c | ncing.to.VyOS.Phabricator.Tasks, |
3280 | 20 74 68 65 72 65 20 69 73 20 61 20 63 75 73 74 6f 6d 20 53 70 68 69 6e 78 20 4d 61 72 6b 75 70 | .there.is.a.custom.Sphinx.Markup |
32a0 | 20 63 6f 6d 6d 61 6e 64 20 63 61 6c 6c 65 64 20 60 60 76 79 74 61 73 6b 60 60 20 74 68 61 74 20 | .command.called.``vytask``.that. |
32c0 | 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 65 6e 64 65 72 73 20 74 6f 20 61 20 70 72 6f 70 65 | automatically.renders.to.a.prope |
32e0 | 72 20 50 68 61 62 72 69 63 61 74 6f 72 20 55 52 4c 2e 20 54 68 69 73 20 69 73 20 68 65 61 76 69 | r.Phabricator.URL..This.is.heavi |
3300 | 6c 79 20 75 73 65 64 20 69 6e 20 74 68 65 20 3a 72 65 66 3a 60 72 65 6c 65 61 73 65 2d 6e 6f 74 | ly.used.in.the.:ref:`release-not |
3320 | 65 73 60 20 73 65 63 74 69 6f 6e 2e 00 57 69 74 68 20 74 68 6f 73 65 20 63 75 73 74 6f 6d 20 63 | es`.section..With.those.custom.c |
3340 | 6f 6d 6d 61 6e 64 73 2c 20 69 74 20 69 73 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 72 65 6e 64 65 | ommands,.it.is.possible.to.rende |
3360 | 72 20 74 68 65 6d 20 69 6e 20 61 20 6d 6f 72 65 20 64 65 73 63 72 69 70 74 69 76 65 20 77 61 79 | r.them.in.a.more.descriptive.way |
3380 | 20 69 6e 20 74 68 65 20 72 65 73 75 6c 74 69 6e 67 20 48 54 4d 4c 2f 50 44 46 20 6d 61 6e 75 61 | .in.the.resulting.HTML/PDF.manua |
33a0 | 6c 2e 00 57 69 74 68 20 74 68 6f 73 65 20 63 75 73 74 6f 6d 20 63 6f 6d 6d 61 6e 64 73 2c 20 69 | l..With.those.custom.commands,.i |
33c0 | 74 20 77 69 6c 6c 20 62 65 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 72 65 6e 64 65 72 20 74 68 65 | t.will.be.possible.to.render.the |
33e0 | 6d 20 69 6e 20 61 20 6d 6f 72 65 20 64 65 73 63 72 69 70 74 69 76 65 20 77 61 79 20 69 6e 20 74 | m.in.a.more.descriptive.way.in.t |
3400 | 68 65 20 72 65 73 75 6c 74 69 6e 67 20 48 54 4d 4c 2f 50 44 46 20 6d 61 6e 75 61 6c 2e 00 57 72 | he.resulting.HTML/PDF.manual..Wr |
3420 | 69 74 65 20 44 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 00 59 6f 75 20 63 61 6e 20 65 69 74 68 65 72 | ite.Documentation.You.can.either |
3440 | 20 69 6e 73 74 61 6c 6c 20 53 70 68 69 6e 78 20 28 61 6e 64 20 54 65 58 20 4c 69 76 65 20 66 6f | .install.Sphinx.(and.TeX.Live.fo |
3460 | 72 20 50 44 46 20 6f 75 74 70 75 74 29 20 61 6e 64 20 62 75 69 6c 64 20 74 68 65 20 64 6f 63 75 | r.PDF.output).and.build.the.docu |
3480 | 6d 65 6e 74 61 74 69 6f 6e 20 6c 6f 63 61 6c 6c 79 2c 20 6f 72 20 75 73 65 20 74 68 65 20 44 6f | mentation.locally,.or.use.the.Do |
34a0 | 63 6b 65 72 66 69 6c 65 5f 20 74 6f 20 62 75 69 6c 64 20 69 74 20 69 6e 20 61 20 63 6f 6e 74 61 | ckerfile_.to.build.it.in.a.conta |
34c0 | 69 6e 65 72 2e 00 59 6f 75 20 63 61 6e 20 65 69 74 68 65 72 20 69 6e 73 74 61 6c 6c 20 53 70 68 | iner..You.can.either.install.Sph |
34e0 | 69 6e 78 20 61 6e 64 20 62 75 69 6c 64 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 | inx.and.build.the.documentation. |
3500 | 6c 6f 63 61 6c 6c 79 2c 20 6f 72 20 75 73 65 20 74 68 65 20 44 6f 63 6b 65 72 66 69 6c 65 5f 20 | locally,.or.use.the.Dockerfile_. |
3520 | 74 6f 20 62 75 69 6c 64 20 69 74 20 69 6e 20 61 20 63 6f 6e 74 61 69 6e 65 72 2e 00 59 6f 75 72 | to.build.it.in.a.container..Your |
3540 | 20 72 65 6d 6f 74 65 20 72 65 70 6f 20 6f 6e 20 47 69 74 68 75 62 20 69 73 20 63 61 6c 6c 65 64 | .remote.repo.on.Github.is.called |
3560 | 20 60 60 6f 72 69 67 69 6e 60 60 2c 20 77 68 69 6c 65 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 | .``origin``,.while.the.original. |
3580 | 72 65 70 6f 20 79 6f 75 20 68 61 76 65 20 66 6f 72 6b 65 64 20 69 73 20 63 61 6c 6c 65 64 20 60 | repo.you.have.forked.is.called.` |
35a0 | 60 75 70 73 74 72 65 61 6d 60 60 2e 20 4e 6f 77 20 79 6f 75 20 63 61 6e 20 6c 6f 63 61 6c 6c 79 | `upstream``..Now.you.can.locally |
35c0 | 20 75 70 64 61 74 65 20 79 6f 75 72 20 66 6f 72 6b 65 64 20 72 65 70 6f 2e 00 60 60 31 39 32 2e | .update.your.forked.repo..``192. |
35e0 | 30 2e 32 2e 30 2f 32 34 60 60 00 60 60 31 39 38 2e 35 31 2e 31 30 30 2e 30 2f 32 34 60 60 00 60 | 0.2.0/24``.``198.51.100.0/24``.` |
3600 | 60 32 30 30 31 3a 64 62 38 3a 3a 2f 33 32 60 60 00 60 60 32 30 33 2e 30 2e 31 31 33 2e 30 2f 32 | `2001:db8::/32``.``203.0.113.0/2 |
3620 | 34 60 60 00 60 60 3a 72 65 66 3a 60 43 68 65 63 6b 20 6f 75 74 20 56 4c 41 4e 3c 63 6f 6e 66 69 | 4``.``:ref:`Check.out.VLAN<confi |
3640 | 67 75 72 61 74 69 6f 6e 2f 69 6e 74 65 72 66 61 63 65 73 2f 65 74 68 65 72 6e 65 74 3a 76 6c 61 | guration/interfaces/ethernet:vla |
3660 | 6e 3e 60 60 00 60 60 3a 72 65 66 3a 60 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2f 69 6e 74 65 72 | n>``.``:ref:`configuration/inter |
3680 | 66 61 63 65 73 2f 65 74 68 65 72 6e 65 74 3a 76 6c 61 6e 60 60 00 60 60 73 65 74 20 66 69 72 65 | faces/ethernet:vlan``.``set.fire |
36a0 | 77 61 6c 6c 20 7a 6f 6e 65 60 60 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 60 60 66 69 72 65 | wall.zone``.is.written.in.``fire |
36c0 | 77 61 6c 6c 2f 7a 6f 6e 65 2e 72 73 74 60 60 00 60 60 73 65 74 20 69 6e 74 65 72 66 61 63 65 73 | wall/zone.rst``.``set.interfaces |
36e0 | 20 65 74 68 65 72 6e 65 74 60 60 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 60 60 69 6e 74 65 | .ethernet``.is.written.in.``inte |
3700 | 72 66 61 63 65 73 2f 65 74 68 65 72 6e 65 74 2e 72 73 74 60 60 00 61 20 73 69 6d 70 6c 65 20 65 | rfaces/ethernet.rst``.a.simple.e |
3720 | 78 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 77 68 61 74 20 69 73 20 74 68 69 73 20 70 61 67 65 20 | xplanation.of.what.is.this.page. |
3740 | 61 62 6f 75 74 2c 20 77 68 79 20 6f 72 20 77 68 65 6e 20 69 74 20 69 73 20 72 65 71 75 69 72 65 | about,.why.or.when.it.is.require |
3760 | 64 20 74 6f 20 62 65 20 75 73 65 64 00 63 66 67 63 6d 64 00 63 6d 64 69 6e 63 6c 75 64 65 00 68 | d.to.be.used.cfgcmd.cmdinclude.h |
3780 | 61 6e 64 6c 65 20 62 75 69 6c 64 20 65 72 72 6f 72 73 00 68 6f 77 20 74 6f 20 63 6f 6c 6c 65 63 | andle.build.errors.how.to.collec |
37a0 | 74 20 6c 6f 67 73 20 6f 72 20 6f 74 68 65 72 20 64 65 62 75 67 67 69 6e 67 20 69 6e 66 6f 72 6d | t.logs.or.other.debugging.inform |
37c0 | 61 74 69 6f 6e 20 28 6c 69 6b 65 20 60 73 68 6f 77 60 20 63 6f 6d 6d 61 6e 64 73 20 6f 75 74 70 | ation.(like.`show`.commands.outp |
37e0 | 75 74 29 00 68 6f 77 20 74 6f 20 72 65 61 64 20 61 6e 64 20 77 68 61 74 20 74 6f 20 73 65 61 72 | ut).how.to.read.and.what.to.sear |
3800 | 63 68 20 66 6f 72 20 69 6e 20 6c 6f 67 73 20 61 6e 64 20 63 6f 6c 6c 65 63 74 65 64 20 69 6e 66 | ch.for.in.logs.and.collected.inf |
3820 | 6f 72 6d 61 74 69 6f 6e 00 6b 6e 6f 77 6e 20 69 73 73 75 65 73 20 6f 72 20 70 6f 74 65 6e 74 69 | ormation.known.issues.or.potenti |
3840 | 61 6c 20 70 72 6f 62 6c 65 6d 73 20 66 6f 72 20 74 68 65 20 73 65 72 76 69 63 65 20 6f 72 20 75 | al.problems.for.the.service.or.u |
3860 | 73 65 20 63 61 73 65 00 6f 70 63 6d 64 00 72 65 66 65 72 65 6e 63 65 73 20 74 6f 20 73 74 61 6e | se.case.opcmd.references.to.stan |
3880 | 64 61 72 64 73 2c 20 52 46 43 73 00 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20 69 6e 74 65 72 | dards,.RFCs.the.content.of.inter |
38a0 | 66 61 63 65 2d 61 64 64 72 65 73 73 2e 74 78 74 20 6c 6f 6f 6b 73 20 6c 69 6b 65 20 74 68 69 73 | face-address.txt.looks.like.this |
38c0 | 00 74 6f 20 75 73 65 20 61 6e 20 61 6c 74 65 72 6e 61 74 69 76 65 20 68 79 70 65 72 6c 69 6e 6b | .to.use.an.alternative.hyperlink |
38e0 | 20 75 73 65 20 69 74 20 74 68 69 73 20 77 61 79 3a 00 76 79 74 61 73 6b 00 77 68 61 74 20 61 72 | .use.it.this.way:.vytask.what.ar |
3900 | 65 20 69 6e 64 69 63 61 74 6f 72 73 20 6f 66 20 67 6f 6f 64 20 61 6e 64 20 62 61 64 20 73 74 61 | e.indicators.of.good.and.bad.sta |
3920 | 74 65 73 20 69 6e 20 64 65 62 75 67 67 69 6e 67 20 6f 75 74 70 75 74 73 00 77 6f 72 6b 61 72 6f | tes.in.debugging.outputs.workaro |
3940 | 75 6e 64 73 20 66 6f 72 20 6b 6e 6f 77 6e 20 69 73 73 75 65 73 20 28 69 66 20 61 6e 79 20 65 78 | unds.for.known.issues.(if.any.ex |
3960 | 69 73 74 29 00 4d 49 4d 45 2d 56 65 72 73 69 6f 6e 3a 20 31 2e 30 0a 43 6f 6e 74 65 6e 74 2d 54 | ist).MIME-Version:.1.0.Content-T |
3980 | 79 70 65 3a 20 74 65 78 74 2f 70 6c 61 69 6e 3b 20 63 68 61 72 73 65 74 3d 55 54 46 2d 38 0a 43 | ype:.text/plain;.charset=UTF-8.C |
39a0 | 6f 6e 74 65 6e 74 2d 54 72 61 6e 73 66 65 72 2d 45 6e 63 6f 64 69 6e 67 3a 20 38 62 69 74 0a 58 | ontent-Transfer-Encoding:.8bit.X |
39c0 | 2d 47 65 6e 65 72 61 74 6f 72 3a 20 4c 6f 63 61 6c 61 7a 79 20 28 68 74 74 70 73 3a 2f 2f 6c 6f | -Generator:.Localazy.(https://lo |
39e0 | 63 61 6c 61 7a 79 2e 63 6f 6d 29 0a 50 72 6f 6a 65 63 74 2d 49 64 2d 56 65 72 73 69 6f 6e 3a 20 | calazy.com).Project-Id-Version:. |
3a00 | 0a 4c 61 6e 67 75 61 67 65 3a 20 70 74 0a 50 6c 75 72 61 6c 2d 46 6f 72 6d 73 3a 20 6e 70 6c 75 | .Language:.pt.Plural-Forms:.nplu |
3a20 | 72 61 6c 73 3d 32 3b 20 70 6c 75 72 61 6c 3d 28 6e 3e 3d 30 20 26 26 20 6e 3c 3d 31 29 20 3f 20 | rals=2;.plural=(n>=0.&&.n<=1).?. |
3a40 | 30 20 3a 20 31 3b 0a 00 31 2e 20 54 68 65 6f 72 65 74 69 63 61 6c 20 69 6e 66 6f 72 6d 61 74 69 | 0.:.1;..1..Theoretical.informati |
3a60 | 6f 6e 00 31 36 62 69 74 20 41 53 4e 3a 20 60 60 36 34 34 39 36 20 2d 20 36 34 35 31 31 60 60 00 | on.16bit.ASN:.``64496.-.64511``. |
3a80 | 32 2e 20 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 64 65 73 63 72 69 70 74 69 6f 6e 00 33 2e 20 | 2..Configuration.description.3.. |
3aa0 | 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 65 78 61 6d 70 6c 65 73 00 33 32 62 69 74 20 41 53 4e | Configuration.examples.32bit.ASN |
3ac0 | 3a 20 60 60 36 35 35 33 36 20 2d 20 36 35 35 35 31 60 60 00 34 2e 20 4b 6e 6f 77 6e 20 69 73 73 | :.``65536.-.65551``.4..Known.iss |
3ae0 | 75 65 73 00 35 2e 20 44 65 62 75 67 67 69 6e 67 00 41 20 70 6c 75 67 69 6e 20 77 69 6c 6c 20 62 | ues.5..Debugging.A.plugin.will.b |
3b00 | 65 20 75 73 65 64 20 74 6f 20 67 65 6e 65 72 61 74 65 20 61 20 72 65 66 65 72 65 6e 63 65 20 6c | e.used.to.generate.a.reference.l |
3b20 | 61 62 65 6c 20 66 6f 72 20 65 61 63 68 20 68 65 61 64 6c 69 6e 65 2e 20 54 6f 20 72 65 66 65 72 | abel.for.each.headline..To.refer |
3b40 | 65 6e 63 65 20 61 20 70 61 67 65 20 6f 72 20 61 20 73 65 63 74 69 6f 6e 20 69 6e 20 74 68 65 20 | ence.a.page.or.a.section.in.the. |
3b60 | 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 75 73 65 20 74 68 65 20 60 60 3a 72 65 66 3a 60 60 20 | documentation.use.the.``:ref:``. |
3b80 | 63 6f 6d 6d 61 6e 64 2e 00 41 64 64 20 6d 6f 64 69 66 69 65 64 20 66 69 6c 65 73 20 74 6f 20 47 | command..Add.modified.files.to.G |
3ba0 | 69 74 20 69 6e 64 65 78 20 60 60 24 20 67 69 74 20 61 64 64 20 70 61 74 68 2f 74 6f 2f 66 69 6c | it.index.``$.git.add.path/to/fil |
3bc0 | 65 6e 61 6d 65 60 60 20 6f 72 20 61 64 64 20 61 6c 6c 20 75 6e 73 74 61 67 65 64 20 66 69 6c 65 | ename``.or.add.all.unstaged.file |
3be0 | 73 20 60 60 24 20 67 69 74 20 61 64 64 20 2e 60 60 2e 20 41 6c 6c 20 66 69 6c 65 73 20 61 64 64 | s.``$.git.add..``..All.files.add |
3c00 | 65 64 20 74 6f 20 74 68 65 20 47 69 74 20 69 6e 64 65 78 20 77 69 6c 6c 20 62 65 20 70 61 72 74 | ed.to.the.Git.index.will.be.part |
3c20 | 20 6f 66 20 79 6f 75 20 66 6f 6c 6c 6f 77 69 6e 67 20 47 69 74 20 63 6f 6d 6d 69 74 2e 00 41 64 | .of.you.following.Git.commit..Ad |
3c40 | 64 72 65 73 73 20 73 70 61 63 65 00 41 6c 6c 20 52 53 54 20 66 69 6c 65 73 20 6d 75 73 74 20 66 | dress.space.All.RST.files.must.f |
3c60 | 6f 6c 6c 6f 77 20 74 68 65 20 73 61 6d 65 20 54 4f 43 20 4c 65 76 65 6c 20 73 79 6e 74 61 78 20 | ollow.the.same.TOC.Level.syntax. |
3c80 | 61 6e 64 20 68 61 76 65 20 74 6f 20 73 74 61 72 74 20 77 69 74 68 00 41 6e 20 6f 70 74 69 6f 6e | and.have.to.start.with.An.option |
3ca0 | 61 6c 20 73 65 63 74 69 6f 6e 20 66 6f 6c 6c 6f 77 73 2e 20 53 6f 6d 65 20 63 6f 6d 6d 61 6e 64 | al.section.follows..Some.command |
3cc0 | 73 20 68 61 76 65 20 72 65 71 75 69 72 65 6d 65 6e 74 73 20 6c 69 6b 65 20 63 6f 6d 70 61 74 69 | s.have.requirements.like.compati |
3ce0 | 62 6c 65 20 68 61 72 64 77 61 72 65 20 28 65 2e 67 2e 20 57 69 66 69 29 20 6f 72 20 73 6f 6d 65 | ble.hardware.(e.g..Wifi).or.some |
3d00 | 20 63 6f 6d 6d 61 6e 64 73 20 79 6f 75 20 68 61 76 65 20 74 6f 20 73 65 74 20 62 65 66 6f 72 65 | .commands.you.have.to.set.before |
3d20 | 2e 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 69 74 20 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64 | ..For.example,.it.is.recommended |
3d40 | 20 74 6f 20 73 65 74 20 61 20 72 6f 75 74 65 2d 6d 61 70 20 62 65 66 6f 72 65 20 63 6f 6e 66 69 | .to.set.a.route-map.before.confi |
3d60 | 67 75 72 69 6e 67 20 42 47 50 2e 00 41 6e 64 20 66 69 6e 61 6c 6c 79 2c 20 72 65 6d 65 6d 62 65 | guring.BGP..And.finally,.remembe |
3d80 | 72 20 74 68 61 74 20 74 68 65 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 20 66 69 6c 65 | r.that.the.reStructuredText.file |
3da0 | 73 20 61 72 65 6e 27 74 20 65 78 63 6c 75 73 69 76 65 6c 79 20 66 6f 72 20 67 65 6e 65 72 61 74 | s.aren't.exclusively.for.generat |
3dc0 | 69 6e 67 20 48 54 4d 4c 20 61 6e 64 20 50 44 46 2e 20 54 68 65 79 20 73 68 6f 75 6c 64 20 62 65 | ing.HTML.and.PDF..They.should.be |
3de0 | 20 68 75 6d 61 6e 2d 72 65 61 64 61 62 6c 65 20 61 6e 64 20 65 61 73 69 6c 79 20 70 65 72 75 73 | .human-readable.and.easily.perus |
3e00 | 65 64 20 66 72 6f 6d 20 61 20 63 6f 6e 73 6f 6c 65 2e 00 41 6e 79 74 68 69 6e 67 20 65 6c 73 65 | ed.from.a.console..Anything.else |
3e20 | 00 41 6e 79 74 68 69 6e 67 20 65 6c 73 65 20 74 68 61 74 20 69 73 20 6e 6f 74 20 61 20 63 6f 6e | .Anything.else.that.is.not.a.con |
3e40 | 66 69 67 75 72 61 74 69 6f 6e 20 6f 72 20 61 6e 20 6f 70 65 72 61 74 69 6f 6e 20 63 6f 6d 6d 61 | figuration.or.an.operation.comma |
3e60 | 6e 64 20 68 61 73 20 6e 6f 20 70 72 65 64 65 66 69 6e 65 64 20 73 74 72 75 63 74 75 72 65 2e 00 | nd.has.no.predefined.structure.. |
3e80 | 41 75 74 6f 6c 69 6e 74 65 72 00 43 68 65 63 6b 20 79 6f 75 72 20 63 68 61 6e 67 65 73 20 62 79 | Autolinter.Check.your.changes.by |
3ea0 | 20 6c 6f 63 61 6c 6c 79 20 62 75 69 6c 64 69 6e 67 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 | .locally.building.the.documentat |
3ec0 | 69 6f 6e 20 60 60 24 20 6d 61 6b 65 20 6c 69 76 65 68 74 6d 6c 60 60 2e 20 53 70 68 69 6e 78 20 | ion.``$.make.livehtml``..Sphinx. |
3ee0 | 77 69 6c 6c 20 62 75 69 6c 64 20 74 68 65 20 68 74 6d 6c 20 66 69 6c 65 73 20 69 6e 20 74 68 65 | will.build.the.html.files.in.the |
3f00 | 20 60 60 64 6f 63 73 2f 5f 62 75 69 6c 64 60 60 20 66 6f 6c 64 65 72 2e 20 57 65 20 70 72 6f 76 | .``docs/_build``.folder..We.prov |
3f20 | 69 64 65 20 79 6f 75 20 77 69 74 68 20 61 20 44 6f 63 6b 65 72 20 63 6f 6e 74 61 69 6e 65 72 20 | ide.you.with.a.Docker.container. |
3f40 | 66 6f 72 20 61 6e 20 65 61 73 79 2d 74 6f 2d 75 73 65 20 75 73 65 72 20 65 78 70 65 72 69 65 6e | for.an.easy-to-use.user.experien |
3f60 | 63 65 2e 20 43 68 65 63 6b 20 74 68 65 20 52 45 41 44 4d 45 2e 6d 64 5f 20 66 69 6c 65 20 6f 66 | ce..Check.the.README.md_.file.of |
3f80 | 20 74 68 69 73 20 72 65 70 6f 73 69 74 6f 72 79 2e 00 43 68 65 63 6b 20 79 6f 75 72 20 63 6f 6e | .this.repository..Check.your.con |
3fa0 | 66 69 67 75 72 65 64 20 72 65 6d 6f 74 65 20 72 65 70 6f 73 69 74 6f 72 69 65 73 3a 00 43 6c 6f | figured.remote.repositories:.Clo |
3fc0 | 6e 65 20 66 6f 72 6b 20 74 6f 20 6c 6f 63 61 6c 20 6d 61 63 68 69 6e 65 2c 20 74 68 65 6e 20 63 | ne.fork.to.local.machine,.then.c |
3fe0 | 68 61 6e 67 65 20 74 6f 20 74 68 61 74 20 64 69 72 65 63 74 6f 72 79 20 60 60 24 20 63 64 20 76 | hange.to.that.directory.``$.cd.v |
4000 | 79 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 60 60 00 43 6f 6d 6d 69 74 20 79 6f 75 72 20 | yos-documentation``.Commit.your. |
4020 | 63 68 61 6e 67 65 73 20 77 69 74 68 20 74 68 65 20 6d 65 73 73 61 67 65 2c 20 60 60 24 20 67 69 | changes.with.the.message,.``$.gi |
4040 | 74 20 63 6f 6d 6d 69 74 20 2d 6d 20 22 3c 63 6f 6d 6d 69 74 20 6d 65 73 73 61 67 65 3e 22 60 60 | t.commit.-m."<commit.message>"`` |
4060 | 20 6f 72 20 20 75 73 65 20 60 60 24 20 67 69 74 20 63 6f 6d 6d 69 74 20 2d 76 60 60 20 74 6f 20 | .or..use.``$.git.commit.-v``.to. |
4080 | 68 61 76 65 20 79 6f 75 72 20 63 6f 6e 66 69 67 75 72 65 64 20 65 64 69 74 6f 72 20 6c 61 75 6e | have.your.configured.editor.laun |
40a0 | 63 68 65 64 2e 20 59 6f 75 20 63 61 6e 20 74 79 70 65 20 69 6e 20 61 20 63 6f 6d 6d 69 74 20 6d | ched..You.can.type.in.a.commit.m |
40c0 | 65 73 73 61 67 65 2e 20 41 67 61 69 6e 20 70 6c 65 61 73 65 20 6d 61 6b 65 20 79 6f 75 72 73 65 | essage..Again.please.make.yourse |
40e0 | 6c 66 20 63 6f 6d 66 6f 72 74 61 62 6c 65 20 77 69 74 68 6f 75 74 20 72 75 6c 65 73 20 28 3a 72 | lf.comfortable.without.rules.(:r |
4100 | 65 66 3a 60 70 72 65 70 61 72 65 5f 63 6f 6d 6d 69 74 60 29 2e 00 43 6f 6e 66 69 67 75 72 61 74 | ef:`prepare_commit`)..Configurat |
4120 | 69 6f 6e 20 6d 6f 64 65 20 70 61 67 65 73 00 43 72 65 61 74 65 20 61 20 6e 65 77 20 62 72 61 6e | ion.mode.pages.Create.a.new.bran |
4140 | 63 68 20 66 6f 72 20 79 6f 75 72 20 77 6f 72 6b 2c 20 75 73 65 20 61 20 64 65 73 63 72 69 70 74 | ch.for.your.work,.use.a.descript |
4160 | 69 76 65 20 6e 61 6d 65 20 6f 66 20 79 6f 75 72 20 77 6f 72 6b 3a 20 60 60 24 20 67 69 74 20 63 | ive.name.of.your.work:.``$.git.c |
4180 | 68 65 63 6b 6f 75 74 20 2d 62 20 3c 62 72 61 6e 63 68 2d 6e 61 6d 65 3e 60 60 00 43 72 6f 73 73 | heckout.-b.<branch-name>``.Cross |
41a0 | 2d 52 65 66 65 72 65 6e 63 65 73 00 43 75 73 74 6f 6d 20 53 70 68 69 6e 78 2d 64 6f 63 20 4d 61 | -References.Custom.Sphinx-doc.Ma |
41c0 | 72 6b 75 70 00 43 75 73 74 6f 6d 20 63 6f 6d 6d 61 6e 64 73 20 68 61 76 65 20 62 65 65 6e 20 64 | rkup.Custom.commands.have.been.d |
41e0 | 65 76 65 6c 6f 70 65 64 20 66 6f 72 20 77 72 69 74 69 6e 67 20 74 68 65 20 64 6f 63 75 6d 65 6e | eveloped.for.writing.the.documen |
4200 | 74 61 74 69 6f 6e 2e 20 50 6c 65 61 73 65 20 6d 61 6b 65 20 79 6f 75 72 73 65 6c 66 20 63 6f 6d | tation..Please.make.yourself.com |
4220 | 66 6f 72 74 61 62 6c 65 20 77 69 74 68 20 74 68 6f 73 65 20 63 6f 6d 6d 61 6e 64 73 20 61 73 20 | fortable.with.those.commands.as. |
4240 | 74 68 69 73 20 65 61 73 65 73 20 74 68 65 20 77 61 79 20 77 65 20 72 65 6e 64 65 72 20 74 68 65 | this.eases.the.way.we.render.the |
4260 | 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 44 65 73 63 72 69 62 65 20 43 4c 49 20 69 74 65 | .documentation..Describe.CLI.ite |
4280 | 6d 73 20 72 65 6c 61 74 65 64 20 74 6f 20 74 68 65 20 73 65 72 76 69 63 65 20 6f 72 20 75 73 65 | ms.related.to.the.service.or.use |
42a0 | 20 63 61 73 65 2e 20 45 61 63 68 20 63 6f 6e 66 69 67 20 6c 69 6e 65 20 6f 72 20 73 65 63 74 69 | .case..Each.config.line.or.secti |
42c0 | 6f 6e 20 6d 75 73 74 20 62 65 20 65 78 70 6c 61 69 6e 65 64 2c 20 75 73 69 6e 67 20 69 6e 66 6f | on.must.be.explained,.using.info |
42e0 | 72 6d 61 74 69 6f 6e 20 70 72 6f 76 69 64 65 64 20 69 6e 20 74 68 65 20 31 73 74 20 70 61 72 74 | rmation.provided.in.the.1st.part |
4300 | 20 6f 66 20 74 68 65 20 70 61 67 65 2e 00 44 65 73 63 72 69 62 65 64 20 70 72 6f 63 65 64 75 72 | .of.the.page..Described.procedur |
4320 | 65 73 20 66 6f 72 20 64 65 62 75 67 67 69 6e 67 20 61 20 73 65 72 76 69 63 65 3a 00 44 6f 6e 27 | es.for.debugging.a.service:.Don' |
4340 | 74 20 66 6f 72 67 65 74 20 74 6f 20 75 70 64 61 74 65 20 60 60 69 6e 64 65 78 2e 72 73 74 60 60 | t.forget.to.update.``index.rst`` |
4360 | 20 77 68 65 6e 20 61 64 64 69 6e 67 20 61 20 6e 65 77 20 6e 6f 64 65 2e 00 45 61 63 68 20 47 69 | .when.adding.a.new.node..Each.Gi |
4380 | 74 48 75 62 20 70 75 6c 6c 20 72 65 71 75 65 73 74 20 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c | tHub.pull.request.is.automatical |
43a0 | 6c 79 20 6c 69 6e 74 65 64 20 74 6f 20 63 68 65 63 6b 20 74 68 65 20 61 64 64 72 65 73 73 20 73 | ly.linted.to.check.the.address.s |
43c0 | 70 61 63 65 20 61 6e 64 20 6c 69 6e 65 20 6c 65 6e 67 74 68 2e 00 45 61 63 68 20 70 61 67 65 20 | pace.and.line.length..Each.page. |
43e0 | 6d 75 73 74 20 63 6f 6e 74 61 69 6e 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 70 61 72 74 73 | must.contain.the.following.parts |
4400 | 3a 00 45 78 63 65 70 74 20 69 6e 20 60 60 2e 2e 20 63 6f 64 65 2d 62 6c 6f 63 6b 3a 3a 60 60 20 | :.Except.in.``...code-block::``. |
4420 | 62 65 63 61 75 73 65 20 69 74 20 75 73 65 73 20 74 68 65 20 68 74 6d 6c 20 74 61 67 20 60 60 3c | because.it.uses.the.html.tag.``< |
4440 | 70 72 65 3e 60 60 20 61 6e 64 20 72 65 6e 64 65 72 73 20 74 68 65 20 73 61 6d 65 20 6c 69 6e 65 | pre>``.and.renders.the.same.line |
4460 | 20 66 6f 72 6d 61 74 20 66 72 6f 6d 20 74 68 65 20 73 6f 75 72 63 65 20 72 73 74 20 66 69 6c 65 | .format.from.the.source.rst.file |
4480 | 2e 00 46 6f 72 20 61 6e 20 69 6e 6c 69 6e 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6c 65 | ..For.an.inline.configuration.le |
44a0 | 76 65 6c 20 63 6f 6d 6d 61 6e 64 2c 20 75 73 65 20 60 60 3a 63 66 67 63 6d 64 3a 60 60 00 46 6f | vel.command,.use.``:cfgcmd:``.Fo |
44c0 | 72 20 61 6e 20 69 6e 6c 69 6e 65 20 6f 70 65 72 61 74 69 6f 6e 61 6c 20 6c 65 76 65 6c 20 63 6f | r.an.inline.operational.level.co |
44e0 | 6d 6d 61 6e 64 2c 20 75 73 65 20 60 60 3a 6f 70 63 6d 64 3a 60 60 00 46 6f 72 20 65 78 61 6d 70 | mmand,.use.``:opcmd:``.For.examp |
4500 | 6c 65 2c 20 79 6f 75 20 77 61 6e 74 20 74 6f 20 72 65 66 65 72 65 6e 63 65 20 74 68 65 20 68 65 | le,.you.want.to.reference.the.he |
4520 | 61 64 6c 69 6e 65 20 2a 2a 56 4c 41 4e 2a 2a 20 69 6e 20 74 68 65 20 2a 2a 65 74 68 65 72 6e 65 | adline.**VLAN**.in.the.**etherne |
4540 | 74 2e 72 73 74 2a 2a 20 70 61 67 65 2e 20 54 68 65 20 70 6c 75 67 69 6e 20 67 65 6e 65 72 61 74 | t.rst**.page..The.plugin.generat |
4560 | 65 73 20 74 68 65 20 6c 61 62 65 6c 20 62 61 73 65 64 20 6f 6e 20 74 68 65 20 68 65 61 64 6c 69 | es.the.label.based.on.the.headli |
4580 | 6e 65 20 61 6e 64 20 74 68 65 20 66 69 6c 65 20 70 61 74 68 2e 00 46 6f 72 20 65 78 61 6d 70 6c | ne.and.the.file.path..For.exampl |
45a0 | 65 3a 00 46 6f 72 6b 20 74 68 69 73 20 70 72 6f 6a 65 63 74 20 6f 6e 20 47 69 74 48 75 62 20 68 | e:.Fork.this.project.on.GitHub.h |
45c0 | 74 74 70 73 3a 2f 2f 67 69 74 68 75 62 2e 63 6f 6d 2f 76 79 6f 73 2f 76 79 6f 73 2d 64 6f 63 75 | ttps://github.com/vyos/vyos-docu |
45e0 | 6d 65 6e 74 61 74 69 6f 6e 2f 66 6f 72 6b 00 46 6f 72 6b 69 6e 67 20 57 6f 72 6b 66 6c 6f 77 00 | mentation/fork.Forking.Workflow. |
4600 | 46 6f 72 6d 61 74 69 6e 67 20 61 6e 64 20 53 70 68 69 6e 78 6d 61 72 6b 75 70 00 46 6f 72 6d 61 | Formating.and.Sphinxmarkup.Forma |
4620 | 74 74 69 6e 67 20 61 6e 64 20 53 70 68 69 6e 78 6d 61 72 6b 75 70 00 47 65 6e 65 72 61 6c 20 63 | tting.and.Sphinxmarkup.General.c |
4640 | 6f 6e 63 65 70 74 73 20 66 6f 72 20 74 72 6f 75 62 6c 65 73 68 6f 6f 74 69 6e 67 20 61 6e 64 20 | oncepts.for.troubleshooting.and. |
4660 | 64 65 74 61 69 6c 65 64 20 70 72 6f 63 65 73 73 20 64 65 73 63 72 69 70 74 69 6f 6e 73 20 62 65 | detailed.process.descriptions.be |
4680 | 6c 6f 6e 67 20 68 65 72 65 2e 00 47 75 69 64 65 6c 69 6e 65 73 00 49 66 20 74 68 65 72 65 20 73 | long.here..Guidelines.If.there.s |
46a0 | 6f 6d 65 20 74 72 6f 75 62 6c 65 73 68 6f 6f 74 69 6e 67 20 67 75 69 64 65 73 20 72 65 6c 61 74 | ome.troubleshooting.guides.relat |
46c0 | 65 64 20 74 6f 20 74 68 65 20 63 6f 6d 6d 61 6e 64 73 2e 20 45 78 70 6c 61 69 6e 20 69 74 20 69 | ed.to.the.commands..Explain.it.i |
46e0 | 6e 20 74 68 65 20 6e 65 78 74 20 6f 70 74 69 6f 6e 61 6c 20 70 61 72 74 2e 00 49 66 20 79 6f 75 | n.the.next.optional.part..If.you |
4700 | 20 61 6c 73 6f 20 77 61 6e 74 20 74 6f 20 75 70 64 61 74 65 20 79 6f 75 72 20 66 6f 72 6b 20 6f | .also.want.to.update.your.fork.o |
4720 | 6e 20 47 69 74 48 75 62 2c 20 75 73 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 3a 20 60 60 24 | n.GitHub,.use.the.following:.``$ |
4740 | 20 67 69 74 20 70 75 73 68 20 6f 72 69 67 69 6e 20 63 75 72 72 65 6e 74 60 60 00 49 66 20 79 6f | .git.push.origin.current``.If.yo |
4760 | 75 20 61 6c 73 6f 20 77 61 6e 74 20 74 6f 20 75 70 64 61 74 65 20 79 6f 75 72 20 66 6f 72 6b 20 | u.also.want.to.update.your.fork. |
4780 | 6f 6e 20 47 69 74 48 75 62 2c 20 75 73 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 3a 20 60 60 | on.GitHub,.use.the.following:.`` |
47a0 | 24 20 67 69 74 20 70 75 73 68 20 6f 72 69 67 69 6e 20 6d 61 73 74 65 72 60 60 00 49 66 20 79 6f | $.git.push.origin.master``.If.yo |
47c0 | 75 20 61 72 65 20 77 69 6c 6c 69 6e 67 20 74 6f 20 63 6f 6e 74 72 69 62 75 74 65 20 74 6f 20 6f | u.are.willing.to.contribute.to.o |
47e0 | 75 72 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 74 68 69 73 20 69 73 20 74 68 65 20 64 65 66 | ur.documentation.this.is.the.def |
4800 | 69 6e 69 74 65 20 67 75 69 64 65 20 68 6f 77 20 74 6f 20 64 6f 20 73 6f 2e 00 49 6e 20 63 6f 6e | inite.guide.how.to.do.so..In.con |
4820 | 74 72 61 73 74 20 74 6f 20 73 75 62 6d 69 74 74 69 6e 67 20 63 6f 64 65 20 70 61 74 63 68 65 73 | trast.to.submitting.code.patches |
4840 | 2c 20 74 68 65 72 65 20 69 73 20 6e 6f 20 72 65 71 75 69 72 65 6d 65 6e 74 20 74 68 61 74 20 79 | ,.there.is.no.requirement.that.y |
4860 | 6f 75 20 6f 70 65 6e 20 75 70 20 61 20 50 68 61 62 72 69 63 61 74 6f 72 5f 20 74 61 73 6b 20 70 | ou.open.up.a.Phabricator_.task.p |
4880 | 72 69 6f 72 20 74 6f 20 73 75 62 6d 69 74 74 69 6e 67 20 61 20 50 75 6c 6c 2d 52 65 71 75 65 73 | rior.to.submitting.a.Pull-Reques |
48a0 | 74 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 49 6e 20 74 68 65 20 63 | t.to.the.documentation..In.the.c |
48c0 | 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 70 61 72 74 20 6f 66 20 74 68 65 20 70 61 67 65 2c 20 61 | onfiguration.part.of.the.page,.a |
48e0 | 6c 6c 20 70 6f 73 73 69 62 6c 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e | ll.possible.configuration.option |
4900 | 73 20 73 68 6f 75 6c 64 20 62 65 20 64 6f 63 75 6d 65 6e 74 65 64 2e 20 55 73 65 20 60 60 2e 2e | s.should.be.documented..Use.``.. |
4920 | 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 65 73 63 72 69 62 65 64 20 61 62 6f 76 65 2e 00 49 6e 64 | .cfgcmd::``.described.above..Ind |
4940 | 65 6e 74 20 77 69 74 68 20 74 77 6f 20 73 70 61 63 65 73 2e 00 49 6e 73 74 61 6c 6c 20 74 68 65 | ent.with.two.spaces..Install.the |
4960 | 20 72 65 71 75 69 72 65 6d 65 6e 74 73 20 60 60 24 20 70 69 70 20 69 6e 73 74 61 6c 6c 20 2d 72 | .requirements.``$.pip.install.-r |
4980 | 20 72 65 71 75 69 72 65 6d 65 6e 74 73 2e 74 78 74 60 60 20 28 6f 72 20 73 6f 6d 65 74 68 69 6e | .requirements.txt``.(or.somethin |
49a0 | 67 20 73 69 6d 69 6c 61 72 29 00 4c 65 61 76 65 20 61 20 6e 65 77 6c 69 6e 65 20 62 65 66 6f 72 | g.similar).Leave.a.newline.befor |
49c0 | 65 20 61 6e 64 20 61 66 74 65 72 20 61 20 68 65 61 64 65 72 2e 00 4c 69 6d 69 74 20 61 6c 6c 20 | e.and.after.a.header..Limit.all. |
49e0 | 6c 69 6e 65 73 20 74 6f 20 61 20 6d 61 78 69 6d 75 6d 20 6f 66 20 38 30 20 63 68 61 72 61 63 74 | lines.to.a.maximum.of.80.charact |
4a00 | 65 72 73 2e 00 4c 69 6e 65 20 6c 65 6e 67 74 68 00 4d 61 6b 65 20 61 6c 6c 20 79 6f 75 72 20 63 | ers..Line.length.Make.all.your.c |
4a20 | 68 61 6e 67 65 73 20 2d 20 70 6c 65 61 73 65 20 6b 65 65 70 20 6f 75 72 20 63 6f 6d 6d 69 74 20 | hanges.-.please.keep.our.commit. |
4a40 | 72 75 6c 65 73 20 69 6e 20 6d 69 6e 64 20 28 3a 72 65 66 3a 60 70 72 65 70 61 72 65 5f 63 6f 6d | rules.in.mind.(:ref:`prepare_com |
4a60 | 6d 69 74 60 29 2e 20 54 68 69 73 20 6d 61 69 6e 6c 79 20 61 70 70 6c 69 65 73 20 74 6f 20 70 72 | mit`)..This.mainly.applies.to.pr |
4a80 | 6f 70 65 72 20 63 6f 6d 6d 69 74 20 6d 65 73 73 61 67 65 73 20 64 65 73 63 72 69 62 69 6e 67 20 | oper.commit.messages.describing. |
4aa0 | 79 6f 75 72 20 63 68 61 6e 67 65 20 28 68 6f 77 20 61 6e 64 20 77 68 79 29 2e 20 50 6c 65 61 73 | your.change.(how.and.why)..Pleas |
4ac0 | 65 20 63 68 65 63 6b 20 6f 75 74 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 | e.check.out.the.documentation.of |
4ae0 | 20 53 70 68 69 6e 78 2d 64 6f 63 5f 20 6f 72 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 | .Sphinx-doc_.or.reStructuredText |
4b00 | 5f 20 69 66 20 79 6f 75 20 61 72 65 20 6e 6f 74 20 66 61 6d 69 6c 69 61 72 20 77 69 74 68 20 69 | _.if.you.are.not.familiar.with.i |
4b20 | 74 2e 20 54 68 69 73 20 69 73 20 75 73 65 64 20 66 6f 72 20 77 72 69 74 69 6e 67 20 6f 75 72 20 | t..This.is.used.for.writing.our. |
4b40 | 64 6f 63 73 2e 20 41 64 64 69 74 69 6f 6e 61 6c 20 64 69 72 65 63 74 69 76 65 73 20 68 6f 77 20 | docs..Additional.directives.how. |
4b60 | 74 6f 20 77 72 69 74 65 20 69 6e 20 52 53 54 20 63 61 6e 20 62 65 20 6f 62 74 61 69 6e 65 64 20 | to.write.in.RST.can.be.obtained. |
4b80 | 66 72 6f 6d 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 44 69 72 65 63 74 69 76 65 73 5f | from.reStructuredTextDirectives_ |
4ba0 | 2e 00 4d 75 6c 74 69 63 61 73 74 20 4d 41 43 2d 41 64 64 72 65 73 73 65 73 3a 20 60 60 39 30 2d | ..Multicast.MAC-Addresses:.``90- |
4bc0 | 31 30 2d 30 30 60 60 20 74 6f 20 60 60 39 30 2d 31 30 2d 46 46 60 60 00 4e 6f 74 65 20 74 68 65 | 10-00``.to.``90-10-FF``.Note.the |
4be0 | 20 66 6f 6c 6c 6f 77 69 6e 67 20 52 46 43 73 20 28 3a 72 66 63 3a 60 35 37 33 37 60 2c 20 3a 72 | .following.RFCs.(:rfc:`5737`,.:r |
4c00 | 66 63 3a 60 33 38 34 39 60 2c 20 3a 72 66 63 3a 60 35 33 38 39 60 20 61 6e 64 20 3a 72 66 63 3a | fc:`3849`,.:rfc:`5389`.and.:rfc: |
4c20 | 60 37 30 34 32 60 29 2c 20 77 68 69 63 68 20 64 65 73 63 72 69 62 65 20 74 68 65 20 72 65 73 65 | `7042`),.which.describe.the.rese |
4c40 | 72 76 65 64 20 70 75 62 6c 69 63 20 49 50 20 61 64 64 72 65 73 73 65 73 20 61 6e 64 20 61 75 74 | rved.public.IP.addresses.and.aut |
4c60 | 6f 6e 6f 6d 6f 75 73 20 73 79 73 74 65 6d 20 6e 75 6d 62 65 72 73 20 66 6f 72 20 74 68 65 20 64 | onomous.system.numbers.for.the.d |
4c80 | 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 3a 00 4f 6e 63 65 20 70 75 6c 6c 20 72 65 71 75 65 73 74 73 | ocumentation:.Once.pull.requests |
4ca0 | 20 68 61 76 65 20 62 65 65 6e 20 61 70 70 72 6f 76 65 64 2c 20 79 6f 75 20 6d 61 79 20 77 61 6e | .have.been.approved,.you.may.wan |
4cc0 | 74 20 74 6f 20 6c 6f 63 61 6c 6c 79 20 75 70 64 61 74 65 20 79 6f 75 72 20 66 6f 72 6b 65 64 20 | t.to.locally.update.your.forked. |
4ce0 | 72 65 70 6f 73 69 74 6f 72 79 20 74 6f 6f 2e 20 46 69 72 73 74 20 79 6f 75 27 6c 6c 20 68 61 76 | repository.too..First.you'll.hav |
4d00 | 65 20 74 6f 20 61 64 64 20 61 20 73 65 63 6f 6e 64 20 72 65 6d 6f 74 65 20 63 61 6c 6c 65 64 20 | e.to.add.a.second.remote.called. |
4d20 | 60 75 70 73 74 72 65 61 6d 60 20 77 68 69 63 68 20 70 6f 69 6e 74 73 20 74 6f 20 6f 75 72 20 6d | `upstream`.which.points.to.our.m |
4d40 | 61 69 6e 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 60 60 24 20 67 69 74 20 72 65 6d 6f 74 65 20 61 | ain.repository..``$.git.remote.a |
4d60 | 64 64 20 75 70 73 74 72 65 61 6d 20 68 74 74 70 73 3a 2f 2f 67 69 74 68 75 62 2e 63 6f 6d 2f 76 | dd.upstream.https://github.com/v |
4d80 | 79 6f 73 2f 76 79 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 67 69 74 60 60 00 4f 70 65 | yos/vyos-documentation.git``.Ope |
4da0 | 72 61 74 69 6f 6e 20 6d 6f 64 65 20 63 6f 6d 6d 61 6e 64 73 20 74 68 61 74 20 64 6f 20 6e 6f 74 | ration.mode.commands.that.do.not |
4dc0 | 20 66 69 74 20 69 6e 20 61 20 72 65 6c 61 74 65 64 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 | .fit.in.a.related.configuration. |
4de0 | 6d 6f 64 65 20 63 6f 6d 6d 61 6e 64 20 6d 75 73 74 20 62 65 20 64 6f 63 75 6d 65 6e 74 65 64 20 | mode.command.must.be.documented. |
4e00 | 69 6e 20 74 68 69 73 20 70 61 72 74 20 6f 66 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f | in.this.part.of.the.documentatio |
4e20 | 6e 2e 00 4f 70 65 72 61 74 69 6f 6e 20 6d 6f 64 65 20 70 61 67 65 73 00 50 61 67 65 20 63 6f 6e | n..Operation.mode.pages.Page.con |
4e40 | 74 65 6e 74 00 50 6c 65 61 73 65 20 64 6f 20 6e 6f 74 20 75 73 65 20 6f 74 68 65 72 20 70 75 62 | tent.Please.do.not.use.other.pub |
4e60 | 6c 69 63 20 61 64 64 72 65 73 73 20 73 70 61 63 65 2e 00 50 72 61 63 74 69 63 61 6c 20 65 78 61 | lic.address.space..Practical.exa |
4e80 | 6d 70 6c 65 73 20 6f 66 20 74 68 65 20 73 65 72 76 69 63 65 20 6f 72 20 75 73 65 20 63 61 73 65 | mples.of.the.service.or.use.case |
4ea0 | 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2e 20 54 68 65 79 20 6d 75 73 74 20 63 6f 6e 74 61 69 | .configuration..They.must.contai |
4ec0 | 6e 20 74 6f 70 6f 6c 6f 67 79 20 6d 61 70 73 20 28 69 66 20 61 70 70 6c 69 63 61 62 6c 65 29 20 | n.topology.maps.(if.applicable). |
4ee0 | 61 6e 64 20 73 68 6f 72 74 20 64 65 73 63 72 69 70 74 69 6f 6e 73 2e 00 50 72 6f 70 65 72 6c 79 | and.short.descriptions..Properly |
4f00 | 20 71 75 6f 74 65 20 63 6f 6d 6d 61 6e 64 73 2c 20 66 69 6c 65 6e 61 6d 65 73 20 61 6e 64 20 62 | .quote.commands,.filenames.and.b |
4f20 | 72 69 65 66 20 63 6f 64 65 20 73 6e 69 70 70 65 74 73 20 77 69 74 68 20 64 6f 75 62 6c 65 20 62 | rief.code.snippets.with.double.b |
4f40 | 61 63 6b 74 69 63 6b 73 2e 00 50 75 73 68 20 63 6f 6d 6d 69 74 73 20 74 6f 20 79 6f 75 72 20 47 | ackticks..Push.commits.to.your.G |
4f60 | 69 74 48 75 62 20 70 72 6f 6a 65 63 74 3a 20 60 60 24 20 67 69 74 20 70 75 73 68 20 2d 75 20 6f | itHub.project:.``$.git.push.-u.o |
4f80 | 72 69 67 69 6e 20 3c 62 72 61 6e 63 68 2d 6e 61 6d 65 3e 60 60 00 52 65 6c 61 74 65 64 20 6f 70 | rigin.<branch-name>``.Related.op |
4fa0 | 65 72 61 74 69 6f 6e 20 63 6f 6d 6d 61 6e 64 20 6d 75 73 74 20 62 65 20 64 6f 63 75 6d 65 6e 74 | eration.command.must.be.document |
4fc0 | 65 64 20 69 6e 20 74 68 65 20 6e 65 78 74 20 70 61 72 74 20 6f 66 20 74 68 65 20 61 72 74 69 63 | ed.in.the.next.part.of.the.artic |
4fe0 | 6c 65 2e 20 55 73 65 20 60 60 3a 3a 6f 70 63 6d 64 2e 2e 60 60 20 66 6f 72 20 74 68 65 73 65 20 | le..Use.``::opcmd..``.for.these. |
5000 | 63 6f 6d 6d 61 6e 64 73 2e 00 53 6f 6d 65 74 69 6d 65 73 20 69 74 20 69 73 20 6e 65 63 65 73 73 | commands..Sometimes.it.is.necess |
5020 | 61 72 79 20 74 6f 20 70 72 6f 76 69 64 65 20 72 65 61 6c 20 49 50 20 61 64 64 72 65 73 73 65 73 | ary.to.provide.real.IP.addresses |
5040 | 20 6c 69 6b 65 20 69 6e 20 74 68 65 20 3a 72 65 66 3a 60 65 78 61 6d 70 6c 65 73 60 2e 20 46 6f | .like.in.the.:ref:`examples`..Fo |
5060 | 72 20 74 68 69 73 2c 20 70 6c 65 61 73 65 20 75 73 65 20 74 68 65 20 73 70 68 69 6e 78 20 63 6f | r.this,.please.use.the.sphinx.co |
5080 | 6d 6d 65 6e 74 20 73 79 6e 74 61 78 20 60 60 2e 2e 20 73 74 6f 70 5f 76 79 6f 73 6c 69 6e 74 65 | mment.syntax.``...stop_vyoslinte |
50a0 | 72 60 60 20 74 6f 20 73 74 6f 70 20 74 68 65 20 6c 69 6e 74 65 72 20 61 6e 64 20 60 60 2e 2e 20 | r``.to.stop.the.linter.and.``... |
50c0 | 73 74 61 72 74 5f 76 79 6f 73 6c 69 6e 74 65 72 60 60 20 74 6f 20 73 74 61 72 74 2e 00 53 74 79 | start_vyoslinter``.to.start..Sty |
50e0 | 6c 65 20 47 75 69 64 65 00 53 75 62 6d 69 74 20 70 75 6c 6c 2d 72 65 71 75 65 73 74 2e 20 49 6e | le.Guide.Submit.pull-request..In |
5100 | 20 47 69 74 48 75 62 20 76 69 73 69 74 20 74 68 65 20 6d 61 69 6e 20 72 65 70 6f 73 69 74 6f 72 | .GitHub.visit.the.main.repositor |
5120 | 79 20 61 6e 64 20 79 6f 75 20 73 68 6f 75 6c 64 20 73 65 65 20 61 20 62 61 6e 6e 65 72 20 73 75 | y.and.you.should.see.a.banner.su |
5140 | 67 67 65 73 74 69 6e 67 20 74 6f 20 6d 61 6b 65 20 61 20 70 75 6c 6c 20 72 65 71 75 65 73 74 2e | ggesting.to.make.a.pull.request. |
5160 | 20 46 69 6c 6c 20 6f 75 74 20 74 68 65 20 66 6f 72 6d 20 61 6e 64 20 64 65 73 63 72 69 62 65 20 | .Fill.out.the.form.and.describe. |
5180 | 77 68 61 74 20 79 6f 75 20 64 6f 2e 00 54 4f 43 20 4c 65 76 65 6c 00 54 61 6b 65 20 61 20 6c 6f | what.you.do..TOC.Level.Take.a.lo |
51a0 | 6f 6b 20 61 74 20 74 68 65 20 3a 64 6f 63 3a 60 2f 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 60 20 | ok.at.the.:doc:`/documentation`. |
51c0 | 70 61 67 65 20 66 6f 72 20 61 6e 20 69 6e 74 72 69 63 61 74 65 20 65 78 70 6c 61 6e 61 74 69 6f | page.for.an.intricate.explanatio |
51e0 | 6e 20 6f 66 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 70 72 6f 63 65 73 73 2e 00 | n.of.the.documentation.process.. |
5200 | 54 68 65 20 46 6f 72 6b 69 6e 67 20 57 6f 72 6b 66 6c 6f 77 20 69 73 20 66 75 6e 64 61 6d 65 6e | The.Forking.Workflow.is.fundamen |
5220 | 74 61 6c 6c 79 20 64 69 66 66 65 72 65 6e 74 20 66 72 6f 6d 20 6f 74 68 65 72 20 70 6f 70 75 6c | tally.different.from.other.popul |
5240 | 61 72 20 47 69 74 20 77 6f 72 6b 66 6c 6f 77 73 2e 20 49 6e 73 74 65 61 64 20 6f 66 20 75 73 69 | ar.Git.workflows..Instead.of.usi |
5260 | 6e 67 20 61 20 73 69 6e 67 6c 65 20 73 65 72 76 65 72 2d 73 69 64 65 20 72 65 70 6f 73 69 74 6f | ng.a.single.server-side.reposito |
5280 | 72 79 20 74 6f 20 61 63 74 20 61 73 20 74 68 65 20 22 63 65 6e 74 72 61 6c 22 20 63 6f 64 65 62 | ry.to.act.as.the."central".codeb |
52a0 | 61 73 65 2c 20 69 74 20 67 69 76 65 73 20 65 76 65 72 79 20 64 65 76 65 6c 6f 70 65 72 20 74 68 | ase,.it.gives.every.developer.th |
52c0 | 65 69 72 20 6f 77 6e 20 73 65 72 76 65 72 2d 73 69 64 65 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 | eir.own.server-side.repository.. |
52e0 | 54 68 69 73 20 6d 65 61 6e 73 20 74 68 61 74 20 65 61 63 68 20 63 6f 6e 74 72 69 62 75 74 6f 72 | This.means.that.each.contributor |
5300 | 20 68 61 73 20 6e 6f 74 20 6f 6e 65 2c 20 62 75 74 20 74 77 6f 20 47 69 74 20 72 65 70 6f 73 69 | .has.not.one,.but.two.Git.reposi |
5320 | 74 6f 72 69 65 73 3a 20 61 20 70 72 69 76 61 74 65 20 6c 6f 63 61 6c 20 6f 6e 65 20 61 6e 64 20 | tories:.a.private.local.one.and. |
5340 | 61 20 70 75 62 6c 69 63 20 73 65 72 76 65 72 2d 73 69 64 65 20 6f 6e 65 2e 00 54 68 65 20 61 72 | a.public.server-side.one..The.ar |
5360 | 74 69 63 6c 65 20 73 74 61 72 74 73 20 77 69 74 68 20 61 20 73 68 6f 72 74 20 69 6e 74 72 6f 64 | ticle.starts.with.a.short.introd |
5380 | 75 63 74 69 6f 6e 20 61 62 6f 75 74 20 74 68 65 20 63 6f 6d 6d 61 6e 64 20 6f 72 20 74 68 65 20 | uction.about.the.command.or.the. |
53a0 | 74 65 63 68 6e 6f 6c 6f 67 79 2e 20 50 6c 65 61 73 65 20 69 6e 63 6c 75 64 65 20 73 6f 6d 65 20 | technology..Please.include.some. |
53c0 | 68 65 6c 70 66 75 6c 20 6c 69 6e 6b 73 20 6f 72 20 62 61 63 6b 67 72 6f 75 6e 64 20 69 6e 66 6f | helpful.links.or.background.info |
53e0 | 72 6d 61 74 69 6f 6e 2e 00 54 68 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 6f 64 65 20 | rmation..The.configuration.mode. |
5400 | 66 6f 6c 64 65 72 20 61 6e 64 20 74 68 65 20 61 72 74 69 63 6c 65 73 20 63 6f 76 65 72 20 74 68 | folder.and.the.articles.cover.th |
5420 | 65 20 73 70 65 63 69 66 69 63 20 6c 65 76 65 6c 20 6f 66 20 74 68 65 20 63 6f 6d 6d 61 6e 64 73 | e.specific.level.of.the.commands |
5440 | 2e 20 54 68 65 20 65 78 61 63 74 20 6c 65 76 65 6c 20 64 65 70 65 6e 64 73 20 6f 6e 20 74 68 65 | ..The.exact.level.depends.on.the |
5460 | 20 63 6f 6d 6d 61 6e 64 2e 20 54 68 69 73 20 73 68 6f 75 6c 64 20 70 72 6f 76 69 64 65 20 73 74 | .command..This.should.provide.st |
5480 | 61 62 69 6c 69 74 79 20 66 6f 72 20 55 52 4c 73 20 75 73 65 64 20 69 6e 20 74 68 65 20 66 6f 72 | ability.for.URLs.used.in.the.for |
54a0 | 75 6d 20 6f 72 20 62 6c 6f 67 70 6f 73 74 2e 00 54 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f | um.or.blogpost..The.documentatio |
54c0 | 6e 20 68 61 73 20 33 20 64 69 66 66 65 72 65 6e 74 20 74 79 70 65 73 20 6f 66 20 70 61 67 65 73 | n.has.3.different.types.of.pages |
54e0 | 2e 20 54 68 65 20 73 61 6d 65 20 6b 69 6e 64 20 6f 66 20 70 61 67 65 73 20 6d 75 73 74 20 68 61 | ..The.same.kind.of.pages.must.ha |
5500 | 76 65 20 74 68 65 20 73 61 6d 65 20 73 74 72 75 63 74 75 72 65 20 74 6f 20 61 63 68 69 65 76 65 | ve.the.same.structure.to.achieve |
5520 | 20 61 20 72 65 63 6f 67 6e 69 74 69 6f 6e 20 66 61 63 74 6f 72 2e 00 54 68 65 20 64 6f 63 75 6d | .a.recognition.factor..The.docum |
5540 | 65 6e 74 61 74 69 6f 6e 20 73 6f 75 72 63 65 20 69 73 20 6b 65 70 74 20 69 6e 20 74 68 65 20 47 | entation.source.is.kept.in.the.G |
5560 | 69 74 20 72 65 70 6f 73 69 74 6f 72 79 20 61 74 20 68 74 74 70 73 3a 2f 2f 67 69 74 68 75 62 2e | it.repository.at.https://github. |
5580 | 63 6f 6d 2f 76 79 6f 73 2f 76 79 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 61 6e 64 20 | com/vyos/vyos-documentation.and. |
55a0 | 79 6f 75 20 63 61 6e 20 66 6f 6c 6c 6f 77 20 74 68 65 20 69 6e 73 74 72 75 63 74 69 6f 6e 73 20 | you.can.follow.the.instructions. |
55c0 | 69 6e 20 74 68 65 20 52 45 41 44 4d 45 2e 6d 64 5f 20 74 6f 20 62 75 69 6c 64 20 61 6e 64 20 74 | in.the.README.md_.to.build.and.t |
55e0 | 65 73 74 20 79 6f 75 72 20 63 68 61 6e 67 65 73 2e 00 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 | est.your.changes..The.following. |
5600 | 69 73 20 61 20 71 75 69 63 6b 20 73 75 6d 6d 61 72 79 20 6f 66 20 74 68 65 20 72 75 6c 65 73 3a | is.a.quick.summary.of.the.rules: |
5620 | 00 54 68 65 20 6d 61 69 6e 20 61 64 76 61 6e 74 61 67 65 20 6f 66 20 74 68 65 20 46 6f 72 6b 69 | .The.main.advantage.of.the.Forki |
5640 | 6e 67 20 57 6f 72 6b 66 6c 6f 77 20 69 73 20 74 68 61 74 20 63 6f 6e 74 72 69 62 75 74 69 6f 6e | ng.Workflow.is.that.contribution |
5660 | 73 20 63 61 6e 20 62 65 20 69 6e 74 65 67 72 61 74 65 64 20 77 69 74 68 6f 75 74 20 74 68 65 20 | s.can.be.integrated.without.the. |
5680 | 6e 65 65 64 20 66 6f 72 20 65 76 65 72 79 62 6f 64 79 20 74 6f 20 70 75 73 68 20 74 6f 20 61 20 | need.for.everybody.to.push.to.a. |
56a0 | 73 69 6e 67 6c 65 20 63 65 6e 74 72 61 6c 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 44 65 76 65 6c | single.central.repository..Devel |
56c0 | 6f 70 65 72 73 20 70 75 73 68 20 74 6f 20 74 68 65 69 72 20 6f 77 6e 20 73 65 72 76 65 72 2d 73 | opers.push.to.their.own.server-s |
56e0 | 69 64 65 20 72 65 70 6f 73 69 74 6f 72 69 65 73 2c 20 61 6e 64 20 6f 6e 6c 79 20 74 68 65 20 70 | ide.repositories,.and.only.the.p |
5700 | 72 6f 6a 65 63 74 20 6d 61 69 6e 74 61 69 6e 65 72 20 63 61 6e 20 70 75 73 68 20 74 6f 20 74 68 | roject.maintainer.can.push.to.th |
5720 | 65 20 6f 66 66 69 63 69 61 6c 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 54 68 69 73 20 61 6c 6c 6f | e.official.repository..This.allo |
5740 | 77 73 20 74 68 65 20 6d 61 69 6e 74 61 69 6e 65 72 20 74 6f 20 61 63 63 65 70 74 20 63 6f 6d 6d | ws.the.maintainer.to.accept.comm |
5760 | 69 74 73 20 66 72 6f 6d 20 61 6e 79 20 64 65 76 65 6c 6f 70 65 72 20 77 69 74 68 6f 75 74 20 67 | its.from.any.developer.without.g |
5780 | 69 76 69 6e 67 20 74 68 65 6d 20 77 72 69 74 65 20 61 63 63 65 73 73 20 74 6f 20 74 68 65 20 6f | iving.them.write.access.to.the.o |
57a0 | 66 66 69 63 69 61 6c 20 63 6f 64 65 62 61 73 65 2e 00 54 68 65 20 70 6c 75 67 69 6e 20 77 69 6c | fficial.codebase..The.plugin.wil |
57c0 | 6c 20 77 61 72 6e 20 6f 6e 20 62 75 69 6c 64 20 69 66 20 61 20 68 65 61 64 6c 69 6e 65 20 68 61 | l.warn.on.build.if.a.headline.ha |
57e0 | 73 20 61 20 64 75 70 6c 69 63 61 74 65 20 6e 61 6d 65 20 69 6e 20 74 68 65 20 73 61 6d 65 20 64 | s.a.duplicate.name.in.the.same.d |
5800 | 6f 63 75 6d 65 6e 74 2e 20 54 6f 20 70 72 65 76 65 6e 74 20 74 68 69 73 20 77 61 72 6e 69 6e 67 | ocument..To.prevent.this.warning |
5820 | 2c 20 79 6f 75 20 68 61 76 65 20 74 6f 20 70 75 74 20 61 20 63 75 73 74 6f 6d 20 6c 69 6e 6b 20 | ,.you.have.to.put.a.custom.link. |
5840 | 6f 6e 20 74 6f 70 20 6f 66 20 74 68 65 20 68 65 61 64 6c 69 6e 65 2e 00 54 68 65 6f 72 65 74 69 | on.top.of.the.headline..Theoreti |
5860 | 63 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 72 65 71 75 69 72 65 64 20 66 6f 72 20 75 73 65 | cal.information.required.for.use |
5880 | 72 73 20 74 6f 20 75 6e 64 65 72 73 74 61 6e 64 20 74 68 65 20 6e 65 78 74 20 64 6f 63 75 6d 65 | rs.to.understand.the.next.docume |
58a0 | 6e 74 20 73 65 63 74 69 6f 6e 73 3a 00 54 68 65 72 65 20 61 72 65 20 61 20 66 65 77 20 74 68 69 | nt.sections:.There.are.a.few.thi |
58c0 | 6e 67 73 20 74 6f 20 6b 65 65 70 20 69 6e 20 6d 69 6e 64 20 77 68 65 6e 20 63 6f 6e 74 72 69 62 | ngs.to.keep.in.mind.when.contrib |
58e0 | 75 74 69 6e 67 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 66 6f 72 20 | uting.to.the.documentation,.for. |
5900 | 74 68 65 20 73 61 6b 65 20 6f 66 20 63 6f 6e 73 69 73 74 65 6e 63 79 20 61 6e 64 20 72 65 61 64 | the.sake.of.consistency.and.read |
5920 | 61 62 69 6c 69 74 79 2e 00 54 68 69 73 20 73 65 63 74 69 6f 6e 20 6d 75 73 74 20 63 6f 6e 74 61 | ability..This.section.must.conta |
5940 | 69 6e 20 61 20 6c 69 73 74 20 6f 66 3a 00 54 6f 20 65 78 74 72 61 63 74 20 61 20 64 65 66 61 75 | in.a.list.of:.To.extract.a.defau |
5960 | 6c 74 76 61 6c 75 65 20 66 72 6f 6d 20 74 68 65 20 58 4d 4c 20 64 65 66 69 6e 69 74 69 6f 6e 73 | ltvalue.from.the.XML.definitions |
5980 | 20 61 64 64 20 61 20 60 60 3a 64 65 66 61 75 6c 74 76 61 6c 75 65 3a 60 60 20 74 6f 20 60 60 2e | .add.a.``:defaultvalue:``.to.``. |
59a0 | 2e 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 69 72 65 63 74 69 76 65 2e 20 54 6f 20 68 61 76 65 20 | ..cfgcmd::``.directive..To.have. |
59c0 | 74 68 69 73 20 66 65 61 74 75 72 65 20 6c 6f 63 61 6c 6c 79 2c 20 74 68 65 20 76 79 6f 73 2d 31 | this.feature.locally,.the.vyos-1 |
59e0 | 78 20 73 75 62 6d 6f 64 75 6c 65 20 6d 75 73 74 20 62 65 20 69 6e 69 74 69 61 6c 69 7a 65 64 20 | x.submodule.must.be.initialized. |
5a00 | 62 65 66 6f 72 65 2e 20 50 6c 65 61 73 65 20 62 65 20 61 77 61 72 65 20 74 6f 20 6e 6f 74 20 75 | before..Please.be.aware.to.not.u |
5a20 | 70 64 61 74 65 20 74 68 65 20 73 75 62 6d 6f 64 75 6c 65 20 69 6e 20 79 6f 75 72 20 50 52 2e 00 | pdate.the.submodule.in.your.PR.. |
5a40 | 54 6f 20 6d 69 6e 69 6d 69 7a 65 20 72 65 64 75 6e 64 61 6e 63 79 2c 20 74 68 65 72 65 20 69 73 | To.minimize.redundancy,.there.is |
5a60 | 20 61 20 73 70 65 63 69 61 6c 20 69 6e 63 6c 75 64 65 20 64 69 72 65 63 74 69 76 65 2e 20 49 74 | .a.special.include.directive..It |
5a80 | 20 69 6e 63 6c 75 64 65 73 20 61 20 74 78 74 20 66 69 6c 65 20 61 6e 64 20 72 65 70 6c 61 63 65 | .includes.a.txt.file.and.replace |
5aa0 | 20 74 68 65 20 60 60 7b 7b 20 76 61 72 30 20 7d 7d 60 60 20 2d 20 60 60 7b 7b 20 76 61 72 39 20 | .the.``{{.var0.}}``.-.``{{.var9. |
5ac0 | 7d 7d 60 60 20 77 69 74 68 20 74 68 65 20 63 6f 72 72 65 63 74 20 76 61 6c 75 65 2e 00 54 72 79 | }}``.with.the.correct.value..Try |
5ae0 | 20 6e 6f 74 20 74 6f 20 65 78 63 65 65 64 20 38 30 20 63 68 61 72 61 63 74 65 72 73 20 70 65 72 | .not.to.exceed.80.characters.per |
5b00 | 20 6c 69 6e 65 2c 20 62 75 74 20 64 6f 6e 27 74 20 62 72 65 61 6b 20 55 52 4c 73 20 6f 76 65 72 | .line,.but.don't.break.URLs.over |
5b20 | 20 74 68 69 73 2e 00 55 6e 69 63 61 73 74 20 4d 41 43 20 41 64 64 72 65 73 73 65 73 3a 20 60 60 | .this..Unicast.MAC.Addresses:.`` |
5b40 | 30 30 2d 35 33 2d 30 30 60 60 20 74 6f 20 60 60 30 30 2d 35 33 2d 46 46 60 60 00 55 70 64 61 74 | 00-53-00``.to.``00-53-FF``.Updat |
5b60 | 65 73 20 74 6f 20 6f 75 72 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20 62 | es.to.our.documentation.should.b |
5b80 | 65 20 64 65 6c 69 76 65 72 65 64 20 62 79 20 61 20 47 69 74 48 75 62 20 70 75 6c 6c 2d 72 65 71 | e.delivered.by.a.GitHub.pull-req |
5ba0 | 75 65 73 74 2e 20 54 68 69 73 20 72 65 71 75 69 72 65 73 20 79 6f 75 20 61 6c 72 65 61 64 79 20 | uest..This.requires.you.already. |
5bc0 | 68 61 76 65 20 61 20 47 69 74 48 75 62 20 61 63 63 6f 75 6e 74 2e 00 55 73 65 20 41 6d 65 72 69 | have.a.GitHub.account..Use.Ameri |
5be0 | 63 61 6e 20 45 6e 67 6c 69 73 68 20 61 74 20 61 6c 6c 20 74 69 6d 65 73 2e 20 49 74 27 73 20 61 | can.English.at.all.times..It's.a |
5c00 | 6c 77 61 79 73 20 61 20 67 6f 6f 64 20 69 64 65 61 20 74 6f 20 72 75 6e 20 79 6f 75 72 20 74 65 | lways.a.good.idea.to.run.your.te |
5c20 | 78 74 20 74 68 72 6f 75 67 68 20 61 20 67 72 61 6d 6d 61 72 20 61 6e 64 20 73 70 65 6c 6c 20 63 | xt.through.a.grammar.and.spell.c |
5c40 | 68 65 63 6b 65 72 2c 20 73 75 63 68 20 61 73 20 60 47 72 61 6d 6d 61 72 6c 79 60 5f 2e 00 55 73 | hecker,.such.as.`Grammarly`_..Us |
5c60 | 65 20 6c 69 74 65 72 61 6c 20 62 6c 6f 63 6b 73 20 66 6f 72 20 6c 6f 6e 67 65 72 20 73 6e 69 70 | e.literal.blocks.for.longer.snip |
5c80 | 70 65 74 73 2e 00 56 69 65 77 20 6d 6f 64 69 66 69 65 64 20 66 69 6c 65 73 20 62 79 20 63 61 6c | pets..View.modified.files.by.cal |
5ca0 | 6c 69 6e 67 20 60 60 24 20 67 69 74 20 73 74 61 74 75 73 60 60 2e 20 59 6f 75 20 77 69 6c 6c 20 | ling.``$.git.status``..You.will. |
5cc0 | 67 65 74 20 61 6e 20 6f 76 65 72 76 69 65 77 20 6f 66 20 61 6c 6c 20 66 69 6c 65 73 20 6d 6f 64 | get.an.overview.of.all.files.mod |
5ce0 | 69 66 69 65 64 20 62 79 20 79 6f 75 2e 20 59 6f 75 20 63 61 6e 20 61 64 64 20 69 6e 64 69 76 69 | ified.by.you..You.can.add.indivi |
5d00 | 64 75 61 6c 20 66 69 6c 65 73 20 74 6f 20 74 68 65 20 47 69 74 20 49 6e 64 65 78 20 69 6e 20 74 | dual.files.to.the.Git.Index.in.t |
5d20 | 68 65 20 6e 65 78 74 20 73 74 65 70 2e 00 56 79 4f 53 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e | he.next.step..VyOS.documentation |
5d40 | 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 20 | .is.written.in.reStructuredText. |
5d60 | 61 6e 64 20 67 65 6e 65 72 61 74 65 64 20 74 6f 20 52 65 61 64 20 74 68 65 20 44 6f 63 73 20 70 | and.generated.to.Read.the.Docs.p |
5d80 | 61 67 65 73 20 77 69 74 68 20 53 70 68 69 6e 78 2c 20 61 73 20 70 65 72 20 74 68 65 20 50 79 74 | ages.with.Sphinx,.as.per.the.Pyt |
5da0 | 68 6f 6e 20 74 72 61 64 69 74 69 6f 6e 2c 20 61 73 20 77 65 6c 6c 20 61 73 20 50 44 46 20 66 69 | hon.tradition,.as.well.as.PDF.fi |
5dc0 | 6c 65 73 20 66 6f 72 20 6f 66 66 6c 69 6e 65 20 75 73 65 20 74 68 72 6f 75 67 68 20 4c 61 54 65 | les.for.offline.use.through.LaTe |
5de0 | 58 2e 20 57 65 20 77 65 6c 63 6f 6d 65 20 61 6c 6c 20 73 6f 72 74 73 20 6f 66 20 63 6f 6e 74 72 | X..We.welcome.all.sorts.of.contr |
5e00 | 69 62 75 74 69 6f 6e 73 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 4e | ibutions.to.the.documentation..N |
5e20 | 6f 74 20 6a 75 73 74 20 6e 65 77 20 61 64 64 69 74 69 6f 6e 73 20 62 75 74 20 61 6c 73 6f 20 63 | ot.just.new.additions.but.also.c |
5e40 | 6f 72 72 65 63 74 69 6f 6e 73 20 74 6f 20 65 78 69 73 74 69 6e 67 20 64 6f 63 75 6d 65 6e 74 61 | orrections.to.existing.documenta |
5e60 | 74 69 6f 6e 2e 00 56 79 4f 53 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 69 73 20 77 72 69 74 | tion..VyOS.documentation.is.writ |
5e80 | 74 65 6e 20 69 6e 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 20 61 6e 64 20 67 65 6e 65 | ten.in.reStructuredText.and.gene |
5ea0 | 72 61 74 65 64 20 74 6f 20 52 65 61 64 20 74 68 65 20 44 6f 63 73 20 70 61 67 65 73 20 77 69 74 | rated.to.Read.the.Docs.pages.wit |
5ec0 | 68 20 53 70 68 69 6e 78 2c 20 61 73 20 70 65 72 20 74 68 65 20 50 79 74 68 6f 6e 20 74 72 61 64 | h.Sphinx,.as.per.the.Python.trad |
5ee0 | 69 74 69 6f 6e 2e 20 57 65 20 77 65 6c 63 6f 6d 65 20 61 6c 6c 20 73 6f 72 74 73 20 6f 66 20 63 | ition..We.welcome.all.sorts.of.c |
5f00 | 6f 6e 74 72 69 62 75 74 69 6f 6e 73 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f | ontributions.to.the.documentatio |
5f20 | 6e 2e 20 4e 6f 74 20 6a 75 73 74 20 6e 65 77 20 61 64 64 69 74 69 6f 6e 73 20 62 75 74 20 61 6c | n..Not.just.new.additions.but.al |
5f40 | 73 6f 20 63 6f 72 72 65 63 74 69 6f 6e 73 20 74 6f 20 65 78 69 73 74 69 6e 67 20 64 6f 63 75 6d | so.corrections.to.existing.docum |
5f60 | 65 6e 74 61 74 69 6f 6e 2e 00 57 65 20 65 6e 63 6f 75 72 61 67 65 20 65 76 65 72 79 20 56 79 4f | entation..We.encourage.every.VyO |
5f80 | 53 20 75 73 65 72 20 74 6f 20 68 65 6c 70 20 75 73 20 69 6d 70 72 6f 76 65 20 6f 75 72 20 64 6f | S.user.to.help.us.improve.our.do |
5fa0 | 63 75 6d 65 6e 74 61 74 69 6f 6e 20 61 73 20 77 65 20 68 61 76 65 20 61 20 64 65 66 69 63 69 74 | cumentation.as.we.have.a.deficit |
5fc0 | 20 6c 69 6b 65 20 6d 6f 73 74 20 73 6f 66 74 77 61 72 65 20 70 72 6f 6a 65 63 74 73 2e 20 20 54 | .like.most.software.projects...T |
5fe0 | 68 69 73 20 6e 6f 74 20 6f 6e 6c 79 20 68 65 6c 70 73 20 79 6f 75 20 77 68 65 6e 20 72 65 61 64 | his.not.only.helps.you.when.read |
6000 | 69 6e 67 20 62 75 74 20 61 6c 73 6f 20 65 76 65 72 79 6f 6e 65 20 65 6c 73 65 2e 00 57 65 20 75 | ing.but.also.everyone.else..We.u |
6020 | 73 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 73 79 6e 74 61 78 20 66 6f 72 20 48 65 61 64 | se.the.following.syntax.for.Head |
6040 | 6c 69 6e 65 73 2e 00 57 68 65 6e 20 64 6f 63 75 6d 65 6e 74 69 6e 67 20 43 4c 49 20 63 6f 6d 6d | lines..When.documenting.CLI.comm |
6060 | 61 6e 64 73 2c 20 75 73 65 20 74 68 65 20 60 60 2e 2e 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 69 | ands,.use.the.``...cfgcmd::``.di |
6080 | 72 65 63 74 69 76 65 20 66 6f 72 20 61 6c 6c 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 6f | rective.for.all.configuration.mo |
60a0 | 64 65 20 63 6f 6d 6d 61 6e 64 73 2e 20 41 6e 20 65 78 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 74 | de.commands..An.explanation.of.t |
60c0 | 68 65 20 64 65 73 63 72 69 62 65 64 20 63 6f 6d 6d 61 6e 64 20 73 68 6f 75 6c 64 20 62 65 20 61 | he.described.command.should.be.a |
60e0 | 64 64 65 64 20 62 65 6c 6f 77 20 74 68 69 73 20 73 74 61 74 65 6d 65 6e 74 2e 20 52 65 70 6c 61 | dded.below.this.statement..Repla |
6100 | 63 65 20 61 6c 6c 20 76 61 72 69 61 62 6c 65 20 63 6f 6e 74 65 6e 74 73 20 77 69 74 68 20 3c 76 | ce.all.variable.contents.with.<v |
6120 | 61 6c 75 65 3e 20 6f 72 20 73 6f 6d 65 74 68 69 6e 67 20 73 69 6d 69 6c 61 72 2e 00 57 68 65 6e | alue>.or.something.similar..When |
6140 | 20 64 6f 63 75 6d 65 6e 74 69 6e 67 20 6f 70 65 72 61 74 69 6f 6e 61 6c 20 6c 65 76 65 6c 20 63 | .documenting.operational.level.c |
6160 | 6f 6d 6d 61 6e 64 73 2c 20 75 73 65 20 74 68 65 20 60 60 2e 2e 20 6f 70 63 6d 64 3a 3a 60 60 20 | ommands,.use.the.``...opcmd::``. |
6180 | 64 69 72 65 63 74 69 76 65 2e 20 41 6e 20 65 78 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 74 68 65 | directive..An.explanation.of.the |
61a0 | 20 64 65 73 63 72 69 62 65 64 20 63 6f 6d 6d 61 6e 64 20 73 68 6f 75 6c 64 20 62 65 20 61 64 64 | .described.command.should.be.add |
61c0 | 65 64 20 62 65 6c 6f 77 20 74 68 69 73 20 73 74 61 74 65 6d 65 6e 74 2e 00 57 68 65 6e 20 69 6e | ed.below.this.statement..When.in |
61e0 | 20 64 6f 75 62 74 2c 20 66 6f 6c 6c 6f 77 20 74 68 65 20 73 74 79 6c 65 20 6f 66 20 65 78 69 73 | .doubt,.follow.the.style.of.exis |
6200 | 74 69 6e 67 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 57 68 65 6e 20 72 65 66 65 72 65 6e | ting.documentation..When.referen |
6220 | 63 69 6e 67 20 74 6f 20 56 79 4f 53 20 50 68 61 62 72 69 63 61 74 6f 72 20 54 61 73 6b 73 2c 20 | cing.to.VyOS.Phabricator.Tasks,. |
6240 | 74 68 65 72 65 20 69 73 20 61 20 63 75 73 74 6f 6d 20 53 70 68 69 6e 78 20 4d 61 72 6b 75 70 20 | there.is.a.custom.Sphinx.Markup. |
6260 | 63 6f 6d 6d 61 6e 64 20 63 61 6c 6c 65 64 20 60 60 76 79 74 61 73 6b 60 60 20 74 68 61 74 20 61 | command.called.``vytask``.that.a |
6280 | 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 65 6e 64 65 72 73 20 74 6f 20 61 20 70 72 6f 70 65 72 | utomatically.renders.to.a.proper |
62a0 | 20 50 68 61 62 72 69 63 61 74 6f 72 20 55 52 4c 2e 20 54 68 69 73 20 69 73 20 68 65 61 76 69 6c | .Phabricator.URL..This.is.heavil |
62c0 | 79 20 75 73 65 64 20 69 6e 20 74 68 65 20 3a 72 65 66 3a 60 72 65 6c 65 61 73 65 2d 6e 6f 74 65 | y.used.in.the.:ref:`release-note |
62e0 | 73 60 20 73 65 63 74 69 6f 6e 2e 00 57 69 74 68 20 74 68 6f 73 65 20 63 75 73 74 6f 6d 20 63 6f | s`.section..With.those.custom.co |
6300 | 6d 6d 61 6e 64 73 2c 20 69 74 20 69 73 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 72 65 6e 64 65 72 | mmands,.it.is.possible.to.render |
6320 | 20 74 68 65 6d 20 69 6e 20 61 20 6d 6f 72 65 20 64 65 73 63 72 69 70 74 69 76 65 20 77 61 79 20 | .them.in.a.more.descriptive.way. |
6340 | 69 6e 20 74 68 65 20 72 65 73 75 6c 74 69 6e 67 20 48 54 4d 4c 2f 50 44 46 20 6d 61 6e 75 61 6c | in.the.resulting.HTML/PDF.manual |
6360 | 2e 00 57 69 74 68 20 74 68 6f 73 65 20 63 75 73 74 6f 6d 20 63 6f 6d 6d 61 6e 64 73 2c 20 69 74 | ..With.those.custom.commands,.it |
6380 | 20 77 69 6c 6c 20 62 65 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 72 65 6e 64 65 72 20 74 68 65 6d | .will.be.possible.to.render.them |
63a0 | 20 69 6e 20 61 20 6d 6f 72 65 20 64 65 73 63 72 69 70 74 69 76 65 20 77 61 79 20 69 6e 20 74 68 | .in.a.more.descriptive.way.in.th |
63c0 | 65 20 72 65 73 75 6c 74 69 6e 67 20 48 54 4d 4c 2f 50 44 46 20 6d 61 6e 75 61 6c 2e 00 57 72 69 | e.resulting.HTML/PDF.manual..Wri |
63e0 | 74 65 20 44 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 00 59 6f 75 20 63 61 6e 20 65 69 74 68 65 72 20 | te.Documentation.You.can.either. |
6400 | 69 6e 73 74 61 6c 6c 20 53 70 68 69 6e 78 20 28 61 6e 64 20 54 65 58 20 4c 69 76 65 20 66 6f 72 | install.Sphinx.(and.TeX.Live.for |
6420 | 20 50 44 46 20 6f 75 74 70 75 74 29 20 61 6e 64 20 62 75 69 6c 64 20 74 68 65 20 64 6f 63 75 6d | .PDF.output).and.build.the.docum |
6440 | 65 6e 74 61 74 69 6f 6e 20 6c 6f 63 61 6c 6c 79 2c 20 6f 72 20 75 73 65 20 74 68 65 20 44 6f 63 | entation.locally,.or.use.the.Doc |
6460 | 6b 65 72 66 69 6c 65 5f 20 74 6f 20 62 75 69 6c 64 20 69 74 20 69 6e 20 61 20 63 6f 6e 74 61 69 | kerfile_.to.build.it.in.a.contai |
6480 | 6e 65 72 2e 00 59 6f 75 20 63 61 6e 20 65 69 74 68 65 72 20 69 6e 73 74 61 6c 6c 20 53 70 68 69 | ner..You.can.either.install.Sphi |
64a0 | 6e 78 20 61 6e 64 20 62 75 69 6c 64 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 6c | nx.and.build.the.documentation.l |
64c0 | 6f 63 61 6c 6c 79 2c 20 6f 72 20 75 73 65 20 74 68 65 20 44 6f 63 6b 65 72 66 69 6c 65 5f 20 74 | ocally,.or.use.the.Dockerfile_.t |
64e0 | 6f 20 62 75 69 6c 64 20 69 74 20 69 6e 20 61 20 63 6f 6e 74 61 69 6e 65 72 2e 00 59 6f 75 72 20 | o.build.it.in.a.container..Your. |
6500 | 72 65 6d 6f 74 65 20 72 65 70 6f 20 6f 6e 20 47 69 74 68 75 62 20 69 73 20 63 61 6c 6c 65 64 20 | remote.repo.on.Github.is.called. |
6520 | 60 60 6f 72 69 67 69 6e 60 60 2c 20 77 68 69 6c 65 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 72 | ``origin``,.while.the.original.r |
6540 | 65 70 6f 20 79 6f 75 20 68 61 76 65 20 66 6f 72 6b 65 64 20 69 73 20 63 61 6c 6c 65 64 20 60 60 | epo.you.have.forked.is.called.`` |
6560 | 75 70 73 74 72 65 61 6d 60 60 2e 20 4e 6f 77 20 79 6f 75 20 63 61 6e 20 6c 6f 63 61 6c 6c 79 20 | upstream``..Now.you.can.locally. |
6580 | 75 70 64 61 74 65 20 79 6f 75 72 20 66 6f 72 6b 65 64 20 72 65 70 6f 2e 00 60 60 31 39 32 2e 30 | update.your.forked.repo..``192.0 |
65a0 | 2e 32 2e 30 2f 32 34 60 60 00 60 60 31 39 38 2e 35 31 2e 31 30 30 2e 30 2f 32 34 60 60 00 60 60 | .2.0/24``.``198.51.100.0/24``.`` |
65c0 | 32 30 30 31 3a 64 62 38 3a 3a 2f 33 32 60 60 00 60 60 32 30 33 2e 30 2e 31 31 33 2e 30 2f 32 34 | 2001:db8::/32``.``203.0.113.0/24 |
65e0 | 60 60 00 60 60 3a 72 65 66 3a 60 43 68 65 63 6b 20 6f 75 74 20 56 4c 41 4e 3c 63 6f 6e 66 69 67 | ``.``:ref:`Check.out.VLAN<config |
6600 | 75 72 61 74 69 6f 6e 2f 69 6e 74 65 72 66 61 63 65 73 2f 65 74 68 65 72 6e 65 74 3a 76 6c 61 6e | uration/interfaces/ethernet:vlan |
6620 | 3e 60 60 00 60 60 3a 72 65 66 3a 60 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2f 69 6e 74 65 72 66 | >``.``:ref:`configuration/interf |
6640 | 61 63 65 73 2f 65 74 68 65 72 6e 65 74 3a 76 6c 61 6e 60 60 00 60 60 73 65 74 20 66 69 72 65 77 | aces/ethernet:vlan``.``set.firew |
6660 | 61 6c 6c 20 7a 6f 6e 65 60 60 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 60 60 66 69 72 65 77 | all.zone``.is.written.in.``firew |
6680 | 61 6c 6c 2f 7a 6f 6e 65 2e 72 73 74 60 60 00 60 60 73 65 74 20 69 6e 74 65 72 66 61 63 65 73 20 | all/zone.rst``.``set.interfaces. |
66a0 | 65 74 68 65 72 6e 65 74 60 60 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 60 60 69 6e 74 65 72 | ethernet``.is.written.in.``inter |
66c0 | 66 61 63 65 73 2f 65 74 68 65 72 6e 65 74 2e 72 73 74 60 60 00 61 20 73 69 6d 70 6c 65 20 65 78 | faces/ethernet.rst``.a.simple.ex |
66e0 | 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 77 68 61 74 20 69 73 20 74 68 69 73 20 70 61 67 65 20 61 | planation.of.what.is.this.page.a |
6700 | 62 6f 75 74 2c 20 77 68 79 20 6f 72 20 77 68 65 6e 20 69 74 20 69 73 20 72 65 71 75 69 72 65 64 | bout,.why.or.when.it.is.required |
6720 | 20 74 6f 20 62 65 20 75 73 65 64 00 63 66 67 63 6d 64 00 63 6d 64 69 6e 63 6c 75 64 65 00 68 61 | .to.be.used.cfgcmd.cmdinclude.ha |
6740 | 6e 64 6c 65 20 62 75 69 6c 64 20 65 72 72 6f 72 73 00 68 6f 77 20 74 6f 20 63 6f 6c 6c 65 63 74 | ndle.build.errors.how.to.collect |
6760 | 20 6c 6f 67 73 20 6f 72 20 6f 74 68 65 72 20 64 65 62 75 67 67 69 6e 67 20 69 6e 66 6f 72 6d 61 | .logs.or.other.debugging.informa |
6780 | 74 69 6f 6e 20 28 6c 69 6b 65 20 60 73 68 6f 77 60 20 63 6f 6d 6d 61 6e 64 73 20 6f 75 74 70 75 | tion.(like.`show`.commands.outpu |
67a0 | 74 29 00 68 6f 77 20 74 6f 20 72 65 61 64 20 61 6e 64 20 77 68 61 74 20 74 6f 20 73 65 61 72 63 | t).how.to.read.and.what.to.searc |
67c0 | 68 20 66 6f 72 20 69 6e 20 6c 6f 67 73 20 61 6e 64 20 63 6f 6c 6c 65 63 74 65 64 20 69 6e 66 6f | h.for.in.logs.and.collected.info |
67e0 | 72 6d 61 74 69 6f 6e 00 6b 6e 6f 77 6e 20 69 73 73 75 65 73 20 6f 72 20 70 6f 74 65 6e 74 69 61 | rmation.known.issues.or.potentia |
6800 | 6c 20 70 72 6f 62 6c 65 6d 73 20 66 6f 72 20 74 68 65 20 73 65 72 76 69 63 65 20 6f 72 20 75 73 | l.problems.for.the.service.or.us |
6820 | 65 20 63 61 73 65 00 6f 70 63 6d 64 00 72 65 66 65 72 65 6e 63 65 73 20 74 6f 20 73 74 61 6e 64 | e.case.opcmd.references.to.stand |
6840 | 61 72 64 73 2c 20 52 46 43 73 00 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20 69 6e 74 65 72 66 | ards,.RFCs.the.content.of.interf |
6860 | 61 63 65 2d 61 64 64 72 65 73 73 2e 74 78 74 20 6c 6f 6f 6b 73 20 6c 69 6b 65 20 74 68 69 73 00 | ace-address.txt.looks.like.this. |
6880 | 74 6f 20 75 73 65 20 61 6e 20 61 6c 74 65 72 6e 61 74 69 76 65 20 68 79 70 65 72 6c 69 6e 6b 20 | to.use.an.alternative.hyperlink. |
68a0 | 75 73 65 20 69 74 20 74 68 69 73 20 77 61 79 3a 00 76 79 74 61 73 6b 00 77 68 61 74 20 61 72 65 | use.it.this.way:.vytask.what.are |
68c0 | 20 69 6e 64 69 63 61 74 6f 72 73 20 6f 66 20 67 6f 6f 64 20 61 6e 64 20 62 61 64 20 73 74 61 74 | .indicators.of.good.and.bad.stat |
68e0 | 65 73 20 69 6e 20 64 65 62 75 67 67 69 6e 67 20 6f 75 74 70 75 74 73 00 77 6f 72 6b 61 72 6f 75 | es.in.debugging.outputs.workarou |
6900 | 6e 64 73 20 66 6f 72 20 6b 6e 6f 77 6e 20 69 73 73 75 65 73 20 28 69 66 20 61 6e 79 20 65 78 69 | nds.for.known.issues.(if.any.exi |
6920 | 73 74 29 00 | st). |