ofs | hex dump | ascii |
---|
0000 | de 12 04 95 00 00 00 00 7c 00 00 00 1c 00 00 00 fc 03 00 00 a7 00 00 00 dc 07 00 00 00 00 00 00 | ........|....................... |
0020 | 78 0a 00 00 1a 00 00 00 79 0a 00 00 1c 00 00 00 94 0a 00 00 1c 00 00 00 b1 0a 00 00 19 00 00 00 | x.......y....................... |
0040 | ce 0a 00 00 1c 00 00 00 e8 0a 00 00 0f 00 00 00 05 0b 00 00 0c 00 00 00 15 0b 00 00 97 00 00 00 | ................................ |
0060 | 22 0b 00 00 b4 00 00 00 ba 0b 00 00 0d 00 00 00 6f 0c 00 00 4a 00 00 00 7d 0c 00 00 d4 00 00 00 | "...............o...J...}....... |
0080 | c8 0c 00 00 a6 00 00 00 9d 0d 00 00 0d 00 00 00 44 0e 00 00 5e 00 00 00 52 0e 00 00 0a 00 00 00 | ................D...^...R....... |
00a0 | b1 0e 00 00 06 01 00 00 bc 0e 00 00 2a 00 00 00 c3 0f 00 00 56 00 00 00 ee 0f 00 00 01 01 00 00 | ............*.......V........... |
00c0 | 45 10 00 00 18 00 00 00 47 11 00 00 6b 00 00 00 60 11 00 00 10 00 00 00 cc 11 00 00 18 00 00 00 | E.......G...k...`............... |
00e0 | dd 11 00 00 aa 00 00 00 f6 11 00 00 9d 00 00 00 a1 12 00 00 2d 00 00 00 3f 13 00 00 3c 00 00 00 | ....................-...?...<... |
0100 | 6d 13 00 00 5c 00 00 00 aa 13 00 00 2b 00 00 00 07 14 00 00 7f 00 00 00 33 14 00 00 3b 00 00 00 | m...\.......+...........3...;... |
0120 | b3 14 00 00 38 00 00 00 ef 14 00 00 9e 00 00 00 28 15 00 00 0c 00 00 00 c7 15 00 00 4b 00 00 00 | ....8...........(...........K... |
0140 | d4 15 00 00 10 00 00 00 20 16 00 00 1a 00 00 00 31 16 00 00 1b 00 00 00 4c 16 00 00 53 00 00 00 | ................1.......L...S... |
0160 | 68 16 00 00 0a 00 00 00 bc 16 00 00 63 00 00 00 c7 16 00 00 5f 00 00 00 2b 17 00 00 5e 00 00 00 | h...........c......._...+...^... |
0180 | 8b 17 00 00 9d 00 00 00 ea 17 00 00 84 00 00 00 88 18 00 00 17 00 00 00 0d 19 00 00 55 00 00 00 | ............................U... |
01a0 | 25 19 00 00 2a 00 00 00 7b 19 00 00 2e 00 00 00 a6 19 00 00 0b 00 00 00 d5 19 00 00 90 01 00 00 | %...*...{....................... |
01c0 | e1 19 00 00 35 00 00 00 72 1b 00 00 b5 00 00 00 a8 1b 00 00 0e 01 00 00 5e 1c 00 00 85 00 00 00 | ....5...r...............^....... |
01e0 | 6d 1d 00 00 14 00 00 00 f3 1d 00 00 0c 00 00 00 08 1e 00 00 2d 00 00 00 15 1e 00 00 84 00 00 00 | m...................-........... |
0200 | 43 1e 00 00 51 00 00 00 c8 1e 00 00 4b 00 00 00 1a 1f 00 00 73 00 00 00 66 1f 00 00 d2 00 00 00 | C...Q.......K.......s...f....... |
0220 | da 1f 00 00 0b 00 00 00 ad 20 00 00 a3 00 00 00 b9 20 00 00 09 00 00 00 5d 21 00 00 68 00 00 00 | ........................]!..h... |
0240 | 67 21 00 00 59 01 00 00 d0 21 00 00 8e 00 00 00 2a 23 00 00 c6 00 00 00 b9 23 00 00 86 00 00 00 | g!..Y....!......*#.......#...... |
0260 | 80 24 00 00 ba 00 00 00 07 25 00 00 2e 00 00 00 c2 25 00 00 90 01 00 00 f1 25 00 00 a5 00 00 00 | .$.......%.......%.......%...... |
0280 | 82 27 00 00 54 00 00 00 28 28 00 00 7b 00 00 00 7d 28 00 00 24 00 00 00 f9 28 00 00 f1 00 00 00 | .'..T...((..{...}(..$....(...... |
02a0 | 1e 29 00 00 9c 00 00 00 10 2a 00 00 49 00 00 00 ad 2a 00 00 33 00 00 00 f7 2a 00 00 7b 00 00 00 | .).......*..I....*..3....*..{... |
02c0 | 2b 2b 00 00 86 00 00 00 a7 2b 00 00 27 00 00 00 2e 2c 00 00 a7 00 00 00 56 2c 00 00 37 01 00 00 | ++.......+..'....,......V,..7... |
02e0 | fe 2c 00 00 03 01 00 00 36 2e 00 00 b1 00 00 00 3a 2f 00 00 2a 00 00 00 ec 2f 00 00 f4 00 00 00 | .,......6.......:/..*..../...... |
0300 | 17 30 00 00 9c 00 00 00 0c 31 00 00 3a 00 00 00 a9 31 00 00 d7 00 00 00 e4 31 00 00 75 00 00 00 | .0.......1..:....1.......1..u... |
0320 | bc 32 00 00 7a 00 00 00 32 33 00 00 13 00 00 00 ad 33 00 00 93 00 00 00 c1 33 00 00 75 00 00 00 | .2..z...23.......3.......3..u... |
0340 | 55 34 00 00 9d 00 00 00 cb 34 00 00 10 00 00 00 69 35 00 00 13 00 00 00 7a 35 00 00 11 00 00 00 | U4.......4......i5......z5...... |
0360 | 8e 35 00 00 12 00 00 00 a0 35 00 00 40 00 00 00 b3 35 00 00 30 00 00 00 f4 35 00 00 39 00 00 00 | .5.......5..@....5..0....5..9... |
0380 | 25 36 00 00 45 00 00 00 5f 36 00 00 56 00 00 00 a5 36 00 00 06 00 00 00 fc 36 00 00 0a 00 00 00 | %6..E..._6..V....6.......6...... |
03a0 | 03 37 00 00 13 00 00 00 0e 37 00 00 50 00 00 00 22 37 00 00 44 00 00 00 73 37 00 00 3e 00 00 00 | .7.......7..P..."7..D...s7..>... |
03c0 | b8 37 00 00 05 00 00 00 f7 37 00 00 1d 00 00 00 fd 37 00 00 34 00 00 00 1b 38 00 00 30 00 00 00 | .7.......7.......7..4....8..0... |
03e0 | 50 38 00 00 06 00 00 00 81 38 00 00 3f 00 00 00 88 38 00 00 2b 00 00 00 c8 38 00 00 cd 00 00 00 | P8.......8..?....8..+....8...... |
0400 | f4 38 00 00 1a 00 00 00 c2 39 00 00 1c 00 00 00 dd 39 00 00 1c 00 00 00 fa 39 00 00 19 00 00 00 | .8.......9.......9.......9...... |
0420 | 17 3a 00 00 1c 00 00 00 31 3a 00 00 0f 00 00 00 4e 3a 00 00 0c 00 00 00 5e 3a 00 00 97 00 00 00 | .:......1:......N:......^:...... |
0440 | 6b 3a 00 00 b4 00 00 00 03 3b 00 00 0d 00 00 00 b8 3b 00 00 4a 00 00 00 c6 3b 00 00 d4 00 00 00 | k:.......;.......;..J....;...... |
0460 | 11 3c 00 00 a6 00 00 00 e6 3c 00 00 0d 00 00 00 8d 3d 00 00 5e 00 00 00 9b 3d 00 00 0a 00 00 00 | .<.......<.......=..^....=...... |
0480 | fa 3d 00 00 06 01 00 00 05 3e 00 00 2a 00 00 00 0c 3f 00 00 56 00 00 00 37 3f 00 00 01 01 00 00 | .=.......>..*....?..V...7?...... |
04a0 | 8e 3f 00 00 18 00 00 00 90 40 00 00 6b 00 00 00 a9 40 00 00 10 00 00 00 15 41 00 00 18 00 00 00 | .?.......@..k....@.......A...... |
04c0 | 26 41 00 00 aa 00 00 00 3f 41 00 00 9d 00 00 00 ea 41 00 00 2d 00 00 00 88 42 00 00 3c 00 00 00 | &A......?A.......A..-....B..<... |
04e0 | b6 42 00 00 5c 00 00 00 f3 42 00 00 2b 00 00 00 50 43 00 00 7f 00 00 00 7c 43 00 00 3b 00 00 00 | .B..\....B..+...PC......|C..;... |
0500 | fc 43 00 00 38 00 00 00 38 44 00 00 9e 00 00 00 71 44 00 00 0c 00 00 00 10 45 00 00 4b 00 00 00 | .C..8...8D......qD.......E..K... |
0520 | 1d 45 00 00 10 00 00 00 69 45 00 00 1a 00 00 00 7a 45 00 00 1b 00 00 00 95 45 00 00 53 00 00 00 | .E......iE......zE.......E..S... |
0540 | b1 45 00 00 0a 00 00 00 05 46 00 00 63 00 00 00 10 46 00 00 5f 00 00 00 74 46 00 00 5e 00 00 00 | .E.......F..c....F.._...tF..^... |
0560 | d4 46 00 00 9d 00 00 00 33 47 00 00 84 00 00 00 d1 47 00 00 17 00 00 00 56 48 00 00 55 00 00 00 | .F......3G.......G......VH..U... |
0580 | 6e 48 00 00 2a 00 00 00 c4 48 00 00 2e 00 00 00 ef 48 00 00 0b 00 00 00 1e 49 00 00 90 01 00 00 | nH..*....H.......H.......I...... |
05a0 | 2a 49 00 00 35 00 00 00 bb 4a 00 00 b5 00 00 00 f1 4a 00 00 0e 01 00 00 a7 4b 00 00 85 00 00 00 | *I..5....J.......J.......K...... |
05c0 | b6 4c 00 00 14 00 00 00 3c 4d 00 00 0c 00 00 00 51 4d 00 00 2d 00 00 00 5e 4d 00 00 84 00 00 00 | .L......<M......QM..-...^M...... |
05e0 | 8c 4d 00 00 51 00 00 00 11 4e 00 00 4b 00 00 00 63 4e 00 00 73 00 00 00 af 4e 00 00 d2 00 00 00 | .M..Q....N..K...cN..s....N...... |
0600 | 23 4f 00 00 0b 00 00 00 f6 4f 00 00 a3 00 00 00 02 50 00 00 09 00 00 00 a6 50 00 00 68 00 00 00 | #O.......O.......P.......P..h... |
0620 | b0 50 00 00 59 01 00 00 19 51 00 00 8e 00 00 00 73 52 00 00 c6 00 00 00 02 53 00 00 86 00 00 00 | .P..Y....Q......sR.......S...... |
0640 | c9 53 00 00 ba 00 00 00 50 54 00 00 2e 00 00 00 0b 55 00 00 90 01 00 00 3a 55 00 00 a5 00 00 00 | .S......PT.......U......:U...... |
0660 | cb 56 00 00 54 00 00 00 71 57 00 00 7b 00 00 00 c6 57 00 00 24 00 00 00 42 58 00 00 f1 00 00 00 | .V..T...qW..{....W..$...BX...... |
0680 | 67 58 00 00 9c 00 00 00 59 59 00 00 49 00 00 00 f6 59 00 00 33 00 00 00 40 5a 00 00 7b 00 00 00 | gX......YY..I....Y..3...@Z..{... |
06a0 | 74 5a 00 00 86 00 00 00 f0 5a 00 00 27 00 00 00 77 5b 00 00 a7 00 00 00 9f 5b 00 00 37 01 00 00 | tZ.......Z..'...w[.......[..7... |
06c0 | 47 5c 00 00 03 01 00 00 7f 5d 00 00 b1 00 00 00 83 5e 00 00 2a 00 00 00 35 5f 00 00 f4 00 00 00 | G\.......].......^..*...5_...... |
06e0 | 60 5f 00 00 9c 00 00 00 55 60 00 00 3a 00 00 00 f2 60 00 00 d7 00 00 00 2d 61 00 00 75 00 00 00 | `_......U`..:....`......-a..u... |
0700 | 05 62 00 00 7a 00 00 00 7b 62 00 00 13 00 00 00 f6 62 00 00 93 00 00 00 0a 63 00 00 75 00 00 00 | .b..z...{b.......b.......c..u... |
0720 | 9e 63 00 00 9d 00 00 00 14 64 00 00 10 00 00 00 b2 64 00 00 13 00 00 00 c3 64 00 00 11 00 00 00 | .c.......d.......d.......d...... |
0740 | d7 64 00 00 12 00 00 00 e9 64 00 00 40 00 00 00 fc 64 00 00 30 00 00 00 3d 65 00 00 39 00 00 00 | .d.......d..@....d..0...=e..9... |
0760 | 6e 65 00 00 45 00 00 00 a8 65 00 00 56 00 00 00 ee 65 00 00 06 00 00 00 45 66 00 00 0a 00 00 00 | ne..E....e..V....e......Ef...... |
0780 | 4c 66 00 00 13 00 00 00 57 66 00 00 50 00 00 00 6b 66 00 00 44 00 00 00 bc 66 00 00 3e 00 00 00 | Lf......Wf..P...kf..D....f..>... |
07a0 | 01 67 00 00 05 00 00 00 40 67 00 00 1d 00 00 00 46 67 00 00 34 00 00 00 64 67 00 00 30 00 00 00 | .g......@g......Fg..4...dg..0... |
07c0 | 99 67 00 00 06 00 00 00 ca 67 00 00 3f 00 00 00 d1 67 00 00 2b 00 00 00 11 68 00 00 01 00 00 00 | .g.......g..?....g..+....h...... |
07e0 | 0f 00 00 00 51 00 00 00 00 00 00 00 00 00 00 00 34 00 00 00 00 00 00 00 00 00 00 00 3c 00 00 00 | ....Q...........4...........<... |
0800 | 00 00 00 00 06 00 00 00 2b 00 00 00 0a 00 00 00 53 00 00 00 00 00 00 00 5e 00 00 00 68 00 00 00 | ........+.......S.......^...h... |
0820 | 67 00 00 00 09 00 00 00 00 00 00 00 30 00 00 00 00 00 00 00 59 00 00 00 26 00 00 00 62 00 00 00 | g...........0.......Y...&...b... |
0840 | 37 00 00 00 0e 00 00 00 00 00 00 00 12 00 00 00 78 00 00 00 1a 00 00 00 17 00 00 00 00 00 00 00 | 7...............x............... |
0860 | 25 00 00 00 64 00 00 00 20 00 00 00 27 00 00 00 16 00 00 00 6f 00 00 00 00 00 00 00 00 00 00 00 | %...d.......'.......o........... |
0880 | 5a 00 00 00 73 00 00 00 5c 00 00 00 00 00 00 00 0d 00 00 00 00 00 00 00 54 00 00 00 63 00 00 00 | Z...s...\...............T...c... |
08a0 | 2d 00 00 00 00 00 00 00 29 00 00 00 00 00 00 00 76 00 00 00 00 00 00 00 57 00 00 00 00 00 00 00 | -.......).......v.......W....... |
08c0 | 00 00 00 00 6d 00 00 00 4f 00 00 00 7c 00 00 00 44 00 00 00 00 00 00 00 13 00 00 00 1e 00 00 00 | ....m...O...|...D............... |
08e0 | 3e 00 00 00 66 00 00 00 00 00 00 00 43 00 00 00 70 00 00 00 00 00 00 00 47 00 00 00 08 00 00 00 | >...f.......C...p.......G....... |
0900 | 04 00 00 00 4c 00 00 00 00 00 00 00 18 00 00 00 32 00 00 00 00 00 00 00 00 00 00 00 15 00 00 00 | ....L...........2............... |
0920 | 69 00 00 00 61 00 00 00 1c 00 00 00 6c 00 00 00 4d 00 00 00 3f 00 00 00 46 00 00 00 7b 00 00 00 | i...a.......l...M...?...F...{... |
0940 | 72 00 00 00 5f 00 00 00 4b 00 00 00 00 00 00 00 40 00 00 00 1f 00 00 00 23 00 00 00 75 00 00 00 | r..._...K.......@.......#...u... |
0960 | 55 00 00 00 41 00 00 00 77 00 00 00 00 00 00 00 71 00 00 00 24 00 00 00 39 00 00 00 05 00 00 00 | U...A...w.......q...$...9....... |
0980 | 03 00 00 00 7a 00 00 00 6a 00 00 00 4a 00 00 00 00 00 00 00 56 00 00 00 00 00 00 00 10 00 00 00 | ....z...j...J.......V........... |
09a0 | 36 00 00 00 35 00 00 00 6e 00 00 00 14 00 00 00 42 00 00 00 00 00 00 00 5d 00 00 00 00 00 00 00 | 6...5...n.......B.......]....... |
09c0 | 21 00 00 00 3a 00 00 00 00 00 00 00 31 00 00 00 0c 00 00 00 00 00 00 00 00 00 00 00 5b 00 00 00 | !...:.......1...............[... |
09e0 | 45 00 00 00 6b 00 00 00 48 00 00 00 0b 00 00 00 49 00 00 00 2f 00 00 00 2e 00 00 00 65 00 00 00 | E...k...H.......I.../.......e... |
0a00 | 07 00 00 00 02 00 00 00 2a 00 00 00 28 00 00 00 74 00 00 00 58 00 00 00 33 00 00 00 00 00 00 00 | ........*...(...t...X...3....... |
0a20 | 19 00 00 00 2c 00 00 00 60 00 00 00 79 00 00 00 1b 00 00 00 00 00 00 00 52 00 00 00 00 00 00 00 | ....,...`...y...........R....... |
0a40 | 00 00 00 00 22 00 00 00 11 00 00 00 00 00 00 00 3b 00 00 00 50 00 00 00 1d 00 00 00 00 00 00 00 | ...."...........;...P........... |
0a60 | 3d 00 00 00 00 00 00 00 38 00 00 00 00 00 00 00 4e 00 00 00 00 00 00 00 00 31 2e 20 54 68 65 6f | =.......8.......N........1..Theo |
0a80 | 72 65 74 69 63 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 00 31 36 62 69 74 20 41 53 4e 3a 20 60 | retical.information.16bit.ASN:.` |
0aa0 | 60 36 34 34 39 36 20 2d 20 36 34 35 31 31 60 60 00 32 2e 20 43 6f 6e 66 69 67 75 72 61 74 69 6f | `64496.-.64511``.2..Configuratio |
0ac0 | 6e 20 64 65 73 63 72 69 70 74 69 6f 6e 00 33 2e 20 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 65 | n.description.3..Configuration.e |
0ae0 | 78 61 6d 70 6c 65 73 00 33 32 62 69 74 20 41 53 4e 3a 20 60 60 36 35 35 33 36 20 2d 20 36 35 35 | xamples.32bit.ASN:.``65536.-.655 |
0b00 | 35 31 60 60 00 34 2e 20 4b 6e 6f 77 6e 20 69 73 73 75 65 73 00 35 2e 20 44 65 62 75 67 67 69 6e | 51``.4..Known.issues.5..Debuggin |
0b20 | 67 00 41 20 70 6c 75 67 69 6e 20 77 69 6c 6c 20 62 65 20 75 73 65 64 20 74 6f 20 67 65 6e 65 72 | g.A.plugin.will.be.used.to.gener |
0b40 | 61 74 65 20 61 20 72 65 66 65 72 65 6e 63 65 20 6c 61 62 65 6c 20 66 6f 72 20 65 61 63 68 20 68 | ate.a.reference.label.for.each.h |
0b60 | 65 61 64 6c 69 6e 65 2e 20 54 6f 20 72 65 66 65 72 65 6e 63 65 20 61 20 70 61 67 65 20 6f 72 20 | eadline..To.reference.a.page.or. |
0b80 | 61 20 73 65 63 74 69 6f 6e 20 69 6e 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 75 | a.section.in.the.documentation.u |
0ba0 | 73 65 20 74 68 65 20 60 60 3a 72 65 66 3a 60 60 20 63 6f 6d 6d 61 6e 64 2e 00 41 64 64 20 6d 6f | se.the.``:ref:``.command..Add.mo |
0bc0 | 64 69 66 69 65 64 20 66 69 6c 65 73 20 74 6f 20 47 69 74 20 69 6e 64 65 78 20 60 60 24 20 67 69 | dified.files.to.Git.index.``$.gi |
0be0 | 74 20 61 64 64 20 70 61 74 68 2f 74 6f 2f 66 69 6c 65 6e 61 6d 65 60 60 20 6f 72 20 61 64 64 20 | t.add.path/to/filename``.or.add. |
0c00 | 61 6c 6c 20 75 6e 73 74 61 67 65 64 20 66 69 6c 65 73 20 60 60 24 20 67 69 74 20 61 64 64 20 2e | all.unstaged.files.``$.git.add.. |
0c20 | 60 60 2e 20 41 6c 6c 20 66 69 6c 65 73 20 61 64 64 65 64 20 74 6f 20 74 68 65 20 47 69 74 20 69 | ``..All.files.added.to.the.Git.i |
0c40 | 6e 64 65 78 20 77 69 6c 6c 20 62 65 20 70 61 72 74 20 6f 66 20 79 6f 75 20 66 6f 6c 6c 6f 77 69 | ndex.will.be.part.of.you.followi |
0c60 | 6e 67 20 47 69 74 20 63 6f 6d 6d 69 74 2e 00 41 64 64 72 65 73 73 20 73 70 61 63 65 00 41 6c 6c | ng.Git.commit..Address.space.All |
0c80 | 20 52 53 54 20 66 69 6c 65 73 20 6d 75 73 74 20 66 6f 6c 6c 6f 77 20 74 68 65 20 73 61 6d 65 20 | .RST.files.must.follow.the.same. |
0ca0 | 54 4f 43 20 4c 65 76 65 6c 20 73 79 6e 74 61 78 20 61 6e 64 20 68 61 76 65 20 74 6f 20 73 74 61 | TOC.Level.syntax.and.have.to.sta |
0cc0 | 72 74 20 77 69 74 68 00 41 6e 20 6f 70 74 69 6f 6e 61 6c 20 73 65 63 74 69 6f 6e 20 66 6f 6c 6c | rt.with.An.optional.section.foll |
0ce0 | 6f 77 73 2e 20 53 6f 6d 65 20 63 6f 6d 6d 61 6e 64 73 20 68 61 76 65 20 72 65 71 75 69 72 65 6d | ows..Some.commands.have.requirem |
0d00 | 65 6e 74 73 20 6c 69 6b 65 20 63 6f 6d 70 61 74 69 62 6c 65 20 68 61 72 64 77 61 72 65 20 28 65 | ents.like.compatible.hardware.(e |
0d20 | 2e 67 2e 20 57 69 66 69 29 20 6f 72 20 73 6f 6d 65 20 63 6f 6d 6d 61 6e 64 73 20 79 6f 75 20 68 | .g..Wifi).or.some.commands.you.h |
0d40 | 61 76 65 20 74 6f 20 73 65 74 20 62 65 66 6f 72 65 2e 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 | ave.to.set.before..For.example,. |
0d60 | 69 74 20 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 74 6f 20 73 65 74 20 61 20 72 6f 75 74 65 | it.is.recommended.to.set.a.route |
0d80 | 2d 6d 61 70 20 62 65 66 6f 72 65 20 63 6f 6e 66 69 67 75 72 69 6e 67 20 42 47 50 2e 00 41 6e 64 | -map.before.configuring.BGP..And |
0da0 | 20 66 69 6e 61 6c 6c 79 2c 20 72 65 6d 65 6d 62 65 72 20 74 68 61 74 20 74 68 65 20 72 65 53 74 | .finally,.remember.that.the.reSt |
0dc0 | 72 75 63 74 75 72 65 64 54 65 78 74 20 66 69 6c 65 73 20 61 72 65 6e 27 74 20 65 78 63 6c 75 73 | ructuredText.files.aren't.exclus |
0de0 | 69 76 65 6c 79 20 66 6f 72 20 67 65 6e 65 72 61 74 69 6e 67 20 48 54 4d 4c 20 61 6e 64 20 50 44 | ively.for.generating.HTML.and.PD |
0e00 | 46 2e 20 54 68 65 79 20 73 68 6f 75 6c 64 20 62 65 20 68 75 6d 61 6e 2d 72 65 61 64 61 62 6c 65 | F..They.should.be.human-readable |
0e20 | 20 61 6e 64 20 65 61 73 69 6c 79 20 70 65 72 75 73 65 64 20 66 72 6f 6d 20 61 20 63 6f 6e 73 6f | .and.easily.perused.from.a.conso |
0e40 | 6c 65 2e 00 41 6e 79 74 68 69 6e 67 20 65 6c 73 65 00 41 6e 79 74 68 69 6e 67 20 65 6c 73 65 20 | le..Anything.else.Anything.else. |
0e60 | 74 68 61 74 20 69 73 20 6e 6f 74 20 61 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 72 20 61 | that.is.not.a.configuration.or.a |
0e80 | 6e 20 6f 70 65 72 61 74 69 6f 6e 20 63 6f 6d 6d 61 6e 64 20 68 61 73 20 6e 6f 20 70 72 65 64 65 | n.operation.command.has.no.prede |
0ea0 | 66 69 6e 65 64 20 73 74 72 75 63 74 75 72 65 2e 00 41 75 74 6f 6c 69 6e 74 65 72 00 43 68 65 63 | fined.structure..Autolinter.Chec |
0ec0 | 6b 20 79 6f 75 72 20 63 68 61 6e 67 65 73 20 62 79 20 6c 6f 63 61 6c 6c 79 20 62 75 69 6c 64 69 | k.your.changes.by.locally.buildi |
0ee0 | 6e 67 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 60 60 24 20 6d 61 6b 65 20 6c 69 | ng.the.documentation.``$.make.li |
0f00 | 76 65 68 74 6d 6c 60 60 2e 20 53 70 68 69 6e 78 20 77 69 6c 6c 20 62 75 69 6c 64 20 74 68 65 20 | vehtml``..Sphinx.will.build.the. |
0f20 | 68 74 6d 6c 20 66 69 6c 65 73 20 69 6e 20 74 68 65 20 60 60 64 6f 63 73 2f 5f 62 75 69 6c 64 60 | html.files.in.the.``docs/_build` |
0f40 | 60 20 66 6f 6c 64 65 72 2e 20 57 65 20 70 72 6f 76 69 64 65 20 79 6f 75 20 77 69 74 68 20 61 20 | `.folder..We.provide.you.with.a. |
0f60 | 44 6f 63 6b 65 72 20 63 6f 6e 74 61 69 6e 65 72 20 66 6f 72 20 61 6e 20 65 61 73 79 2d 74 6f 2d | Docker.container.for.an.easy-to- |
0f80 | 75 73 65 20 75 73 65 72 20 65 78 70 65 72 69 65 6e 63 65 2e 20 43 68 65 63 6b 20 74 68 65 20 52 | use.user.experience..Check.the.R |
0fa0 | 45 41 44 4d 45 2e 6d 64 5f 20 66 69 6c 65 20 6f 66 20 74 68 69 73 20 72 65 70 6f 73 69 74 6f 72 | EADME.md_.file.of.this.repositor |
0fc0 | 79 2e 00 43 68 65 63 6b 20 79 6f 75 72 20 63 6f 6e 66 69 67 75 72 65 64 20 72 65 6d 6f 74 65 20 | y..Check.your.configured.remote. |
0fe0 | 72 65 70 6f 73 69 74 6f 72 69 65 73 3a 00 43 6c 6f 6e 65 20 66 6f 72 6b 20 74 6f 20 6c 6f 63 61 | repositories:.Clone.fork.to.loca |
1000 | 6c 20 6d 61 63 68 69 6e 65 2c 20 74 68 65 6e 20 63 68 61 6e 67 65 20 74 6f 20 74 68 61 74 20 64 | l.machine,.then.change.to.that.d |
1020 | 69 72 65 63 74 6f 72 79 20 60 60 24 20 63 64 20 76 79 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 | irectory.``$.cd.vyos-documentati |
1040 | 6f 6e 60 60 00 43 6f 6d 6d 69 74 20 79 6f 75 72 20 63 68 61 6e 67 65 73 20 77 69 74 68 20 74 68 | on``.Commit.your.changes.with.th |
1060 | 65 20 6d 65 73 73 61 67 65 2c 20 60 60 24 20 67 69 74 20 63 6f 6d 6d 69 74 20 2d 6d 20 22 3c 63 | e.message,.``$.git.commit.-m."<c |
1080 | 6f 6d 6d 69 74 20 6d 65 73 73 61 67 65 3e 22 60 60 20 6f 72 20 20 75 73 65 20 60 60 24 20 67 69 | ommit.message>"``.or..use.``$.gi |
10a0 | 74 20 63 6f 6d 6d 69 74 20 2d 76 60 60 20 74 6f 20 68 61 76 65 20 79 6f 75 72 20 63 6f 6e 66 69 | t.commit.-v``.to.have.your.confi |
10c0 | 67 75 72 65 64 20 65 64 69 74 6f 72 20 6c 61 75 6e 63 68 65 64 2e 20 59 6f 75 20 63 61 6e 20 74 | gured.editor.launched..You.can.t |
10e0 | 79 70 65 20 69 6e 20 61 20 63 6f 6d 6d 69 74 20 6d 65 73 73 61 67 65 2e 20 41 67 61 69 6e 20 70 | ype.in.a.commit.message..Again.p |
1100 | 6c 65 61 73 65 20 6d 61 6b 65 20 79 6f 75 72 73 65 6c 66 20 63 6f 6d 66 6f 72 74 61 62 6c 65 20 | lease.make.yourself.comfortable. |
1120 | 77 69 74 68 6f 75 74 20 72 75 6c 65 73 20 28 3a 72 65 66 3a 60 70 72 65 70 61 72 65 5f 63 6f 6d | without.rules.(:ref:`prepare_com |
1140 | 6d 69 74 60 29 2e 00 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 6f 64 65 20 70 61 67 65 73 00 | mit`)..Configuration.mode.pages. |
1160 | 43 72 65 61 74 65 20 61 20 6e 65 77 20 62 72 61 6e 63 68 20 66 6f 72 20 79 6f 75 72 20 77 6f 72 | Create.a.new.branch.for.your.wor |
1180 | 6b 2c 20 75 73 65 20 61 20 64 65 73 63 72 69 70 74 69 76 65 20 6e 61 6d 65 20 6f 66 20 79 6f 75 | k,.use.a.descriptive.name.of.you |
11a0 | 72 20 77 6f 72 6b 3a 20 60 60 24 20 67 69 74 20 63 68 65 63 6b 6f 75 74 20 2d 62 20 3c 62 72 61 | r.work:.``$.git.checkout.-b.<bra |
11c0 | 6e 63 68 2d 6e 61 6d 65 3e 60 60 00 43 72 6f 73 73 2d 52 65 66 65 72 65 6e 63 65 73 00 43 75 73 | nch-name>``.Cross-References.Cus |
11e0 | 74 6f 6d 20 53 70 68 69 6e 78 2d 64 6f 63 20 4d 61 72 6b 75 70 00 43 75 73 74 6f 6d 20 63 6f 6d | tom.Sphinx-doc.Markup.Custom.com |
1200 | 6d 61 6e 64 73 20 68 61 76 65 20 62 65 65 6e 20 64 65 76 65 6c 6f 70 65 64 20 66 6f 72 20 77 72 | mands.have.been.developed.for.wr |
1220 | 69 74 69 6e 67 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 50 6c 65 61 73 65 20 | iting.the.documentation..Please. |
1240 | 6d 61 6b 65 20 79 6f 75 72 73 65 6c 66 20 63 6f 6d 66 6f 72 74 61 62 6c 65 20 77 69 74 68 20 74 | make.yourself.comfortable.with.t |
1260 | 68 6f 73 65 20 63 6f 6d 6d 61 6e 64 73 20 61 73 20 74 68 69 73 20 65 61 73 65 73 20 74 68 65 20 | hose.commands.as.this.eases.the. |
1280 | 77 61 79 20 77 65 20 72 65 6e 64 65 72 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e | way.we.render.the.documentation. |
12a0 | 00 44 65 73 63 72 69 62 65 20 43 4c 49 20 69 74 65 6d 73 20 72 65 6c 61 74 65 64 20 74 6f 20 74 | .Describe.CLI.items.related.to.t |
12c0 | 68 65 20 73 65 72 76 69 63 65 20 6f 72 20 75 73 65 20 63 61 73 65 2e 20 45 61 63 68 20 63 6f 6e | he.service.or.use.case..Each.con |
12e0 | 66 69 67 20 6c 69 6e 65 20 6f 72 20 73 65 63 74 69 6f 6e 20 6d 75 73 74 20 62 65 20 65 78 70 6c | fig.line.or.section.must.be.expl |
1300 | 61 69 6e 65 64 2c 20 75 73 69 6e 67 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 70 72 6f 76 69 64 65 | ained,.using.information.provide |
1320 | 64 20 69 6e 20 74 68 65 20 31 73 74 20 70 61 72 74 20 6f 66 20 74 68 65 20 70 61 67 65 2e 00 44 | d.in.the.1st.part.of.the.page..D |
1340 | 65 73 63 72 69 62 65 64 20 70 72 6f 63 65 64 75 72 65 73 20 66 6f 72 20 64 65 62 75 67 67 69 6e | escribed.procedures.for.debuggin |
1360 | 67 20 61 20 73 65 72 76 69 63 65 3a 00 44 6f 6e 27 74 20 66 6f 72 67 65 74 20 74 6f 20 75 70 64 | g.a.service:.Don't.forget.to.upd |
1380 | 61 74 65 20 60 60 69 6e 64 65 78 2e 72 73 74 60 60 20 77 68 65 6e 20 61 64 64 69 6e 67 20 61 20 | ate.``index.rst``.when.adding.a. |
13a0 | 6e 65 77 20 6e 6f 64 65 2e 00 45 61 63 68 20 47 69 74 48 75 62 20 70 75 6c 6c 20 72 65 71 75 65 | new.node..Each.GitHub.pull.reque |
13c0 | 73 74 20 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 6c 69 6e 74 65 64 20 74 6f 20 63 68 | st.is.automatically.linted.to.ch |
13e0 | 65 63 6b 20 74 68 65 20 61 64 64 72 65 73 73 20 73 70 61 63 65 20 61 6e 64 20 6c 69 6e 65 20 6c | eck.the.address.space.and.line.l |
1400 | 65 6e 67 74 68 2e 00 45 61 63 68 20 70 61 67 65 20 6d 75 73 74 20 63 6f 6e 74 61 69 6e 20 74 68 | ength..Each.page.must.contain.th |
1420 | 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 70 61 72 74 73 3a 00 45 78 63 65 70 74 20 69 6e 20 60 60 2e | e.following.parts:.Except.in.``. |
1440 | 2e 20 63 6f 64 65 2d 62 6c 6f 63 6b 3a 3a 60 60 20 62 65 63 61 75 73 65 20 69 74 20 75 73 65 73 | ..code-block::``.because.it.uses |
1460 | 20 74 68 65 20 68 74 6d 6c 20 74 61 67 20 60 60 3c 70 72 65 3e 60 60 20 61 6e 64 20 72 65 6e 64 | .the.html.tag.``<pre>``.and.rend |
1480 | 65 72 73 20 74 68 65 20 73 61 6d 65 20 6c 69 6e 65 20 66 6f 72 6d 61 74 20 66 72 6f 6d 20 74 68 | ers.the.same.line.format.from.th |
14a0 | 65 20 73 6f 75 72 63 65 20 72 73 74 20 66 69 6c 65 2e 00 46 6f 72 20 61 6e 20 69 6e 6c 69 6e 65 | e.source.rst.file..For.an.inline |
14c0 | 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6c 65 76 65 6c 20 63 6f 6d 6d 61 6e 64 2c 20 75 73 | .configuration.level.command,.us |
14e0 | 65 20 60 60 3a 63 66 67 63 6d 64 3a 60 60 00 46 6f 72 20 61 6e 20 69 6e 6c 69 6e 65 20 6f 70 65 | e.``:cfgcmd:``.For.an.inline.ope |
1500 | 72 61 74 69 6f 6e 61 6c 20 6c 65 76 65 6c 20 63 6f 6d 6d 61 6e 64 2c 20 75 73 65 20 60 60 3a 6f | rational.level.command,.use.``:o |
1520 | 70 63 6d 64 3a 60 60 00 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 79 6f 75 20 77 61 6e 74 20 74 6f | pcmd:``.For.example,.you.want.to |
1540 | 20 72 65 66 65 72 65 6e 63 65 20 74 68 65 20 68 65 61 64 6c 69 6e 65 20 2a 2a 56 4c 41 4e 2a 2a | .reference.the.headline.**VLAN** |
1560 | 20 69 6e 20 74 68 65 20 2a 2a 65 74 68 65 72 6e 65 74 2e 72 73 74 2a 2a 20 70 61 67 65 2e 20 54 | .in.the.**ethernet.rst**.page..T |
1580 | 68 65 20 70 6c 75 67 69 6e 20 67 65 6e 65 72 61 74 65 73 20 74 68 65 20 6c 61 62 65 6c 20 62 61 | he.plugin.generates.the.label.ba |
15a0 | 73 65 64 20 6f 6e 20 74 68 65 20 68 65 61 64 6c 69 6e 65 20 61 6e 64 20 74 68 65 20 66 69 6c 65 | sed.on.the.headline.and.the.file |
15c0 | 20 70 61 74 68 2e 00 46 6f 72 20 65 78 61 6d 70 6c 65 3a 00 46 6f 72 6b 20 74 68 69 73 20 70 72 | .path..For.example:.Fork.this.pr |
15e0 | 6f 6a 65 63 74 20 6f 6e 20 47 69 74 48 75 62 20 68 74 74 70 73 3a 2f 2f 67 69 74 68 75 62 2e 63 | oject.on.GitHub.https://github.c |
1600 | 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 2f 66 6f 72 6b 00 | om/vyos/vyos-documentation/fork. |
1620 | 46 6f 72 6b 69 6e 67 20 57 6f 72 6b 66 6c 6f 77 00 46 6f 72 6d 61 74 69 6e 67 20 61 6e 64 20 53 | Forking.Workflow.Formating.and.S |
1640 | 70 68 69 6e 78 6d 61 72 6b 75 70 00 46 6f 72 6d 61 74 74 69 6e 67 20 61 6e 64 20 53 70 68 69 6e | phinxmarkup.Formatting.and.Sphin |
1660 | 78 6d 61 72 6b 75 70 00 47 65 6e 65 72 61 6c 20 63 6f 6e 63 65 70 74 73 20 66 6f 72 20 74 72 6f | xmarkup.General.concepts.for.tro |
1680 | 75 62 6c 65 73 68 6f 6f 74 69 6e 67 20 61 6e 64 20 64 65 74 61 69 6c 65 64 20 70 72 6f 63 65 73 | ubleshooting.and.detailed.proces |
16a0 | 73 20 64 65 73 63 72 69 70 74 69 6f 6e 73 20 62 65 6c 6f 6e 67 20 68 65 72 65 2e 00 47 75 69 64 | s.descriptions.belong.here..Guid |
16c0 | 65 6c 69 6e 65 73 00 49 66 20 74 68 65 72 65 20 73 6f 6d 65 20 74 72 6f 75 62 6c 65 73 68 6f 6f | elines.If.there.some.troubleshoo |
16e0 | 74 69 6e 67 20 67 75 69 64 65 73 20 72 65 6c 61 74 65 64 20 74 6f 20 74 68 65 20 63 6f 6d 6d 61 | ting.guides.related.to.the.comma |
1700 | 6e 64 73 2e 20 45 78 70 6c 61 69 6e 20 69 74 20 69 6e 20 74 68 65 20 6e 65 78 74 20 6f 70 74 69 | nds..Explain.it.in.the.next.opti |
1720 | 6f 6e 61 6c 20 70 61 72 74 2e 00 49 66 20 79 6f 75 20 61 6c 73 6f 20 77 61 6e 74 20 74 6f 20 75 | onal.part..If.you.also.want.to.u |
1740 | 70 64 61 74 65 20 79 6f 75 72 20 66 6f 72 6b 20 6f 6e 20 47 69 74 48 75 62 2c 20 75 73 65 20 74 | pdate.your.fork.on.GitHub,.use.t |
1760 | 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 3a 20 60 60 24 20 67 69 74 20 70 75 73 68 20 6f 72 69 67 69 | he.following:.``$.git.push.origi |
1780 | 6e 20 6d 61 73 74 65 72 60 60 00 49 66 20 79 6f 75 20 61 72 65 20 77 69 6c 6c 69 6e 67 20 74 6f | n.master``.If.you.are.willing.to |
17a0 | 20 63 6f 6e 74 72 69 62 75 74 65 20 74 6f 20 6f 75 72 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e | .contribute.to.our.documentation |
17c0 | 20 74 68 69 73 20 69 73 20 74 68 65 20 64 65 66 69 6e 69 74 65 20 67 75 69 64 65 20 68 6f 77 20 | .this.is.the.definite.guide.how. |
17e0 | 74 6f 20 64 6f 20 73 6f 2e 00 49 6e 20 63 6f 6e 74 72 61 73 74 20 74 6f 20 73 75 62 6d 69 74 74 | to.do.so..In.contrast.to.submitt |
1800 | 69 6e 67 20 63 6f 64 65 20 70 61 74 63 68 65 73 2c 20 74 68 65 72 65 20 69 73 20 6e 6f 20 72 65 | ing.code.patches,.there.is.no.re |
1820 | 71 75 69 72 65 6d 65 6e 74 20 74 68 61 74 20 79 6f 75 20 6f 70 65 6e 20 75 70 20 61 20 50 68 61 | quirement.that.you.open.up.a.Pha |
1840 | 62 72 69 63 61 74 6f 72 5f 20 74 61 73 6b 20 70 72 69 6f 72 20 74 6f 20 73 75 62 6d 69 74 74 69 | bricator_.task.prior.to.submitti |
1860 | 6e 67 20 61 20 50 75 6c 6c 2d 52 65 71 75 65 73 74 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e | ng.a.Pull-Request.to.the.documen |
1880 | 74 61 74 69 6f 6e 2e 00 49 6e 20 74 68 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 70 61 72 | tation..In.the.configuration.par |
18a0 | 74 20 6f 66 20 74 68 65 20 70 61 67 65 2c 20 61 6c 6c 20 70 6f 73 73 69 62 6c 65 20 63 6f 6e 66 | t.of.the.page,.all.possible.conf |
18c0 | 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 73 20 73 68 6f 75 6c 64 20 62 65 20 64 6f 63 75 | iguration.options.should.be.docu |
18e0 | 6d 65 6e 74 65 64 2e 20 55 73 65 20 60 60 2e 2e 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 65 73 63 | mented..Use.``...cfgcmd::``.desc |
1900 | 72 69 62 65 64 20 61 62 6f 76 65 2e 00 49 6e 64 65 6e 74 20 77 69 74 68 20 74 77 6f 20 73 70 61 | ribed.above..Indent.with.two.spa |
1920 | 63 65 73 2e 00 49 6e 73 74 61 6c 6c 20 74 68 65 20 72 65 71 75 69 72 65 6d 65 6e 74 73 20 60 60 | ces..Install.the.requirements.`` |
1940 | 24 20 70 69 70 20 69 6e 73 74 61 6c 6c 20 2d 72 20 72 65 71 75 69 72 65 6d 65 6e 74 73 2e 74 78 | $.pip.install.-r.requirements.tx |
1960 | 74 60 60 20 28 6f 72 20 73 6f 6d 65 74 68 69 6e 67 20 73 69 6d 69 6c 61 72 29 00 4c 65 61 76 65 | t``.(or.something.similar).Leave |
1980 | 20 61 20 6e 65 77 6c 69 6e 65 20 62 65 66 6f 72 65 20 61 6e 64 20 61 66 74 65 72 20 61 20 68 65 | .a.newline.before.and.after.a.he |
19a0 | 61 64 65 72 2e 00 4c 69 6d 69 74 20 61 6c 6c 20 6c 69 6e 65 73 20 74 6f 20 61 20 6d 61 78 69 6d | ader..Limit.all.lines.to.a.maxim |
19c0 | 75 6d 20 6f 66 20 38 30 20 63 68 61 72 61 63 74 65 72 73 2e 00 4c 69 6e 65 20 6c 65 6e 67 74 68 | um.of.80.characters..Line.length |
19e0 | 00 4d 61 6b 65 20 61 6c 6c 20 79 6f 75 72 20 63 68 61 6e 67 65 73 20 2d 20 70 6c 65 61 73 65 20 | .Make.all.your.changes.-.please. |
1a00 | 6b 65 65 70 20 6f 75 72 20 63 6f 6d 6d 69 74 20 72 75 6c 65 73 20 69 6e 20 6d 69 6e 64 20 28 3a | keep.our.commit.rules.in.mind.(: |
1a20 | 72 65 66 3a 60 70 72 65 70 61 72 65 5f 63 6f 6d 6d 69 74 60 29 2e 20 54 68 69 73 20 6d 61 69 6e | ref:`prepare_commit`)..This.main |
1a40 | 6c 79 20 61 70 70 6c 69 65 73 20 74 6f 20 70 72 6f 70 65 72 20 63 6f 6d 6d 69 74 20 6d 65 73 73 | ly.applies.to.proper.commit.mess |
1a60 | 61 67 65 73 20 64 65 73 63 72 69 62 69 6e 67 20 79 6f 75 72 20 63 68 61 6e 67 65 20 28 68 6f 77 | ages.describing.your.change.(how |
1a80 | 20 61 6e 64 20 77 68 79 29 2e 20 50 6c 65 61 73 65 20 63 68 65 63 6b 20 6f 75 74 20 74 68 65 20 | .and.why)..Please.check.out.the. |
1aa0 | 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 53 70 68 69 6e 78 2d 64 6f 63 5f 20 6f 72 20 | documentation.of.Sphinx-doc_.or. |
1ac0 | 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 5f 20 69 66 20 79 6f 75 20 61 72 65 20 6e 6f 74 | reStructuredText_.if.you.are.not |
1ae0 | 20 66 61 6d 69 6c 69 61 72 20 77 69 74 68 20 69 74 2e 20 54 68 69 73 20 69 73 20 75 73 65 64 20 | .familiar.with.it..This.is.used. |
1b00 | 66 6f 72 20 77 72 69 74 69 6e 67 20 6f 75 72 20 64 6f 63 73 2e 20 41 64 64 69 74 69 6f 6e 61 6c | for.writing.our.docs..Additional |
1b20 | 20 64 69 72 65 63 74 69 76 65 73 20 68 6f 77 20 74 6f 20 77 72 69 74 65 20 69 6e 20 52 53 54 20 | .directives.how.to.write.in.RST. |
1b40 | 63 61 6e 20 62 65 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 72 65 53 74 72 75 63 74 75 72 65 | can.be.obtained.from.reStructure |
1b60 | 64 54 65 78 74 44 69 72 65 63 74 69 76 65 73 5f 2e 00 4d 75 6c 74 69 63 61 73 74 20 4d 41 43 2d | dTextDirectives_..Multicast.MAC- |
1b80 | 41 64 64 72 65 73 73 65 73 3a 20 60 60 39 30 2d 31 30 2d 30 30 60 60 20 74 6f 20 60 60 39 30 2d | Addresses:.``90-10-00``.to.``90- |
1ba0 | 31 30 2d 46 46 60 60 00 4e 6f 74 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 52 46 43 73 20 | 10-FF``.Note.the.following.RFCs. |
1bc0 | 28 3a 72 66 63 3a 60 35 37 33 37 60 2c 20 3a 72 66 63 3a 60 33 38 34 39 60 2c 20 3a 72 66 63 3a | (:rfc:`5737`,.:rfc:`3849`,.:rfc: |
1be0 | 60 35 33 38 39 60 20 61 6e 64 20 3a 72 66 63 3a 60 37 30 34 32 60 29 2c 20 77 68 69 63 68 20 64 | `5389`.and.:rfc:`7042`),.which.d |
1c00 | 65 73 63 72 69 62 65 20 74 68 65 20 72 65 73 65 72 76 65 64 20 70 75 62 6c 69 63 20 49 50 20 61 | escribe.the.reserved.public.IP.a |
1c20 | 64 64 72 65 73 73 65 73 20 61 6e 64 20 61 75 74 6f 6e 6f 6d 6f 75 73 20 73 79 73 74 65 6d 20 6e | ddresses.and.autonomous.system.n |
1c40 | 75 6d 62 65 72 73 20 66 6f 72 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 3a 00 4f 6e | umbers.for.the.documentation:.On |
1c60 | 63 65 20 70 75 6c 6c 20 72 65 71 75 65 73 74 73 20 68 61 76 65 20 62 65 65 6e 20 61 70 70 72 6f | ce.pull.requests.have.been.appro |
1c80 | 76 65 64 2c 20 79 6f 75 20 6d 61 79 20 77 61 6e 74 20 74 6f 20 6c 6f 63 61 6c 6c 79 20 75 70 64 | ved,.you.may.want.to.locally.upd |
1ca0 | 61 74 65 20 79 6f 75 72 20 66 6f 72 6b 65 64 20 72 65 70 6f 73 69 74 6f 72 79 20 74 6f 6f 2e 20 | ate.your.forked.repository.too.. |
1cc0 | 46 69 72 73 74 20 79 6f 75 27 6c 6c 20 68 61 76 65 20 74 6f 20 61 64 64 20 61 20 73 65 63 6f 6e | First.you'll.have.to.add.a.secon |
1ce0 | 64 20 72 65 6d 6f 74 65 20 63 61 6c 6c 65 64 20 60 75 70 73 74 72 65 61 6d 60 20 77 68 69 63 68 | d.remote.called.`upstream`.which |
1d00 | 20 70 6f 69 6e 74 73 20 74 6f 20 6f 75 72 20 6d 61 69 6e 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 | .points.to.our.main.repository.. |
1d20 | 60 60 24 20 67 69 74 20 72 65 6d 6f 74 65 20 61 64 64 20 75 70 73 74 72 65 61 6d 20 68 74 74 70 | ``$.git.remote.add.upstream.http |
1d40 | 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 6d 65 6e | s://github.com/vyos/vyos-documen |
1d60 | 74 61 74 69 6f 6e 2e 67 69 74 60 60 00 4f 70 65 72 61 74 69 6f 6e 20 6d 6f 64 65 20 63 6f 6d 6d | tation.git``.Operation.mode.comm |
1d80 | 61 6e 64 73 20 74 68 61 74 20 64 6f 20 6e 6f 74 20 66 69 74 20 69 6e 20 61 20 72 65 6c 61 74 65 | ands.that.do.not.fit.in.a.relate |
1da0 | 64 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 6f 64 65 20 63 6f 6d 6d 61 6e 64 20 6d 75 73 | d.configuration.mode.command.mus |
1dc0 | 74 20 62 65 20 64 6f 63 75 6d 65 6e 74 65 64 20 69 6e 20 74 68 69 73 20 70 61 72 74 20 6f 66 20 | t.be.documented.in.this.part.of. |
1de0 | 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 4f 70 65 72 61 74 69 6f 6e 20 6d 6f 64 | the.documentation..Operation.mod |
1e00 | 65 20 70 61 67 65 73 00 50 61 67 65 20 63 6f 6e 74 65 6e 74 00 50 6c 65 61 73 65 20 64 6f 20 6e | e.pages.Page.content.Please.do.n |
1e20 | 6f 74 20 75 73 65 20 6f 74 68 65 72 20 70 75 62 6c 69 63 20 61 64 64 72 65 73 73 20 73 70 61 63 | ot.use.other.public.address.spac |
1e40 | 65 2e 00 50 72 61 63 74 69 63 61 6c 20 65 78 61 6d 70 6c 65 73 20 6f 66 20 74 68 65 20 73 65 72 | e..Practical.examples.of.the.ser |
1e60 | 76 69 63 65 20 6f 72 20 75 73 65 20 63 61 73 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2e 20 | vice.or.use.case.configuration.. |
1e80 | 54 68 65 79 20 6d 75 73 74 20 63 6f 6e 74 61 69 6e 20 74 6f 70 6f 6c 6f 67 79 20 6d 61 70 73 20 | They.must.contain.topology.maps. |
1ea0 | 28 69 66 20 61 70 70 6c 69 63 61 62 6c 65 29 20 61 6e 64 20 73 68 6f 72 74 20 64 65 73 63 72 69 | (if.applicable).and.short.descri |
1ec0 | 70 74 69 6f 6e 73 2e 00 50 72 6f 70 65 72 6c 79 20 71 75 6f 74 65 20 63 6f 6d 6d 61 6e 64 73 2c | ptions..Properly.quote.commands, |
1ee0 | 20 66 69 6c 65 6e 61 6d 65 73 20 61 6e 64 20 62 72 69 65 66 20 63 6f 64 65 20 73 6e 69 70 70 65 | .filenames.and.brief.code.snippe |
1f00 | 74 73 20 77 69 74 68 20 64 6f 75 62 6c 65 20 62 61 63 6b 74 69 63 6b 73 2e 00 50 75 73 68 20 63 | ts.with.double.backticks..Push.c |
1f20 | 6f 6d 6d 69 74 73 20 74 6f 20 79 6f 75 72 20 47 69 74 48 75 62 20 70 72 6f 6a 65 63 74 3a 20 60 | ommits.to.your.GitHub.project:.` |
1f40 | 60 24 20 67 69 74 20 70 75 73 68 20 2d 75 20 6f 72 69 67 69 6e 20 3c 62 72 61 6e 63 68 2d 6e 61 | `$.git.push.-u.origin.<branch-na |
1f60 | 6d 65 3e 60 60 00 52 65 6c 61 74 65 64 20 6f 70 65 72 61 74 69 6f 6e 20 63 6f 6d 6d 61 6e 64 20 | me>``.Related.operation.command. |
1f80 | 6d 75 73 74 20 62 65 20 64 6f 63 75 6d 65 6e 74 65 64 20 69 6e 20 74 68 65 20 6e 65 78 74 20 70 | must.be.documented.in.the.next.p |
1fa0 | 61 72 74 20 6f 66 20 74 68 65 20 61 72 74 69 63 6c 65 2e 20 55 73 65 20 60 60 3a 3a 6f 70 63 6d | art.of.the.article..Use.``::opcm |
1fc0 | 64 2e 2e 60 60 20 66 6f 72 20 74 68 65 73 65 20 63 6f 6d 6d 61 6e 64 73 2e 00 53 6f 6d 65 74 69 | d..``.for.these.commands..Someti |
1fe0 | 6d 65 73 20 69 74 20 69 73 20 6e 65 63 65 73 73 61 72 79 20 74 6f 20 70 72 6f 76 69 64 65 20 72 | mes.it.is.necessary.to.provide.r |
2000 | 65 61 6c 20 49 50 20 61 64 64 72 65 73 73 65 73 20 6c 69 6b 65 20 69 6e 20 74 68 65 20 3a 72 65 | eal.IP.addresses.like.in.the.:re |
2020 | 66 3a 60 65 78 61 6d 70 6c 65 73 60 2e 20 46 6f 72 20 74 68 69 73 2c 20 70 6c 65 61 73 65 20 75 | f:`examples`..For.this,.please.u |
2040 | 73 65 20 74 68 65 20 73 70 68 69 6e 78 20 63 6f 6d 6d 65 6e 74 20 73 79 6e 74 61 78 20 60 60 2e | se.the.sphinx.comment.syntax.``. |
2060 | 2e 20 73 74 6f 70 5f 76 79 6f 73 6c 69 6e 74 65 72 60 60 20 74 6f 20 73 74 6f 70 20 74 68 65 20 | ..stop_vyoslinter``.to.stop.the. |
2080 | 6c 69 6e 74 65 72 20 61 6e 64 20 60 60 2e 2e 20 73 74 61 72 74 5f 76 79 6f 73 6c 69 6e 74 65 72 | linter.and.``...start_vyoslinter |
20a0 | 60 60 20 74 6f 20 73 74 61 72 74 2e 00 53 74 79 6c 65 20 47 75 69 64 65 00 53 75 62 6d 69 74 20 | ``.to.start..Style.Guide.Submit. |
20c0 | 70 75 6c 6c 2d 72 65 71 75 65 73 74 2e 20 49 6e 20 47 69 74 48 75 62 20 76 69 73 69 74 20 74 68 | pull-request..In.GitHub.visit.th |
20e0 | 65 20 6d 61 69 6e 20 72 65 70 6f 73 69 74 6f 72 79 20 61 6e 64 20 79 6f 75 20 73 68 6f 75 6c 64 | e.main.repository.and.you.should |
2100 | 20 73 65 65 20 61 20 62 61 6e 6e 65 72 20 73 75 67 67 65 73 74 69 6e 67 20 74 6f 20 6d 61 6b 65 | .see.a.banner.suggesting.to.make |
2120 | 20 61 20 70 75 6c 6c 20 72 65 71 75 65 73 74 2e 20 46 69 6c 6c 20 6f 75 74 20 74 68 65 20 66 6f | .a.pull.request..Fill.out.the.fo |
2140 | 72 6d 20 61 6e 64 20 64 65 73 63 72 69 62 65 20 77 68 61 74 20 79 6f 75 20 64 6f 2e 00 54 4f 43 | rm.and.describe.what.you.do..TOC |
2160 | 20 4c 65 76 65 6c 00 54 61 6b 65 20 61 20 6c 6f 6f 6b 20 61 74 20 74 68 65 20 3a 64 6f 63 3a 60 | .Level.Take.a.look.at.the.:doc:` |
2180 | 2f 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 60 20 70 61 67 65 20 66 6f 72 20 61 6e 20 69 6e 74 72 | /documentation`.page.for.an.intr |
21a0 | 69 63 61 74 65 20 65 78 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 64 6f 63 75 6d 65 6e | icate.explanation.of.the.documen |
21c0 | 74 61 74 69 6f 6e 20 70 72 6f 63 65 73 73 2e 00 54 68 65 20 46 6f 72 6b 69 6e 67 20 57 6f 72 6b | tation.process..The.Forking.Work |
21e0 | 66 6c 6f 77 20 69 73 20 66 75 6e 64 61 6d 65 6e 74 61 6c 6c 79 20 64 69 66 66 65 72 65 6e 74 20 | flow.is.fundamentally.different. |
2200 | 66 72 6f 6d 20 6f 74 68 65 72 20 70 6f 70 75 6c 61 72 20 47 69 74 20 77 6f 72 6b 66 6c 6f 77 73 | from.other.popular.Git.workflows |
2220 | 2e 20 49 6e 73 74 65 61 64 20 6f 66 20 75 73 69 6e 67 20 61 20 73 69 6e 67 6c 65 20 73 65 72 76 | ..Instead.of.using.a.single.serv |
2240 | 65 72 2d 73 69 64 65 20 72 65 70 6f 73 69 74 6f 72 79 20 74 6f 20 61 63 74 20 61 73 20 74 68 65 | er-side.repository.to.act.as.the |
2260 | 20 22 63 65 6e 74 72 61 6c 22 20 63 6f 64 65 62 61 73 65 2c 20 69 74 20 67 69 76 65 73 20 65 76 | ."central".codebase,.it.gives.ev |
2280 | 65 72 79 20 64 65 76 65 6c 6f 70 65 72 20 74 68 65 69 72 20 6f 77 6e 20 73 65 72 76 65 72 2d 73 | ery.developer.their.own.server-s |
22a0 | 69 64 65 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 54 68 69 73 20 6d 65 61 6e 73 20 74 68 61 74 20 | ide.repository..This.means.that. |
22c0 | 65 61 63 68 20 63 6f 6e 74 72 69 62 75 74 6f 72 20 68 61 73 20 6e 6f 74 20 6f 6e 65 2c 20 62 75 | each.contributor.has.not.one,.bu |
22e0 | 74 20 74 77 6f 20 47 69 74 20 72 65 70 6f 73 69 74 6f 72 69 65 73 3a 20 61 20 70 72 69 76 61 74 | t.two.Git.repositories:.a.privat |
2300 | 65 20 6c 6f 63 61 6c 20 6f 6e 65 20 61 6e 64 20 61 20 70 75 62 6c 69 63 20 73 65 72 76 65 72 2d | e.local.one.and.a.public.server- |
2320 | 73 69 64 65 20 6f 6e 65 2e 00 54 68 65 20 61 72 74 69 63 6c 65 20 73 74 61 72 74 73 20 77 69 74 | side.one..The.article.starts.wit |
2340 | 68 20 61 20 73 68 6f 72 74 20 69 6e 74 72 6f 64 75 63 74 69 6f 6e 20 61 62 6f 75 74 20 74 68 65 | h.a.short.introduction.about.the |
2360 | 20 63 6f 6d 6d 61 6e 64 20 6f 72 20 74 68 65 20 74 65 63 68 6e 6f 6c 6f 67 79 2e 20 50 6c 65 61 | .command.or.the.technology..Plea |
2380 | 73 65 20 69 6e 63 6c 75 64 65 20 73 6f 6d 65 20 68 65 6c 70 66 75 6c 20 6c 69 6e 6b 73 20 6f 72 | se.include.some.helpful.links.or |
23a0 | 20 62 61 63 6b 67 72 6f 75 6e 64 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 00 54 68 65 20 63 6f 6e | .background.information..The.con |
23c0 | 66 69 67 75 72 61 74 69 6f 6e 20 6d 6f 64 65 20 66 6f 6c 64 65 72 20 61 6e 64 20 74 68 65 20 61 | figuration.mode.folder.and.the.a |
23e0 | 72 74 69 63 6c 65 73 20 63 6f 76 65 72 20 74 68 65 20 73 70 65 63 69 66 69 63 20 6c 65 76 65 6c | rticles.cover.the.specific.level |
2400 | 20 6f 66 20 74 68 65 20 63 6f 6d 6d 61 6e 64 73 2e 20 54 68 65 20 65 78 61 63 74 20 6c 65 76 65 | .of.the.commands..The.exact.leve |
2420 | 6c 20 64 65 70 65 6e 64 73 20 6f 6e 20 74 68 65 20 63 6f 6d 6d 61 6e 64 2e 20 54 68 69 73 20 73 | l.depends.on.the.command..This.s |
2440 | 68 6f 75 6c 64 20 70 72 6f 76 69 64 65 20 73 74 61 62 69 6c 69 74 79 20 66 6f 72 20 55 52 4c 73 | hould.provide.stability.for.URLs |
2460 | 20 75 73 65 64 20 69 6e 20 74 68 65 20 66 6f 72 75 6d 20 6f 72 20 62 6c 6f 67 70 6f 73 74 2e 00 | .used.in.the.forum.or.blogpost.. |
2480 | 54 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 68 61 73 20 33 20 64 69 66 66 65 72 65 6e | The.documentation.has.3.differen |
24a0 | 74 20 74 79 70 65 73 20 6f 66 20 70 61 67 65 73 2e 20 54 68 65 20 73 61 6d 65 20 6b 69 6e 64 20 | t.types.of.pages..The.same.kind. |
24c0 | 6f 66 20 70 61 67 65 73 20 6d 75 73 74 20 68 61 76 65 20 74 68 65 20 73 61 6d 65 20 73 74 72 75 | of.pages.must.have.the.same.stru |
24e0 | 63 74 75 72 65 20 74 6f 20 61 63 68 69 65 76 65 20 61 20 72 65 63 6f 67 6e 69 74 69 6f 6e 20 66 | cture.to.achieve.a.recognition.f |
2500 | 61 63 74 6f 72 2e 00 54 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 73 6f 75 72 63 65 20 | actor..The.documentation.source. |
2520 | 69 73 20 6b 65 70 74 20 69 6e 20 74 68 65 20 47 69 74 20 72 65 70 6f 73 69 74 6f 72 79 20 61 74 | is.kept.in.the.Git.repository.at |
2540 | 20 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 | .https://github.com/vyos/vyos-do |
2560 | 63 75 6d 65 6e 74 61 74 69 6f 6e 20 61 6e 64 20 79 6f 75 20 63 61 6e 20 66 6f 6c 6c 6f 77 20 74 | cumentation.and.you.can.follow.t |
2580 | 68 65 20 69 6e 73 74 72 75 63 74 69 6f 6e 73 20 69 6e 20 74 68 65 20 52 45 41 44 4d 45 2e 6d 64 | he.instructions.in.the.README.md |
25a0 | 5f 20 74 6f 20 62 75 69 6c 64 20 61 6e 64 20 74 65 73 74 20 79 6f 75 72 20 63 68 61 6e 67 65 73 | _.to.build.and.test.your.changes |
25c0 | 2e 00 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 69 73 20 61 20 71 75 69 63 6b 20 73 75 6d 6d 61 | ..The.following.is.a.quick.summa |
25e0 | 72 79 20 6f 66 20 74 68 65 20 72 75 6c 65 73 3a 00 54 68 65 20 6d 61 69 6e 20 61 64 76 61 6e 74 | ry.of.the.rules:.The.main.advant |
2600 | 61 67 65 20 6f 66 20 74 68 65 20 46 6f 72 6b 69 6e 67 20 57 6f 72 6b 66 6c 6f 77 20 69 73 20 74 | age.of.the.Forking.Workflow.is.t |
2620 | 68 61 74 20 63 6f 6e 74 72 69 62 75 74 69 6f 6e 73 20 63 61 6e 20 62 65 20 69 6e 74 65 67 72 61 | hat.contributions.can.be.integra |
2640 | 74 65 64 20 77 69 74 68 6f 75 74 20 74 68 65 20 6e 65 65 64 20 66 6f 72 20 65 76 65 72 79 62 6f | ted.without.the.need.for.everybo |
2660 | 64 79 20 74 6f 20 70 75 73 68 20 74 6f 20 61 20 73 69 6e 67 6c 65 20 63 65 6e 74 72 61 6c 20 72 | dy.to.push.to.a.single.central.r |
2680 | 65 70 6f 73 69 74 6f 72 79 2e 20 44 65 76 65 6c 6f 70 65 72 73 20 70 75 73 68 20 74 6f 20 74 68 | epository..Developers.push.to.th |
26a0 | 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 69 65 73 | eir.own.server-side.repositories |
26c0 | 2c 20 61 6e 64 20 6f 6e 6c 79 20 74 68 65 20 70 72 6f 6a 65 63 74 20 6d 61 69 6e 74 61 69 6e 65 | ,.and.only.the.project.maintaine |
26e0 | 72 20 63 61 6e 20 70 75 73 68 20 74 6f 20 74 68 65 20 6f 66 66 69 63 69 61 6c 20 72 65 70 6f 73 | r.can.push.to.the.official.repos |
2700 | 69 74 6f 72 79 2e 20 54 68 69 73 20 61 6c 6c 6f 77 73 20 74 68 65 20 6d 61 69 6e 74 61 69 6e 65 | itory..This.allows.the.maintaine |
2720 | 72 20 74 6f 20 61 63 63 65 70 74 20 63 6f 6d 6d 69 74 73 20 66 72 6f 6d 20 61 6e 79 20 64 65 76 | r.to.accept.commits.from.any.dev |
2740 | 65 6c 6f 70 65 72 20 77 69 74 68 6f 75 74 20 67 69 76 69 6e 67 20 74 68 65 6d 20 77 72 69 74 65 | eloper.without.giving.them.write |
2760 | 20 61 63 63 65 73 73 20 74 6f 20 74 68 65 20 6f 66 66 69 63 69 61 6c 20 63 6f 64 65 62 61 73 65 | .access.to.the.official.codebase |
2780 | 2e 00 54 68 65 20 70 6c 75 67 69 6e 20 77 69 6c 6c 20 77 61 72 6e 20 6f 6e 20 62 75 69 6c 64 20 | ..The.plugin.will.warn.on.build. |
27a0 | 69 66 20 61 20 68 65 61 64 6c 69 6e 65 20 68 61 73 20 61 20 64 75 70 6c 69 63 61 74 65 20 6e 61 | if.a.headline.has.a.duplicate.na |
27c0 | 6d 65 20 69 6e 20 74 68 65 20 73 61 6d 65 20 64 6f 63 75 6d 65 6e 74 2e 20 54 6f 20 70 72 65 76 | me.in.the.same.document..To.prev |
27e0 | 65 6e 74 20 74 68 69 73 20 77 61 72 6e 69 6e 67 2c 20 79 6f 75 20 68 61 76 65 20 74 6f 20 70 75 | ent.this.warning,.you.have.to.pu |
2800 | 74 20 61 20 63 75 73 74 6f 6d 20 6c 69 6e 6b 20 6f 6e 20 74 6f 70 20 6f 66 20 74 68 65 20 68 65 | t.a.custom.link.on.top.of.the.he |
2820 | 61 64 6c 69 6e 65 2e 00 54 68 65 6f 72 65 74 69 63 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 | adline..Theoretical.information. |
2840 | 72 65 71 75 69 72 65 64 20 66 6f 72 20 75 73 65 72 73 20 74 6f 20 75 6e 64 65 72 73 74 61 6e 64 | required.for.users.to.understand |
2860 | 20 74 68 65 20 6e 65 78 74 20 64 6f 63 75 6d 65 6e 74 20 73 65 63 74 69 6f 6e 73 3a 00 54 68 65 | .the.next.document.sections:.The |
2880 | 72 65 20 61 72 65 20 61 20 66 65 77 20 74 68 69 6e 67 73 20 74 6f 20 6b 65 65 70 20 69 6e 20 6d | re.are.a.few.things.to.keep.in.m |
28a0 | 69 6e 64 20 77 68 65 6e 20 63 6f 6e 74 72 69 62 75 74 69 6e 67 20 74 6f 20 74 68 65 20 64 6f 63 | ind.when.contributing.to.the.doc |
28c0 | 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 66 6f 72 20 74 68 65 20 73 61 6b 65 20 6f 66 20 63 6f 6e 73 | umentation,.for.the.sake.of.cons |
28e0 | 69 73 74 65 6e 63 79 20 61 6e 64 20 72 65 61 64 61 62 69 6c 69 74 79 2e 00 54 68 69 73 20 73 65 | istency.and.readability..This.se |
2900 | 63 74 69 6f 6e 20 6d 75 73 74 20 63 6f 6e 74 61 69 6e 20 61 20 6c 69 73 74 20 6f 66 3a 00 54 6f | ction.must.contain.a.list.of:.To |
2920 | 20 65 78 74 72 61 63 74 20 61 20 64 65 66 61 75 6c 74 76 61 6c 75 65 20 66 72 6f 6d 20 74 68 65 | .extract.a.defaultvalue.from.the |
2940 | 20 58 4d 4c 20 64 65 66 69 6e 69 74 69 6f 6e 73 20 61 64 64 20 61 20 60 60 3a 64 65 66 61 75 6c | .XML.definitions.add.a.``:defaul |
2960 | 74 76 61 6c 75 65 3a 60 60 20 74 6f 20 60 60 2e 2e 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 69 72 | tvalue:``.to.``...cfgcmd::``.dir |
2980 | 65 63 74 69 76 65 2e 20 54 6f 20 68 61 76 65 20 74 68 69 73 20 66 65 61 74 75 72 65 20 6c 6f 63 | ective..To.have.this.feature.loc |
29a0 | 61 6c 6c 79 2c 20 74 68 65 20 76 79 6f 73 2d 31 78 20 73 75 62 6d 6f 64 75 6c 65 20 6d 75 73 74 | ally,.the.vyos-1x.submodule.must |
29c0 | 20 62 65 20 69 6e 69 74 69 61 6c 69 7a 65 64 20 62 65 66 6f 72 65 2e 20 50 6c 65 61 73 65 20 62 | .be.initialized.before..Please.b |
29e0 | 65 20 61 77 61 72 65 20 74 6f 20 6e 6f 74 20 75 70 64 61 74 65 20 74 68 65 20 73 75 62 6d 6f 64 | e.aware.to.not.update.the.submod |
2a00 | 75 6c 65 20 69 6e 20 79 6f 75 72 20 50 52 2e 00 54 6f 20 6d 69 6e 69 6d 69 7a 65 20 72 65 64 75 | ule.in.your.PR..To.minimize.redu |
2a20 | 6e 64 61 6e 63 79 2c 20 74 68 65 72 65 20 69 73 20 61 20 73 70 65 63 69 61 6c 20 69 6e 63 6c 75 | ndancy,.there.is.a.special.inclu |
2a40 | 64 65 20 64 69 72 65 63 74 69 76 65 2e 20 49 74 20 69 6e 63 6c 75 64 65 73 20 61 20 74 78 74 20 | de.directive..It.includes.a.txt. |
2a60 | 66 69 6c 65 20 61 6e 64 20 72 65 70 6c 61 63 65 20 74 68 65 20 60 60 7b 7b 20 76 61 72 30 20 7d | file.and.replace.the.``{{.var0.} |
2a80 | 7d 60 60 20 2d 20 60 60 7b 7b 20 76 61 72 39 20 7d 7d 60 60 20 77 69 74 68 20 74 68 65 20 63 6f | }``.-.``{{.var9.}}``.with.the.co |
2aa0 | 72 72 65 63 74 20 76 61 6c 75 65 2e 00 54 72 79 20 6e 6f 74 20 74 6f 20 65 78 63 65 65 64 20 38 | rrect.value..Try.not.to.exceed.8 |
2ac0 | 30 20 63 68 61 72 61 63 74 65 72 73 20 70 65 72 20 6c 69 6e 65 2c 20 62 75 74 20 64 6f 6e 27 74 | 0.characters.per.line,.but.don't |
2ae0 | 20 62 72 65 61 6b 20 55 52 4c 73 20 6f 76 65 72 20 74 68 69 73 2e 00 55 6e 69 63 61 73 74 20 4d | .break.URLs.over.this..Unicast.M |
2b00 | 41 43 20 41 64 64 72 65 73 73 65 73 3a 20 60 60 30 30 2d 35 33 2d 30 30 60 60 20 74 6f 20 60 60 | AC.Addresses:.``00-53-00``.to.`` |
2b20 | 30 30 2d 35 33 2d 46 46 60 60 00 55 70 64 61 74 65 73 20 74 6f 20 6f 75 72 20 64 6f 63 75 6d 65 | 00-53-FF``.Updates.to.our.docume |
2b40 | 6e 74 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20 62 65 20 64 65 6c 69 76 65 72 65 64 20 62 79 20 61 | ntation.should.be.delivered.by.a |
2b60 | 20 47 69 74 48 75 62 20 70 75 6c 6c 2d 72 65 71 75 65 73 74 2e 20 54 68 69 73 20 72 65 71 75 69 | .GitHub.pull-request..This.requi |
2b80 | 72 65 73 20 79 6f 75 20 61 6c 72 65 61 64 79 20 68 61 76 65 20 61 20 47 69 74 48 75 62 20 61 63 | res.you.already.have.a.GitHub.ac |
2ba0 | 63 6f 75 6e 74 2e 00 55 73 65 20 41 6d 65 72 69 63 61 6e 20 45 6e 67 6c 69 73 68 20 61 74 20 61 | count..Use.American.English.at.a |
2bc0 | 6c 6c 20 74 69 6d 65 73 2e 20 49 74 27 73 20 61 6c 77 61 79 73 20 61 20 67 6f 6f 64 20 69 64 65 | ll.times..It's.always.a.good.ide |
2be0 | 61 20 74 6f 20 72 75 6e 20 79 6f 75 72 20 74 65 78 74 20 74 68 72 6f 75 67 68 20 61 20 67 72 61 | a.to.run.your.text.through.a.gra |
2c00 | 6d 6d 61 72 20 61 6e 64 20 73 70 65 6c 6c 20 63 68 65 63 6b 65 72 2c 20 73 75 63 68 20 61 73 20 | mmar.and.spell.checker,.such.as. |
2c20 | 60 47 72 61 6d 6d 61 72 6c 79 60 5f 2e 00 55 73 65 20 6c 69 74 65 72 61 6c 20 62 6c 6f 63 6b 73 | `Grammarly`_..Use.literal.blocks |
2c40 | 20 66 6f 72 20 6c 6f 6e 67 65 72 20 73 6e 69 70 70 65 74 73 2e 00 56 69 65 77 20 6d 6f 64 69 66 | .for.longer.snippets..View.modif |
2c60 | 69 65 64 20 66 69 6c 65 73 20 62 79 20 63 61 6c 6c 69 6e 67 20 60 60 24 20 67 69 74 20 73 74 61 | ied.files.by.calling.``$.git.sta |
2c80 | 74 75 73 60 60 2e 20 59 6f 75 20 77 69 6c 6c 20 67 65 74 20 61 6e 20 6f 76 65 72 76 69 65 77 20 | tus``..You.will.get.an.overview. |
2ca0 | 6f 66 20 61 6c 6c 20 66 69 6c 65 73 20 6d 6f 64 69 66 69 65 64 20 62 79 20 79 6f 75 2e 20 59 6f | of.all.files.modified.by.you..Yo |
2cc0 | 75 20 63 61 6e 20 61 64 64 20 69 6e 64 69 76 69 64 75 61 6c 20 66 69 6c 65 73 20 74 6f 20 74 68 | u.can.add.individual.files.to.th |
2ce0 | 65 20 47 69 74 20 49 6e 64 65 78 20 69 6e 20 74 68 65 20 6e 65 78 74 20 73 74 65 70 2e 00 56 79 | e.Git.Index.in.the.next.step..Vy |
2d00 | 4f 53 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 72 | OS.documentation.is.written.in.r |
2d20 | 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 20 61 6e 64 20 67 65 6e 65 72 61 74 65 64 20 74 6f | eStructuredText.and.generated.to |
2d40 | 20 52 65 61 64 20 74 68 65 20 44 6f 63 73 20 70 61 67 65 73 20 77 69 74 68 20 53 70 68 69 6e 78 | .Read.the.Docs.pages.with.Sphinx |
2d60 | 2c 20 61 73 20 70 65 72 20 74 68 65 20 50 79 74 68 6f 6e 20 74 72 61 64 69 74 69 6f 6e 2c 20 61 | ,.as.per.the.Python.tradition,.a |
2d80 | 73 20 77 65 6c 6c 20 61 73 20 50 44 46 20 66 69 6c 65 73 20 66 6f 72 20 6f 66 66 6c 69 6e 65 20 | s.well.as.PDF.files.for.offline. |
2da0 | 75 73 65 20 74 68 72 6f 75 67 68 20 4c 61 54 65 58 2e 20 57 65 20 77 65 6c 63 6f 6d 65 20 61 6c | use.through.LaTeX..We.welcome.al |
2dc0 | 6c 20 73 6f 72 74 73 20 6f 66 20 63 6f 6e 74 72 69 62 75 74 69 6f 6e 73 20 74 6f 20 74 68 65 20 | l.sorts.of.contributions.to.the. |
2de0 | 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 4e 6f 74 20 6a 75 73 74 20 6e 65 77 20 61 64 64 69 | documentation..Not.just.new.addi |
2e00 | 74 69 6f 6e 73 20 62 75 74 20 61 6c 73 6f 20 63 6f 72 72 65 63 74 69 6f 6e 73 20 74 6f 20 65 78 | tions.but.also.corrections.to.ex |
2e20 | 69 73 74 69 6e 67 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 56 79 4f 53 20 64 6f 63 75 6d | isting.documentation..VyOS.docum |
2e40 | 65 6e 74 61 74 69 6f 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 | entation.is.written.in.reStructu |
2e60 | 72 65 64 54 65 78 74 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 | redText.and.generated.to.Read.th |
2e80 | 65 20 44 6f 63 73 20 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 | e.Docs.pages.with.Sphinx,.as.per |
2ea0 | 20 74 68 65 20 50 79 74 68 6f 6e 20 74 72 61 64 69 74 69 6f 6e 2e 20 57 65 20 77 65 6c 63 6f 6d | .the.Python.tradition..We.welcom |
2ec0 | 65 20 61 6c 6c 20 73 6f 72 74 73 20 6f 66 20 63 6f 6e 74 72 69 62 75 74 69 6f 6e 73 20 74 6f 20 | e.all.sorts.of.contributions.to. |
2ee0 | 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 4e 6f 74 20 6a 75 73 74 20 6e 65 77 20 | the.documentation..Not.just.new. |
2f00 | 61 64 64 69 74 69 6f 6e 73 20 62 75 74 20 61 6c 73 6f 20 63 6f 72 72 65 63 74 69 6f 6e 73 20 74 | additions.but.also.corrections.t |
2f20 | 6f 20 65 78 69 73 74 69 6e 67 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 57 65 20 65 6e 63 | o.existing.documentation..We.enc |
2f40 | 6f 75 72 61 67 65 20 65 76 65 72 79 20 56 79 4f 53 20 75 73 65 72 20 74 6f 20 68 65 6c 70 20 75 | ourage.every.VyOS.user.to.help.u |
2f60 | 73 20 69 6d 70 72 6f 76 65 20 6f 75 72 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 61 73 20 77 | s.improve.our.documentation.as.w |
2f80 | 65 20 68 61 76 65 20 61 20 64 65 66 69 63 69 74 20 6c 69 6b 65 20 6d 6f 73 74 20 73 6f 66 74 77 | e.have.a.deficit.like.most.softw |
2fa0 | 61 72 65 20 70 72 6f 6a 65 63 74 73 2e 20 20 54 68 69 73 20 6e 6f 74 20 6f 6e 6c 79 20 68 65 6c | are.projects...This.not.only.hel |
2fc0 | 70 73 20 79 6f 75 20 77 68 65 6e 20 72 65 61 64 69 6e 67 20 62 75 74 20 61 6c 73 6f 20 65 76 65 | ps.you.when.reading.but.also.eve |
2fe0 | 72 79 6f 6e 65 20 65 6c 73 65 2e 00 57 65 20 75 73 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 | ryone.else..We.use.the.following |
3000 | 20 73 79 6e 74 61 78 20 66 6f 72 20 48 65 61 64 6c 69 6e 65 73 2e 00 57 68 65 6e 20 64 6f 63 75 | .syntax.for.Headlines..When.docu |
3020 | 6d 65 6e 74 69 6e 67 20 43 4c 49 20 63 6f 6d 6d 61 6e 64 73 2c 20 75 73 65 20 74 68 65 20 60 60 | menting.CLI.commands,.use.the.`` |
3040 | 2e 2e 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 69 72 65 63 74 69 76 65 20 66 6f 72 20 61 6c 6c 20 | ...cfgcmd::``.directive.for.all. |
3060 | 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 6f 64 65 20 63 6f 6d 6d 61 6e 64 73 2e 20 41 6e 20 | configuration.mode.commands..An. |
3080 | 65 78 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 64 65 73 63 72 69 62 65 64 20 63 6f 6d | explanation.of.the.described.com |
30a0 | 6d 61 6e 64 20 73 68 6f 75 6c 64 20 62 65 20 61 64 64 65 64 20 62 65 6c 6f 77 20 74 68 69 73 20 | mand.should.be.added.below.this. |
30c0 | 73 74 61 74 65 6d 65 6e 74 2e 20 52 65 70 6c 61 63 65 20 61 6c 6c 20 76 61 72 69 61 62 6c 65 20 | statement..Replace.all.variable. |
30e0 | 63 6f 6e 74 65 6e 74 73 20 77 69 74 68 20 3c 76 61 6c 75 65 3e 20 6f 72 20 73 6f 6d 65 74 68 69 | contents.with.<value>.or.somethi |
3100 | 6e 67 20 73 69 6d 69 6c 61 72 2e 00 57 68 65 6e 20 64 6f 63 75 6d 65 6e 74 69 6e 67 20 6f 70 65 | ng.similar..When.documenting.ope |
3120 | 72 61 74 69 6f 6e 61 6c 20 6c 65 76 65 6c 20 63 6f 6d 6d 61 6e 64 73 2c 20 75 73 65 20 74 68 65 | rational.level.commands,.use.the |
3140 | 20 60 60 2e 2e 20 6f 70 63 6d 64 3a 3a 60 60 20 64 69 72 65 63 74 69 76 65 2e 20 41 6e 20 65 78 | .``...opcmd::``.directive..An.ex |
3160 | 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 64 65 73 63 72 69 62 65 64 20 63 6f 6d 6d 61 | planation.of.the.described.comma |
3180 | 6e 64 20 73 68 6f 75 6c 64 20 62 65 20 61 64 64 65 64 20 62 65 6c 6f 77 20 74 68 69 73 20 73 74 | nd.should.be.added.below.this.st |
31a0 | 61 74 65 6d 65 6e 74 2e 00 57 68 65 6e 20 69 6e 20 64 6f 75 62 74 2c 20 66 6f 6c 6c 6f 77 20 74 | atement..When.in.doubt,.follow.t |
31c0 | 68 65 20 73 74 79 6c 65 20 6f 66 20 65 78 69 73 74 69 6e 67 20 64 6f 63 75 6d 65 6e 74 61 74 69 | he.style.of.existing.documentati |
31e0 | 6f 6e 2e 00 57 68 65 6e 20 72 65 66 65 72 65 6e 63 69 6e 67 20 74 6f 20 56 79 4f 53 20 50 68 61 | on..When.referencing.to.VyOS.Pha |
3200 | 62 72 69 63 61 74 6f 72 20 54 61 73 6b 73 2c 20 74 68 65 72 65 20 69 73 20 61 20 63 75 73 74 6f | bricator.Tasks,.there.is.a.custo |
3220 | 6d 20 53 70 68 69 6e 78 20 4d 61 72 6b 75 70 20 63 6f 6d 6d 61 6e 64 20 63 61 6c 6c 65 64 20 60 | m.Sphinx.Markup.command.called.` |
3240 | 60 76 79 74 61 73 6b 60 60 20 74 68 61 74 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 65 6e | `vytask``.that.automatically.ren |
3260 | 64 65 72 73 20 74 6f 20 61 20 70 72 6f 70 65 72 20 50 68 61 62 72 69 63 61 74 6f 72 20 55 52 4c | ders.to.a.proper.Phabricator.URL |
3280 | 2e 20 54 68 69 73 20 69 73 20 68 65 61 76 69 6c 79 20 75 73 65 64 20 69 6e 20 74 68 65 20 3a 72 | ..This.is.heavily.used.in.the.:r |
32a0 | 65 66 3a 60 72 65 6c 65 61 73 65 2d 6e 6f 74 65 73 60 20 73 65 63 74 69 6f 6e 2e 00 57 69 74 68 | ef:`release-notes`.section..With |
32c0 | 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 20 69 73 20 70 6f | .those.custom.commands,.it.is.po |
32e0 | 73 73 69 62 6c 65 20 74 6f 20 72 65 6e 64 65 72 20 74 68 65 6d 20 69 6e 20 61 20 6d 6f 72 65 20 | ssible.to.render.them.in.a.more. |
3300 | 64 65 73 63 72 69 70 74 69 76 65 20 77 61 79 20 69 6e 20 74 68 65 20 72 65 73 75 6c 74 69 6e 67 | descriptive.way.in.the.resulting |
3320 | 20 48 54 4d 4c 2f 50 44 46 20 6d 61 6e 75 61 6c 2e 00 57 69 74 68 20 74 68 6f 73 65 20 63 75 73 | .HTML/PDF.manual..With.those.cus |
3340 | 74 6f 6d 20 63 6f 6d 6d 61 6e 64 73 2c 20 69 74 20 77 69 6c 6c 20 62 65 20 70 6f 73 73 69 62 6c | tom.commands,.it.will.be.possibl |
3360 | 65 20 74 6f 20 72 65 6e 64 65 72 20 74 68 65 6d 20 69 6e 20 61 20 6d 6f 72 65 20 64 65 73 63 72 | e.to.render.them.in.a.more.descr |
3380 | 69 70 74 69 76 65 20 77 61 79 20 69 6e 20 74 68 65 20 72 65 73 75 6c 74 69 6e 67 20 48 54 4d 4c | iptive.way.in.the.resulting.HTML |
33a0 | 2f 50 44 46 20 6d 61 6e 75 61 6c 2e 00 57 72 69 74 65 20 44 6f 63 75 6d 65 6e 74 61 74 69 6f 6e | /PDF.manual..Write.Documentation |
33c0 | 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 6e 78 20 28 | .You.can.either.install.Sphinx.( |
33e0 | 61 6e 64 20 54 65 58 20 4c 69 76 65 20 66 6f 72 20 50 44 46 20 6f 75 74 70 75 74 29 20 61 6e 64 | and.TeX.Live.for.PDF.output).and |
3400 | 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 6f 63 61 6c 6c 79 | .build.the.documentation.locally |
3420 | 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 6f 20 62 75 69 6c | ,.or.use.the.Dockerfile_.to.buil |
3440 | 64 20 69 74 20 69 6e 20 61 20 63 6f 6e 74 61 69 6e 65 72 2e 00 59 6f 75 20 63 61 6e 20 65 69 74 | d.it.in.a.container..You.can.eit |
3460 | 68 65 72 20 69 6e 73 74 61 6c 6c 20 53 70 68 69 6e 78 20 61 6e 64 20 62 75 69 6c 64 20 74 68 65 | her.install.Sphinx.and.build.the |
3480 | 20 64 6f 63 75 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 | .documentation.locally,.or.use.t |
34a0 | 68 65 20 44 6f 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 | he.Dockerfile_.to.build.it.in.a. |
34c0 | 63 6f 6e 74 61 69 6e 65 72 2e 00 59 6f 75 72 20 72 65 6d 6f 74 65 20 72 65 70 6f 20 6f 6e 20 47 | container..Your.remote.repo.on.G |
34e0 | 69 74 68 75 62 20 69 73 20 63 61 6c 6c 65 64 20 60 60 6f 72 69 67 69 6e 60 60 2c 20 77 68 69 6c | ithub.is.called.``origin``,.whil |
3500 | 65 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 72 65 70 6f 20 79 6f 75 20 68 61 76 65 20 66 6f 72 | e.the.original.repo.you.have.for |
3520 | 6b 65 64 20 69 73 20 63 61 6c 6c 65 64 20 60 60 75 70 73 74 72 65 61 6d 60 60 2e 20 4e 6f 77 20 | ked.is.called.``upstream``..Now. |
3540 | 79 6f 75 20 63 61 6e 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 | you.can.locally.update.your.fork |
3560 | 65 64 20 72 65 70 6f 2e 00 60 60 31 39 32 2e 30 2e 32 2e 30 2f 32 34 60 60 00 60 60 31 39 38 2e | ed.repo..``192.0.2.0/24``.``198. |
3580 | 35 31 2e 31 30 30 2e 30 2f 32 34 60 60 00 60 60 32 30 30 31 3a 64 62 38 3a 3a 2f 33 32 60 60 00 | 51.100.0/24``.``2001:db8::/32``. |
35a0 | 60 60 32 30 33 2e 30 2e 31 31 33 2e 30 2f 32 34 60 60 00 60 60 3a 72 65 66 3a 60 43 68 65 63 6b | ``203.0.113.0/24``.``:ref:`Check |
35c0 | 20 6f 75 74 20 56 4c 41 4e 3c 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2f 69 6e 74 65 72 66 61 63 | .out.VLAN<configuration/interfac |
35e0 | 65 73 2f 65 74 68 65 72 6e 65 74 3a 76 6c 61 6e 3e 60 60 00 60 60 3a 72 65 66 3a 60 63 6f 6e 66 | es/ethernet:vlan>``.``:ref:`conf |
3600 | 69 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 | iguration/interfaces/ethernet:vl |
3620 | 61 6e 60 60 00 60 60 73 65 74 20 66 69 72 65 77 61 6c 6c 20 7a 6f 6e 65 60 60 20 69 73 20 77 72 | an``.``set.firewall.zone``.is.wr |
3640 | 69 74 74 65 6e 20 69 6e 20 60 60 66 69 72 65 77 61 6c 6c 2f 7a 6f 6e 65 2e 72 73 74 60 60 00 60 | itten.in.``firewall/zone.rst``.` |
3660 | 60 73 65 74 20 69 6e 74 65 72 66 61 63 65 73 20 65 74 68 65 72 6e 65 74 60 60 20 69 73 20 77 72 | `set.interfaces.ethernet``.is.wr |
3680 | 69 74 74 65 6e 20 69 6e 20 60 60 69 6e 74 65 72 66 61 63 65 73 2f 65 74 68 65 72 6e 65 74 2e 72 | itten.in.``interfaces/ethernet.r |
36a0 | 73 74 60 60 00 61 20 73 69 6d 70 6c 65 20 65 78 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 77 68 61 | st``.a.simple.explanation.of.wha |
36c0 | 74 20 69 73 20 74 68 69 73 20 70 61 67 65 20 61 62 6f 75 74 2c 20 77 68 79 20 6f 72 20 77 68 65 | t.is.this.page.about,.why.or.whe |
36e0 | 6e 20 69 74 20 69 73 20 72 65 71 75 69 72 65 64 20 74 6f 20 62 65 20 75 73 65 64 00 63 66 67 63 | n.it.is.required.to.be.used.cfgc |
3700 | 6d 64 00 63 6d 64 69 6e 63 6c 75 64 65 00 68 61 6e 64 6c 65 20 62 75 69 6c 64 20 65 72 72 6f 72 | md.cmdinclude.handle.build.error |
3720 | 73 00 68 6f 77 20 74 6f 20 63 6f 6c 6c 65 63 74 20 6c 6f 67 73 20 6f 72 20 6f 74 68 65 72 20 64 | s.how.to.collect.logs.or.other.d |
3740 | 65 62 75 67 67 69 6e 67 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 28 6c 69 6b 65 20 60 73 68 6f 77 | ebugging.information.(like.`show |
3760 | 60 20 63 6f 6d 6d 61 6e 64 73 20 6f 75 74 70 75 74 29 00 68 6f 77 20 74 6f 20 72 65 61 64 20 61 | `.commands.output).how.to.read.a |
3780 | 6e 64 20 77 68 61 74 20 74 6f 20 73 65 61 72 63 68 20 66 6f 72 20 69 6e 20 6c 6f 67 73 20 61 6e | nd.what.to.search.for.in.logs.an |
37a0 | 64 20 63 6f 6c 6c 65 63 74 65 64 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 00 6b 6e 6f 77 6e 20 69 73 | d.collected.information.known.is |
37c0 | 73 75 65 73 20 6f 72 20 70 6f 74 65 6e 74 69 61 6c 20 70 72 6f 62 6c 65 6d 73 20 66 6f 72 20 74 | sues.or.potential.problems.for.t |
37e0 | 68 65 20 73 65 72 76 69 63 65 20 6f 72 20 75 73 65 20 63 61 73 65 00 6f 70 63 6d 64 00 72 65 66 | he.service.or.use.case.opcmd.ref |
3800 | 65 72 65 6e 63 65 73 20 74 6f 20 73 74 61 6e 64 61 72 64 73 2c 20 52 46 43 73 00 74 68 65 20 63 | erences.to.standards,.RFCs.the.c |
3820 | 6f 6e 74 65 6e 74 20 6f 66 20 69 6e 74 65 72 66 61 63 65 2d 61 64 64 72 65 73 73 2e 74 78 74 20 | ontent.of.interface-address.txt. |
3840 | 6c 6f 6f 6b 73 20 6c 69 6b 65 20 74 68 69 73 00 74 6f 20 75 73 65 20 61 6e 20 61 6c 74 65 72 6e | looks.like.this.to.use.an.altern |
3860 | 61 74 69 76 65 20 68 79 70 65 72 6c 69 6e 6b 20 75 73 65 20 69 74 20 74 68 69 73 20 77 61 79 3a | ative.hyperlink.use.it.this.way: |
3880 | 00 76 79 74 61 73 6b 00 77 68 61 74 20 61 72 65 20 69 6e 64 69 63 61 74 6f 72 73 20 6f 66 20 67 | .vytask.what.are.indicators.of.g |
38a0 | 6f 6f 64 20 61 6e 64 20 62 61 64 20 73 74 61 74 65 73 20 69 6e 20 64 65 62 75 67 67 69 6e 67 20 | ood.and.bad.states.in.debugging. |
38c0 | 6f 75 74 70 75 74 73 00 77 6f 72 6b 61 72 6f 75 6e 64 73 20 66 6f 72 20 6b 6e 6f 77 6e 20 69 73 | outputs.workarounds.for.known.is |
38e0 | 73 75 65 73 20 28 69 66 20 61 6e 79 20 65 78 69 73 74 29 00 4d 49 4d 45 2d 56 65 72 73 69 6f 6e | sues.(if.any.exist).MIME-Version |
3900 | 3a 20 31 2e 30 0a 43 6f 6e 74 65 6e 74 2d 54 79 70 65 3a 20 74 65 78 74 2f 70 6c 61 69 6e 3b 20 | :.1.0.Content-Type:.text/plain;. |
3920 | 63 68 61 72 73 65 74 3d 55 54 46 2d 38 0a 43 6f 6e 74 65 6e 74 2d 54 72 61 6e 73 66 65 72 2d 45 | charset=UTF-8.Content-Transfer-E |
3940 | 6e 63 6f 64 69 6e 67 3a 20 38 62 69 74 0a 58 2d 47 65 6e 65 72 61 74 6f 72 3a 20 4c 6f 63 61 6c | ncoding:.8bit.X-Generator:.Local |
3960 | 61 7a 79 20 28 68 74 74 70 73 3a 2f 2f 6c 6f 63 61 6c 61 7a 79 2e 63 6f 6d 29 0a 50 72 6f 6a 65 | azy.(https://localazy.com).Proje |
3980 | 63 74 2d 49 64 2d 56 65 72 73 69 6f 6e 3a 20 0a 4c 61 6e 67 75 61 67 65 3a 20 6a 61 0a 50 6c 75 | ct-Id-Version:..Language:.ja.Plu |
39a0 | 72 61 6c 2d 46 6f 72 6d 73 3a 20 6e 70 6c 75 72 61 6c 73 3d 31 3b 20 70 6c 75 72 61 6c 3d 30 3b | ral-Forms:.nplurals=1;.plural=0; |
39c0 | 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 6f 6e 00 31 36 62 | ..1..Theoretical.information.16b |
39e0 | 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 32 2e 20 43 6f 6e | it.ASN:.``64496.-.64511``.2..Con |
3a00 | 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 43 6f 6e 66 69 67 | figuration.description.3..Config |
3a20 | 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 3a 20 60 60 36 35 | uration.examples.32bit.ASN:.``65 |
3a40 | 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 75 65 73 00 35 2e | 536.-.65551``.4..Known.issues.5. |
3a60 | 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 65 20 75 73 65 64 | .Debugging.A.plugin.will.be.used |
3a80 | 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 61 62 65 6c 20 66 | .to.generate.a.reference.label.f |
3aa0 | 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 65 6e 63 65 20 61 | or.each.headline..To.reference.a |
3ac0 | 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 64 6f 63 75 6d 65 | .page.or.a.section.in.the.docume |
3ae0 | 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 63 6f 6d 6d 61 6e | ntation.use.the.``:ref:``.comman |
3b00 | 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 69 74 20 69 6e 64 | d..Add.modified.files.to.Git.ind |
3b20 | 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 65 6e 61 6d 65 60 | ex.``$.git.add.path/to/filename` |
3b40 | 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 73 20 60 60 24 20 | `.or.add.all.unstaged.files.``$. |
3b60 | 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 65 64 20 74 6f 20 | git.add..``..All.files.added.to. |
3b80 | 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 20 6f 66 20 79 6f | the.Git.index.will.be.part.of.yo |
3ba0 | 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 64 72 65 73 73 20 | u.following.Git.commit..Address. |
3bc0 | 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 6f 6c 6c 6f 77 20 | space.All.RST.files.must.follow. |
3be0 | 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 61 6e 64 20 68 61 | the.same.TOC.Level.syntax.and.ha |
3c00 | 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 61 6c 20 73 65 63 | ve.to.start.with.An.optional.sec |
3c20 | 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 73 20 68 61 76 65 | tion.follows..Some.commands.have |
3c40 | 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 62 6c 65 20 68 61 | .requirements.like.compatible.ha |
3c60 | 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 20 63 6f 6d 6d 61 | rdware.(e.g..Wifi).or.some.comma |
3c80 | 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 2e 20 46 6f 72 20 | nds.you.have.to.set.before..For. |
3ca0 | 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 20 74 6f 20 73 65 | example,.it.is.recommended.to.se |
3cc0 | 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 67 75 72 69 6e 67 | t.a.route-map.before.configuring |
3ce0 | 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 72 20 74 68 61 74 | .BGP..And.finally,.remember.that |
3d00 | 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 73 20 61 72 65 6e | .the.reStructuredText.files.aren |
3d20 | 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 69 6e 67 20 48 54 | 't.exclusively.for.generating.HT |
3d40 | 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 20 68 75 6d 61 6e | ML.and.PDF..They.should.be.human |
3d60 | 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 65 64 20 66 72 6f | -readable.and.easily.perused.fro |
3d80 | 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 00 41 6e 79 74 68 | m.a.console..Anything.else.Anyth |
3da0 | 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 66 69 67 75 72 61 | ing.else.that.is.not.a.configura |
3dc0 | 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 6e 64 20 68 61 73 | tion.or.an.operation.command.has |
3de0 | 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 41 75 74 6f 6c 69 | .no.predefined.structure..Autoli |
3e00 | 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 20 6c 6f 63 61 6c | nter.Check.your.changes.by.local |
3e20 | 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 69 6f 6e 20 60 60 | ly.building.the.documentation.`` |
3e40 | 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 77 69 6c 6c 20 62 | $.make.livehtml``..Sphinx.will.b |
3e60 | 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 20 60 60 64 6f 63 | uild.the.html.files.in.the.``doc |
3e80 | 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 69 64 65 20 79 6f | s/_build``.folder..We.provide.yo |
3ea0 | 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 66 6f 72 20 61 6e | u.with.a.Docker.container.for.an |
3ec0 | 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 63 65 2e 20 43 68 | .easy-to-use.user.experience..Ch |
3ee0 | 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 20 74 68 69 73 20 | eck.the.README.md_.file.of.this. |
3f00 | 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 66 69 67 75 72 65 | repository..Check.your.configure |
3f20 | 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 6e 65 20 66 6f 72 | d.remote.repositories:.Clone.for |
3f40 | 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 68 61 6e 67 65 20 | k.to.local.machine,.then.change. |
3f60 | 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 79 6f 73 2d 64 6f | to.that.directory.``$.cd.vyos-do |
3f80 | 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 63 68 61 6e 67 65 | cumentation``.Commit.your.change |
3fa0 | 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 74 20 63 6f 6d 6d | s.with.the.message,.``$.git.comm |
3fc0 | 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 20 6f 72 20 20 75 | it.-m."<commit.message>"``.or..u |
3fe0 | 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 68 61 76 65 20 79 | se.``$.git.commit.-v``.to.have.y |
4000 | 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 63 68 65 64 2e 20 | our.configured.editor.launched.. |
4020 | 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 65 73 73 61 67 65 | You.can.type.in.a.commit.message |
4040 | 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 6c 66 20 63 6f 6d | ..Again.please.make.yourself.com |
4060 | 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 65 66 3a 60 70 72 | fortable.without.rules.(:ref:`pr |
4080 | 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 69 6f 6e 20 6d 6f | epare_commit`)..Configuration.mo |
40a0 | 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 63 68 20 66 6f 72 | de.pages.Create.a.new.branch.for |
40c0 | 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 69 76 65 20 6e 61 | .your.work,.use.a.descriptive.na |
40e0 | 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 68 65 63 6b 6f 75 | me.of.your.work:.``$.git.checkou |
4100 | 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 2d 52 65 66 65 72 | t.-b.<branch-name>``.Cross-Refer |
4120 | 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 72 6b 75 70 00 43 | ences.Custom.Sphinx-doc.Markup.C |
4140 | 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 65 76 65 6c 6f 70 | ustom.commands.have.been.develop |
4160 | 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 74 61 74 69 6f 6e | ed.for.writing.the.documentation |
4180 | 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 66 6f 72 74 61 62 | ..Please.make.yourself.comfortab |
41a0 | 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 74 68 69 73 20 65 | le.with.those.commands.as.this.e |
41c0 | 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 20 64 6f 63 75 6d | ases.the.way.we.render.the.docum |
41e0 | 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 6d 73 20 72 65 6c | entation..Describe.CLI.items.rel |
4200 | 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 20 63 61 73 65 2e | ated.to.the.service.or.use.case. |
4220 | 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 6f 6e 20 6d 75 73 | .Each.config.line.or.section.mus |
4240 | 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 72 6d 61 74 69 6f | t.be.explained,.using.informatio |
4260 | 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 20 6f 66 20 74 68 | n.provided.in.the.1st.part.of.th |
4280 | 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 65 73 20 66 6f 72 | e.page..Described.procedures.for |
42a0 | 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 74 20 66 6f 72 67 | .debugging.a.service:.Don't.forg |
42c0 | 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 20 77 68 65 6e 20 | et.to.update.``index.rst``.when. |
42e0 | 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 74 48 75 62 20 70 | adding.a.new.node..Each.GitHub.p |
4300 | 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 6c 79 20 6c 69 6e | ull.request.is.automatically.lin |
4320 | 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 70 61 63 65 20 61 | ted.to.check.the.address.space.a |
4340 | 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 6d 75 73 74 20 63 | nd.line.length..Each.page.must.c |
4360 | 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 3a 00 45 78 63 65 | ontain.the.following.parts:.Exce |
4380 | 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 62 65 63 61 75 73 | pt.in.``...code-block::``.becaus |
43a0 | 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 70 72 65 3e 60 60 | e.it.uses.the.html.tag.``<pre>`` |
43c0 | 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 20 66 6f 72 6d 61 | .and.renders.the.same.line.forma |
43e0 | 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 2e 00 46 6f 72 20 | t.from.the.source.rst.file..For. |
4400 | 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 76 65 6c 20 63 6f | an.inline.configuration.level.co |
4420 | 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 72 20 61 6e 20 69 | mmand,.use.``:cfgcmd:``.For.an.i |
4440 | 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 6d 6d 61 6e 64 2c | nline.operational.level.command, |
4460 | 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 6c 65 2c 20 79 6f | .use.``:opcmd:``.For.example,.yo |
4480 | 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 61 64 6c 69 6e 65 | u.want.to.reference.the.headline |
44a0 | 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 74 2e 72 73 74 2a | .**VLAN**.in.the.**ethernet.rst* |
44c0 | 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 65 73 20 74 68 65 | *.page..The.plugin.generates.the |
44e0 | 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 6e 65 20 61 6e 64 | .label.based.on.the.headline.and |
4500 | 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 65 3a 00 46 6f 72 | .the.file.path..For.example:.For |
4520 | 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 74 74 70 73 3a 2f | k.this.project.on.GitHub.https:/ |
4540 | 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 6d 65 6e 74 61 74 | /github.com/vyos/vyos-documentat |
4560 | 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 46 6f 72 6d 61 74 | ion/fork.Forking.Workflow.Format |
4580 | 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 74 74 69 6e 67 20 | ing.and.Sphinxmarkup.Formatting. |
45a0 | 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 6f 6e 63 65 70 74 | and.Sphinxmarkup.General.concept |
45c0 | 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 64 65 74 61 69 6c | s.for.troubleshooting.and.detail |
45e0 | 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 6c 6f 6e 67 20 68 | ed.process.descriptions.belong.h |
4600 | 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 6f 6d 65 20 74 72 | ere..Guidelines.If.there.some.tr |
4620 | 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 65 64 20 74 6f 20 | oubleshooting.guides.related.to. |
4640 | 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 6e 20 74 68 65 20 | the.commands..Explain.it.in.the. |
4660 | 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 20 61 6c 73 6f 20 | next.optional.part..If.you.also. |
4680 | 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 6e 20 47 69 74 48 | want.to.update.your.fork.on.GitH |
46a0 | 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 20 67 69 74 20 70 | ub,.use.the.following:.``$.git.p |
46c0 | 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 75 20 61 72 65 20 77 | ush.origin.master``.If.you.are.w |
46e0 | 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 75 72 20 64 6f 63 75 | illing.to.contribute.to.our.docu |
4700 | 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 69 6e 69 74 65 20 67 | mentation.this.is.the.definite.g |
4720 | 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 74 72 61 73 74 20 74 | uide.how.to.do.so..In.contrast.t |
4740 | 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 2c 20 74 68 65 72 65 | o.submitting.code.patches,.there |
4760 | 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 6f 75 20 6f 70 65 6e | .is.no.requirement.that.you.open |
4780 | 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 72 69 6f 72 20 74 6f | .up.a.Phabricator_.task.prior.to |
47a0 | 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 74 20 74 6f 20 74 68 | .submitting.a.Pull-Request.to.th |
47c0 | 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 6f 6e 66 69 67 75 72 | e.documentation..In.the.configur |
47e0 | 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 6c 6c 20 70 6f 73 73 | ation.part.of.the.page,.all.poss |
4800 | 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 73 20 73 68 6f 75 6c | ible.configuration.options.shoul |
4820 | 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 20 63 66 67 63 6d 64 | d.be.documented..Use.``...cfgcmd |
4840 | 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 65 6e 74 20 77 69 74 | ::``.described.above..Indent.wit |
4860 | 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 20 72 65 71 75 69 72 | h.two.spaces..Install.the.requir |
4880 | 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 20 72 65 71 75 69 72 | ements.``$.pip.install.-r.requir |
48a0 | 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 67 20 73 69 6d 69 6c | ements.txt``.(or.something.simil |
48c0 | 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 65 20 61 6e 64 20 61 | ar).Leave.a.newline.before.and.a |
48e0 | 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 6c 69 6e 65 73 20 74 | fter.a.header..Limit.all.lines.t |
4900 | 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 65 72 73 2e 00 4c 69 | o.a.maximum.of.80.characters..Li |
4920 | 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 68 61 6e 67 65 73 20 | ne.length.Make.all.your.changes. |
4940 | 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 72 75 6c 65 73 20 69 | -.please.keep.our.commit.rules.i |
4960 | 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 6d 69 74 60 29 2e 20 | n.mind.(:ref:`prepare_commit`).. |
4980 | 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 6f 70 65 72 20 63 6f | This.mainly.applies.to.proper.co |
49a0 | 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 79 6f 75 72 20 63 68 | mmit.messages.describing.your.ch |
49c0 | 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 65 20 63 68 65 63 6b | ange.(how.and.why)..Please.check |
49e0 | 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 20 53 70 68 69 6e 78 | .out.the.documentation.of.Sphinx |
4a00 | 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 5f 20 69 66 20 79 6f | -doc_.or.reStructuredText_.if.yo |
4a20 | 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 74 2e 20 54 68 69 73 | u.are.not.familiar.with.it..This |
4a40 | 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 64 6f 63 73 2e 20 41 | .is.used.for.writing.our.docs..A |
4a60 | 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 74 6f 20 77 72 69 74 | dditional.directives.how.to.writ |
4a80 | 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 66 72 6f 6d 20 72 65 | e.in.RST.can.be.obtained.from.re |
4aa0 | 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 2e 00 4d 75 6c 74 69 | StructuredTextDirectives_..Multi |
4ac0 | 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 31 30 2d 30 30 60 60 | cast.MAC-Addresses:.``90-10-00`` |
4ae0 | 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 20 66 6f 6c 6c 6f 77 | .to.``90-10-FF``.Note.the.follow |
4b00 | 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 66 63 3a 60 33 38 34 | ing.RFCs.(:rfc:`5737`,.:rfc:`384 |
4b20 | 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 60 37 30 34 32 60 29 | 9`,.:rfc:`5389`.and.:rfc:`7042`) |
4b40 | 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 72 76 65 64 20 70 75 | ,.which.describe.the.reserved.pu |
4b60 | 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 6f 6e 6f 6d 6f 75 73 | blic.IP.addresses.and.autonomous |
4b80 | 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 6f 63 75 6d 65 6e 74 | .system.numbers.for.the.document |
4ba0 | 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 20 68 61 76 65 20 62 | ation:.Once.pull.requests.have.b |
4bc0 | 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 74 20 74 6f 20 6c 6f | een.approved,.you.may.want.to.lo |
4be0 | 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 72 65 70 6f 73 69 74 | cally.update.your.forked.reposit |
4c00 | 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 65 20 74 6f 20 61 64 | ory.too..First.you'll.have.to.ad |
4c20 | 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 60 75 70 73 74 72 65 | d.a.second.remote.called.`upstre |
4c40 | 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 61 69 6e 20 72 65 70 | am`.which.points.to.our.main.rep |
4c60 | 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 64 64 20 75 70 73 74 | ository..``$.git.remote.add.upst |
4c80 | 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 79 6f 73 2f 76 79 6f | ream.https://github.com/vyos/vyo |
4ca0 | 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 72 61 74 69 6f 6e 20 | s-documentation.git``.Operation. |
4cc0 | 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 20 66 69 74 20 69 6e | mode.commands.that.do.not.fit.in |
4ce0 | 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 6d 6f 64 65 20 63 6f | .a.related.configuration.mode.co |
4d00 | 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 69 6e 20 74 68 69 73 | mmand.must.be.documented.in.this |
4d20 | 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 6e 2e 00 4f 70 65 72 | .part.of.the.documentation..Oper |
4d40 | 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 74 65 6e 74 00 50 6c | ation.mode.pages.Page.content.Pl |
4d60 | 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 6c 69 63 20 61 64 64 | ease.do.not.use.other.public.add |
4d80 | 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 6d 70 6c 65 73 20 6f | ress.space..Practical.examples.o |
4da0 | 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 20 63 6f 6e 66 69 67 | f.the.service.or.use.case.config |
4dc0 | 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 6e 20 74 6f 70 6f 6c | uration..They.must.contain.topol |
4de0 | 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 61 6e 64 20 73 68 6f | ogy.maps.(if.applicable).and.sho |
4e00 | 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 20 71 75 6f 74 65 20 | rt.descriptions..Properly.quote. |
4e20 | 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 72 69 65 66 20 63 6f | commands,.filenames.and.brief.co |
4e40 | 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 61 63 6b 74 69 63 6b | de.snippets.with.double.backtick |
4e60 | 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 69 74 48 75 62 20 70 | s..Push.commits.to.your.GitHub.p |
4e80 | 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 72 69 67 69 6e 20 3c | roject:.``$.git.push.-u.origin.< |
4ea0 | 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 65 72 61 74 69 6f 6e | branch-name>``.Related.operation |
4ec0 | 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 69 6e 20 74 | .command.must.be.documented.in.t |
4ee0 | 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 6c 65 2e 20 55 73 65 | he.next.part.of.the.article..Use |
4f00 | 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 63 6f 6d 6d 61 6e 64 | .``::opcmd..``.for.these.command |
4f20 | 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 61 72 79 20 74 6f 20 | s..Sometimes.it.is.necessary.to. |
4f40 | 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 20 6c 69 6b 65 20 69 | provide.real.IP.addresses.like.i |
4f60 | 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 72 20 74 68 69 73 2c | n.the.:ref:`examples`..For.this, |
4f80 | 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 6d 6d 65 6e 74 20 73 | .please.use.the.sphinx.comment.s |
4fa0 | 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 72 60 60 20 74 6f 20 | yntax.``...stop_vyoslinter``.to. |
4fc0 | 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 73 74 61 72 74 5f 76 | stop.the.linter.and.``...start_v |
4fe0 | 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 6c 65 20 47 75 69 64 | yoslinter``.to.start..Style.Guid |
5000 | 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 20 47 69 74 48 75 62 | e.Submit.pull-request..In.GitHub |
5020 | 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 79 20 61 6e 64 20 79 | .visit.the.main.repository.and.y |
5040 | 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 67 67 65 73 74 69 6e | ou.should.see.a.banner.suggestin |
5060 | 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 20 46 69 6c 6c 20 6f | g.to.make.a.pull.request..Fill.o |
5080 | 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 77 68 61 74 20 79 6f | ut.the.form.and.describe.what.yo |
50a0 | 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 6f 6b 20 61 74 20 74 | u.do..TOC.Level.Take.a.look.at.t |
50c0 | 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 70 61 67 65 20 66 6f | he.:doc:`/documentation`.page.fo |
50e0 | 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 6e 20 6f 66 20 74 68 | r.an.intricate.explanation.of.th |
5100 | 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 54 68 65 20 46 6f 72 | e.documentation.process..The.For |
5120 | 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 74 61 6c 6c 79 20 64 | king.Workflow.is.fundamentally.d |
5140 | 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 61 72 20 47 69 74 20 | ifferent.from.other.popular.Git. |
5160 | 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 6e 67 20 61 20 73 69 | workflows..Instead.of.using.a.si |
5180 | 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 72 79 20 74 6f 20 61 | ngle.server-side.repository.to.a |
51a0 | 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 61 73 65 2c 20 69 74 | ct.as.the."central".codebase,.it |
51c0 | 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 65 69 72 20 6f 77 6e | .gives.every.developer.their.own |
51e0 | 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 54 68 69 73 20 6d 65 | .server-side.repository..This.me |
5200 | 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 20 68 61 73 20 6e 6f | ans.that.each.contributor.has.no |
5220 | 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 74 6f 72 69 65 73 3a | t.one,.but.two.Git.repositories: |
5240 | 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 61 20 70 75 62 6c 69 | .a.private.local.one.and.a.publi |
5260 | 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 74 69 63 6c 65 20 73 | c.server-side.one..The.article.s |
5280 | 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 75 63 74 69 6f 6e 20 | tarts.with.a.short.introduction. |
52a0 | 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 74 65 63 68 6e 6f 6c | about.the.command.or.the.technol |
52c0 | 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 68 65 6c 70 66 75 6c | ogy..Please.include.some.helpful |
52e0 | 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 72 6d 61 74 69 6f 6e | .links.or.background.information |
5300 | 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 66 6f 6c 64 65 72 20 | ..The.configuration.mode.folder. |
5320 | 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 65 20 73 70 65 63 69 | and.the.articles.cover.the.speci |
5340 | 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 2e 20 54 68 65 20 65 | fic.level.of.the.commands..The.e |
5360 | 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 20 63 6f 6d 6d 61 6e | xact.level.depends.on.the.comman |
5380 | 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 61 62 69 6c 69 74 79 | d..This.should.provide.stability |
53a0 | 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 75 6d 20 6f 72 20 62 | .for.URLs.used.in.the.forum.or.b |
53c0 | 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 6e 20 68 61 73 20 33 | logpost..The.documentation.has.3 |
53e0 | 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 2e 20 54 68 65 20 73 | .different.types.of.pages..The.s |
5400 | 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 76 65 20 74 68 65 20 | ame.kind.of.pages.must.have.the. |
5420 | 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 20 61 20 72 65 63 6f | same.structure.to.achieve.a.reco |
5440 | 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 65 6e 74 61 74 69 6f | gnition.factor..The.documentatio |
5460 | 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 69 74 20 72 65 70 6f | n.source.is.kept.in.the.Git.repo |
5480 | 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 63 6f 6d 2f 76 79 6f | sitory.at.https://github.com/vyo |
54a0 | 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 79 6f 75 20 63 61 6e | s/vyos-documentation.and.you.can |
54c0 | 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 69 6e 20 74 68 65 20 | .follow.the.instructions.in.the. |
54e0 | 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 65 73 74 20 79 6f 75 | README.md_.to.build.and.test.you |
5500 | 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 69 73 20 61 20 71 75 | r.changes..The.following.is.a.qu |
5520 | 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 00 54 68 65 20 6d 61 | ick.summary.of.the.rules:.The.ma |
5540 | 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 6e 67 20 57 6f 72 6b | in.advantage.of.the.Forking.Work |
5560 | 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 73 20 63 61 6e 20 62 | flow.is.that.contributions.can.b |
5580 | 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 6e 65 65 64 20 66 6f | e.integrated.without.the.need.fo |
55a0 | 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 73 69 6e 67 6c 65 20 | r.everybody.to.push.to.a.single. |
55c0 | 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 6f 70 65 72 73 20 70 | central.repository..Developers.p |
55e0 | 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 69 64 65 20 72 65 70 | ush.to.their.own.server-side.rep |
5600 | 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 72 6f 6a 65 63 74 20 | ositories,.and.only.the.project. |
5620 | 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 65 20 6f 66 66 69 63 | maintainer.can.push.to.the.offic |
5640 | 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 77 73 20 74 68 65 20 | ial.repository..This.allows.the. |
5660 | 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 69 74 73 20 66 72 6f | maintainer.to.accept.commits.fro |
5680 | 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 69 76 69 6e 67 20 74 | m.any.developer.without.giving.t |
56a0 | 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 66 66 69 63 69 61 6c | hem.write.access.to.the.official |
56c0 | 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 6c 20 77 61 72 6e 20 | .codebase..The.plugin.will.warn. |
56e0 | 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 73 20 61 20 64 75 70 | on.build.if.a.headline.has.a.dup |
5700 | 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 6f 63 75 6d 65 6e 74 | licate.name.in.the.same.document |
5720 | 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 2c 20 79 6f 75 20 68 | ..To.prevent.this.warning,.you.h |
5740 | 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 6f 6e 20 74 6f 70 20 | ave.to.put.a.custom.link.on.top. |
5760 | 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 63 61 6c 20 69 6e 66 | of.the.headline..Theoretical.inf |
5780 | 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 72 73 20 74 6f 20 75 | ormation.required.for.users.to.u |
57a0 | 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 6e 74 20 73 65 63 74 | nderstand.the.next.document.sect |
57c0 | 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 6e 67 73 20 74 6f 20 | ions:.There.are.a.few.things.to. |
57e0 | 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 75 74 69 6e 67 20 74 | keep.in.mind.when.contributing.t |
5800 | 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 74 68 65 20 73 61 6b | o.the.documentation,.for.the.sak |
5820 | 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 61 62 69 6c 69 74 79 | e.of.consistency.and.readability |
5840 | 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 69 6e 20 61 20 6c 69 | ..This.section.must.contain.a.li |
5860 | 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 6c 74 76 61 6c 75 65 | st.of:.To.extract.a.defaultvalue |
5880 | 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 20 61 64 64 20 61 20 | .from.the.XML.definitions.add.a. |
58a0 | 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 2e 20 63 66 67 63 6d | ``:defaultvalue:``.to.``...cfgcm |
58c0 | 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 74 68 69 73 20 66 65 | d::``.directive..To.have.this.fe |
58e0 | 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 78 20 73 75 62 6d 6f | ature.locally,.the.vyos-1x.submo |
5900 | 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 62 65 66 6f 72 65 2e | dule.must.be.initialized.before. |
5920 | 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 70 64 61 74 65 20 74 | .Please.be.aware.to.not.update.t |
5940 | 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 54 6f 20 6d 69 6e 69 | he.submodule.in.your.PR..To.mini |
5960 | 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 20 61 20 73 70 65 63 | mize.redundancy,.there.is.a.spec |
5980 | 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 20 69 6e 63 6c 75 64 | ial.include.directive..It.includ |
59a0 | 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 20 74 68 65 20 60 60 | es.a.txt.file.and.replace.the.`` |
59c0 | 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 7d 7d 60 60 20 77 69 | {{.var0.}}``.-.``{{.var9.}}``.wi |
59e0 | 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 20 6e 6f 74 20 74 6f | th.the.correct.value..Try.not.to |
5a00 | 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 20 6c 69 6e 65 2c 20 | .exceed.80.characters.per.line,. |
5a20 | 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 20 74 68 69 73 2e 00 | but.don't.break.URLs.over.this.. |
5a40 | 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 30 30 2d 35 33 2d 30 | Unicast.MAC.Addresses:.``00-53-0 |
5a60 | 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 65 73 20 74 6f 20 6f | 0``.to.``00-53-FF``.Updates.to.o |
5a80 | 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 65 20 64 65 6c 69 76 | ur.documentation.should.be.deliv |
5aa0 | 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 75 65 73 74 2e 20 54 | ered.by.a.GitHub.pull-request..T |
5ac0 | 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 68 61 76 65 20 61 20 | his.requires.you.already.have.a. |
5ae0 | 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 63 61 6e 20 45 6e 67 | GitHub.account..Use.American.Eng |
5b00 | 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 6c 77 61 79 73 20 61 | lish.at.all.times..It's.always.a |
5b20 | 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 78 74 20 74 68 72 6f | .good.idea.to.run.your.text.thro |
5b40 | 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 68 65 63 6b 65 72 2c | ugh.a.grammar.and.spell.checker, |
5b60 | 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 65 20 6c 69 74 65 72 | .such.as.`Grammarly`_..Use.liter |
5b80 | 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 70 65 74 73 2e 00 56 | al.blocks.for.longer.snippets..V |
5ba0 | 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 6c 69 6e 67 20 60 60 | iew.modified.files.by.calling.`` |
5bc0 | 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 67 65 74 20 61 6e 20 | $.git.status``..You.will.get.an. |
5be0 | 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 69 66 69 65 64 20 62 | overview.of.all.files.modified.b |
5c00 | 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 64 75 61 6c 20 66 69 | y.you..You.can.add.individual.fi |
5c20 | 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 68 65 20 6e 65 78 74 | les.to.the.Git.Index.in.the.next |
5c40 | 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 20 69 73 20 77 72 69 | .step..VyOS.documentation.is.wri |
5c60 | 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 |
5c80 | 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 |
5ca0 | 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 |
5cc0 | 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 6c 65 73 20 66 6f 72 | dition,.as.well.as.PDF.files.for |
5ce0 | 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 58 2e 20 57 65 20 77 | .offline.use.through.LaTeX..We.w |
5d00 | 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 69 62 75 74 69 6f 6e | elcome.all.sorts.of.contribution |
5d20 | 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 6f 74 20 6a 75 73 74 | s.to.the.documentation..Not.just |
5d40 | 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 6f 72 72 65 63 74 69 | .new.additions.but.also.correcti |
5d60 | 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 74 69 6f 6e 2e 00 56 | ons.to.existing.documentation..V |
5d80 | 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 74 65 6e 20 69 6e 20 | yOS.documentation.is.written.in. |
5da0 | 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 72 61 74 65 64 20 74 | reStructuredText.and.generated.t |
5dc0 | 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 68 20 53 70 68 69 6e | o.Read.the.Docs.pages.with.Sphin |
5de0 | 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 69 74 69 6f 6e 2e 20 | x,.as.per.the.Python.tradition.. |
5e00 | 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 69 62 75 | We.welcome.all.sorts.of.contribu |
5e20 | 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 6f 74 20 | tions.to.the.documentation..Not. |
5e40 | 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 6f 72 72 | just.new.additions.but.also.corr |
5e60 | 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 74 69 6f | ections.to.existing.documentatio |
5e80 | 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 53 20 75 73 65 72 20 | n..We.encourage.every.VyOS.user. |
5ea0 | 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 63 75 6d 65 6e 74 61 | to.help.us.improve.our.documenta |
5ec0 | 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 20 6c 69 6b 65 20 6d | tion.as.we.have.a.deficit.like.m |
5ee0 | 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 68 69 73 20 6e 6f 74 | ost.software.projects...This.not |
5f00 | 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 69 6e 67 20 62 75 74 | .only.helps.you.when.reading.but |
5f20 | 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 73 65 20 74 68 65 20 | .also.everyone.else..We.use.the. |
5f40 | 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 6c 69 6e 65 73 2e 00 | following.syntax.for.Headlines.. |
5f60 | 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 61 6e 64 73 2c 20 75 | When.documenting.CLI.commands,.u |
5f80 | 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 72 65 63 74 69 76 65 | se.the.``...cfgcmd::``.directive |
5fa0 | 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 64 65 20 63 6f 6d 6d | .for.all.configuration.mode.comm |
5fc0 | 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 68 65 20 64 65 73 63 | ands..An.explanation.of.the.desc |
5fe0 | 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 65 64 20 62 65 | ribed.command.should.be.added.be |
6000 | 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 63 65 20 61 6c 6c 20 | low.this.statement..Replace.all. |
6020 | 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 61 6c 75 65 3e 20 6f | variable.contents.with.<value>.o |
6040 | 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 20 64 6f 63 75 6d 65 | r.something.similar..When.docume |
6060 | 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 6f 6d 6d 61 6e 64 73 | nting.operational.level.commands |
6080 | 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 64 69 72 65 63 74 69 | ,.use.the.``...opcmd::``.directi |
60a0 | 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 20 64 65 73 63 72 69 | ve..An.explanation.of.the.descri |
60c0 | 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 65 64 20 62 65 6c 6f | bed.command.should.be.added.belo |
60e0 | 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 20 64 6f 75 62 74 2c | w.this.statement..When.in.doubt, |
6100 | 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 74 69 6e 67 20 64 6f | .follow.the.style.of.existing.do |
6120 | 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 63 69 6e 67 20 74 6f | cumentation..When.referencing.to |
6140 | 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 74 68 65 72 65 20 69 | .VyOS.Phabricator.Tasks,.there.i |
6160 | 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 63 6f 6d 6d 61 6e 64 | s.a.custom.Sphinx.Markup.command |
6180 | 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 75 74 6f 6d 61 74 69 | .called.``vytask``.that.automati |
61a0 | 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 20 50 68 61 62 72 69 | cally.renders.to.a.proper.Phabri |
61c0 | 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 79 20 75 73 65 64 20 | cator.URL..This.is.heavily.used. |
61e0 | 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 73 60 20 73 65 63 74 | in.the.:ref:`release-notes`.sect |
6200 | 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 6d 6d 61 6e 64 73 2c | ion..With.those.custom.commands, |
6220 | 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 20 74 68 65 6d 20 69 | .it.is.possible.to.render.them.i |
6240 | 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 65 20 | n.a.more.descriptive.way.in.the. |
6260 | 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 69 74 68 20 | resulting.HTML/PDF.manual..With. |
6280 | 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 20 77 69 6c 6c 20 62 | those.custom.commands,.it.will.b |
62a0 | 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 20 69 6e 20 61 20 6d | e.possible.to.render.them.in.a.m |
62c0 | 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 65 20 72 65 73 75 6c | ore.descriptive.way.in.the.resul |
62e0 | 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 74 65 20 44 6f 63 75 | ting.HTML/PDF.manual..Write.Docu |
6300 | 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 69 6e 73 74 61 6c 6c | mentation.You.can.either.install |
6320 | 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 20 50 44 46 20 6f 75 | .Sphinx.(and.TeX.Live.for.PDF.ou |
6340 | 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 65 6e 74 61 74 69 6f | tput).and.build.the.documentatio |
6360 | 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 6b 65 72 66 69 6c 65 | n.locally,.or.use.the.Dockerfile |
6380 | 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 6e 65 72 2e 00 59 6f | _.to.build.it.in.a.container..Yo |
63a0 | 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 6e 78 20 61 6e 64 20 | u.can.either.install.Sphinx.and. |
63c0 | 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 6f 63 61 6c 6c 79 2c | build.the.documentation.locally, |
63e0 | 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 6f 20 62 75 69 6c 64 | .or.use.the.Dockerfile_.to.build |
6400 | 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 72 65 6d 6f 74 65 20 | .it.in.a.container..Your.remote. |
6420 | 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 60 60 6f 72 69 67 69 | repo.on.Github.is.called.``origi |
6440 | 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 65 70 6f 20 79 6f 75 | n``,.while.the.original.repo.you |
6460 | 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 75 70 73 74 72 65 61 | .have.forked.is.called.``upstrea |
6480 | 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 75 70 64 61 74 65 20 | m``..Now.you.can.locally.update. |
64a0 | 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 2e 32 2e 30 2f 32 34 | your.forked.repo..``192.0.2.0/24 |
64c0 | 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 32 30 30 31 3a 64 62 | ``.``198.51.100.0/24``.``2001:db |
64e0 | 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 60 60 00 60 60 3a 72 | 8::/32``.``203.0.113.0/24``.``:r |
6500 | 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 75 72 61 74 69 6f 6e | ef:`Check.out.VLAN<configuration |
6520 | 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 3e 60 60 00 60 60 3a | /interfaces/ethernet:vlan>``.``: |
6540 | 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 61 63 65 73 2f 65 74 | ref:`configuration/interfaces/et |
6560 | 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 61 6c 6c 20 7a 6f 6e | hernet:vlan``.``set.firewall.zon |
6580 | 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 61 6c 6c 2f 7a 6f 6e | e``.is.written.in.``firewall/zon |
65a0 | 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 65 74 68 65 72 6e 65 | e.rst``.``set.interfaces.etherne |
65c0 | 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 66 61 63 65 73 2f 65 | t``.is.written.in.``interfaces/e |
65e0 | 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 70 6c 61 6e 61 74 69 | thernet.rst``.a.simple.explanati |
6600 | 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 62 6f 75 74 2c 20 77 | on.of.what.is.this.page.about,.w |
6620 | 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 20 74 6f 20 62 65 20 | hy.or.when.it.is.required.to.be. |
6640 | 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 6e 64 6c 65 20 62 75 | used.cfgcmd.cmdinclude.handle.bu |
6660 | 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 20 6c 6f 67 73 20 6f | ild.errors.how.to.collect.logs.o |
6680 | 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 74 69 6f 6e 20 28 6c | r.other.debugging.information.(l |
66a0 | 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 74 29 00 68 6f 77 20 | ike.`show`.commands.output).how. |
66c0 | 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 68 20 66 6f 72 20 69 | to.read.and.what.to.search.for.i |
66e0 | 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 72 6d 61 74 69 6f 6e | n.logs.and.collected.information |
6700 | 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 6c 20 70 72 6f 62 6c | .known.issues.or.potential.probl |
6720 | 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 65 20 63 61 73 65 00 | ems.for.the.service.or.use.case. |
6740 | 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 61 72 64 73 2c 20 52 | opcmd.references.to.standards,.R |
6760 | 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 61 63 65 2d 61 64 64 | FCs.the.content.of.interface-add |
6780 | 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 74 6f 20 75 73 65 20 | ress.txt.looks.like.this.to.use. |
67a0 | 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 75 73 65 20 69 74 20 | an.alternative.hyperlink.use.it. |
67c0 | 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 20 69 6e 64 69 63 61 | this.way:.vytask.what.are.indica |
67e0 | 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 65 73 20 69 6e 20 64 | tors.of.good.and.bad.states.in.d |
6800 | 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 6e 64 73 20 66 6f 72 | ebugging.outputs.workarounds.for |
6820 | 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 73 74 29 00 | .known.issues.(if.any.exist). |