| 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 da 00 00 00 | P8.......8..?....8..+....8...... |
| 0400 | f4 38 00 00 1a 00 00 00 cf 39 00 00 1c 00 00 00 ea 39 00 00 1c 00 00 00 07 3a 00 00 19 00 00 00 | .8.......9.......9.......:...... |
| 0420 | 24 3a 00 00 1c 00 00 00 3e 3a 00 00 0f 00 00 00 5b 3a 00 00 0c 00 00 00 6b 3a 00 00 97 00 00 00 | $:......>:......[:......k:...... |
| 0440 | 78 3a 00 00 b4 00 00 00 10 3b 00 00 0d 00 00 00 c5 3b 00 00 4a 00 00 00 d3 3b 00 00 d4 00 00 00 | x:.......;.......;..J....;...... |
| 0460 | 1e 3c 00 00 a6 00 00 00 f3 3c 00 00 0d 00 00 00 9a 3d 00 00 5e 00 00 00 a8 3d 00 00 0a 00 00 00 | .<.......<.......=..^....=...... |
| 0480 | 07 3e 00 00 06 01 00 00 12 3e 00 00 2a 00 00 00 19 3f 00 00 56 00 00 00 44 3f 00 00 01 01 00 00 | .>.......>..*....?..V...D?...... |
| 04a0 | 9b 3f 00 00 18 00 00 00 9d 40 00 00 6b 00 00 00 b6 40 00 00 10 00 00 00 22 41 00 00 18 00 00 00 | .?.......@..k....@......"A...... |
| 04c0 | 33 41 00 00 aa 00 00 00 4c 41 00 00 9d 00 00 00 f7 41 00 00 2d 00 00 00 95 42 00 00 3c 00 00 00 | 3A......LA.......A..-....B..<... |
| 04e0 | c3 42 00 00 5c 00 00 00 00 43 00 00 2b 00 00 00 5d 43 00 00 7f 00 00 00 89 43 00 00 3b 00 00 00 | .B..\....C..+...]C.......C..;... |
| 0500 | 09 44 00 00 38 00 00 00 45 44 00 00 9e 00 00 00 7e 44 00 00 0c 00 00 00 1d 45 00 00 4b 00 00 00 | .D..8...ED......~D.......E..K... |
| 0520 | 2a 45 00 00 10 00 00 00 76 45 00 00 1a 00 00 00 87 45 00 00 1b 00 00 00 a2 45 00 00 53 00 00 00 | *E......vE.......E.......E..S... |
| 0540 | be 45 00 00 0a 00 00 00 12 46 00 00 63 00 00 00 1d 46 00 00 5f 00 00 00 81 46 00 00 5e 00 00 00 | .E.......F..c....F.._....F..^... |
| 0560 | e1 46 00 00 9d 00 00 00 40 47 00 00 84 00 00 00 de 47 00 00 17 00 00 00 63 48 00 00 55 00 00 00 | .F......@G.......G......cH..U... |
| 0580 | 7b 48 00 00 2a 00 00 00 d1 48 00 00 2e 00 00 00 fc 48 00 00 0b 00 00 00 2b 49 00 00 90 01 00 00 | {H..*....H.......H......+I...... |
| 05a0 | 37 49 00 00 35 00 00 00 c8 4a 00 00 b5 00 00 00 fe 4a 00 00 0e 01 00 00 b4 4b 00 00 85 00 00 00 | 7I..5....J.......J.......K...... |
| 05c0 | c3 4c 00 00 14 00 00 00 49 4d 00 00 0c 00 00 00 5e 4d 00 00 2d 00 00 00 6b 4d 00 00 84 00 00 00 | .L......IM......^M..-...kM...... |
| 05e0 | 99 4d 00 00 51 00 00 00 1e 4e 00 00 4b 00 00 00 70 4e 00 00 73 00 00 00 bc 4e 00 00 d2 00 00 00 | .M..Q....N..K...pN..s....N...... |
| 0600 | 30 4f 00 00 0b 00 00 00 03 50 00 00 a3 00 00 00 0f 50 00 00 09 00 00 00 b3 50 00 00 68 00 00 00 | 0O.......P.......P.......P..h... |
| 0620 | bd 50 00 00 59 01 00 00 26 51 00 00 8e 00 00 00 80 52 00 00 c6 00 00 00 0f 53 00 00 86 00 00 00 | .P..Y...&Q.......R.......S...... |
| 0640 | d6 53 00 00 ba 00 00 00 5d 54 00 00 2e 00 00 00 18 55 00 00 90 01 00 00 47 55 00 00 a5 00 00 00 | .S......]T.......U......GU...... |
| 0660 | d8 56 00 00 54 00 00 00 7e 57 00 00 7b 00 00 00 d3 57 00 00 24 00 00 00 4f 58 00 00 f1 00 00 00 | .V..T...~W..{....W..$...OX...... |
| 0680 | 74 58 00 00 9c 00 00 00 66 59 00 00 49 00 00 00 03 5a 00 00 33 00 00 00 4d 5a 00 00 7b 00 00 00 | tX......fY..I....Z..3...MZ..{... |
| 06a0 | 81 5a 00 00 86 00 00 00 fd 5a 00 00 27 00 00 00 84 5b 00 00 a7 00 00 00 ac 5b 00 00 37 01 00 00 | .Z.......Z..'....[.......[..7... |
| 06c0 | 54 5c 00 00 03 01 00 00 8c 5d 00 00 b1 00 00 00 90 5e 00 00 2a 00 00 00 42 5f 00 00 f4 00 00 00 | T\.......].......^..*...B_...... |
| 06e0 | 6d 5f 00 00 9c 00 00 00 62 60 00 00 3a 00 00 00 ff 60 00 00 d7 00 00 00 3a 61 00 00 75 00 00 00 | m_......b`..:....`......:a..u... |
| 0700 | 12 62 00 00 7a 00 00 00 88 62 00 00 13 00 00 00 03 63 00 00 93 00 00 00 17 63 00 00 75 00 00 00 | .b..z....b.......c.......c..u... |
| 0720 | ab 63 00 00 9d 00 00 00 21 64 00 00 10 00 00 00 bf 64 00 00 13 00 00 00 d0 64 00 00 11 00 00 00 | .c......!d.......d.......d...... |
| 0740 | e4 64 00 00 12 00 00 00 f6 64 00 00 40 00 00 00 09 65 00 00 30 00 00 00 4a 65 00 00 39 00 00 00 | .d.......d..@....e..0...Je..9... |
| 0760 | 7b 65 00 00 45 00 00 00 b5 65 00 00 56 00 00 00 fb 65 00 00 06 00 00 00 52 66 00 00 0a 00 00 00 | {e..E....e..V....e......Rf...... |
| 0780 | 59 66 00 00 13 00 00 00 64 66 00 00 50 00 00 00 78 66 00 00 44 00 00 00 c9 66 00 00 3e 00 00 00 | Yf......df..P...xf..D....f..>... |
| 07a0 | 0e 67 00 00 05 00 00 00 4d 67 00 00 1d 00 00 00 53 67 00 00 34 00 00 00 71 67 00 00 30 00 00 00 | .g......Mg......Sg..4...qg..0... |
| 07c0 | a6 67 00 00 06 00 00 00 d7 67 00 00 3f 00 00 00 de 67 00 00 2b 00 00 00 1e 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 65 6e 0a 50 6c 75 | ct-Id-Version:..Language:.en.Plu |
| 39a0 | 72 61 6c 2d 46 6f 72 6d 73 3a 20 6e 70 6c 75 72 61 6c 73 3d 32 3b 20 70 6c 75 72 61 6c 3d 28 6e | ral-Forms:.nplurals=2;.plural=(n |
| 39c0 | 3d 3d 31 29 20 3f 20 30 20 3a 20 31 3b 0a 00 31 2e 20 54 68 65 6f 72 65 74 69 63 61 6c 20 69 6e | ==1).?.0.:.1;..1..Theoretical.in |
| 39e0 | 66 6f 72 6d 61 74 69 6f 6e 00 31 36 62 69 74 20 41 53 4e 3a 20 60 60 36 34 34 39 36 20 2d 20 36 | formation.16bit.ASN:.``64496.-.6 |
| 3a00 | 34 35 31 31 60 60 00 32 2e 20 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 64 65 73 63 72 69 70 74 | 4511``.2..Configuration.descript |
| 3a20 | 69 6f 6e 00 33 2e 20 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 65 78 61 6d 70 6c 65 73 00 33 32 | ion.3..Configuration.examples.32 |
| 3a40 | 62 69 74 20 41 53 4e 3a 20 60 60 36 35 35 33 36 20 2d 20 36 35 35 35 31 60 60 00 34 2e 20 4b 6e | bit.ASN:.``65536.-.65551``.4..Kn |
| 3a60 | 6f 77 6e 20 69 73 73 75 65 73 00 35 2e 20 44 65 62 75 67 67 69 6e 67 00 41 20 70 6c 75 67 69 6e | own.issues.5..Debugging.A.plugin |
| 3a80 | 20 77 69 6c 6c 20 62 65 20 75 73 65 64 20 74 6f 20 67 65 6e 65 72 61 74 65 20 61 20 72 65 66 65 | .will.be.used.to.generate.a.refe |
| 3aa0 | 72 65 6e 63 65 20 6c 61 62 65 6c 20 66 6f 72 20 65 61 63 68 20 68 65 61 64 6c 69 6e 65 2e 20 54 | rence.label.for.each.headline..T |
| 3ac0 | 6f 20 72 65 66 65 72 65 6e 63 65 20 61 20 70 61 67 65 20 6f 72 20 61 20 73 65 63 74 69 6f 6e 20 | o.reference.a.page.or.a.section. |
| 3ae0 | 69 6e 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 75 73 65 20 74 68 65 20 60 60 3a | in.the.documentation.use.the.``: |
| 3b00 | 72 65 66 3a 60 60 20 63 6f 6d 6d 61 6e 64 2e 00 41 64 64 20 6d 6f 64 69 66 69 65 64 20 66 69 6c | ref:``.command..Add.modified.fil |
| 3b20 | 65 73 20 74 6f 20 47 69 74 20 69 6e 64 65 78 20 60 60 24 20 67 69 74 20 61 64 64 20 70 61 74 68 | es.to.Git.index.``$.git.add.path |
| 3b40 | 2f 74 6f 2f 66 69 6c 65 6e 61 6d 65 60 60 20 6f 72 20 61 64 64 20 61 6c 6c 20 75 6e 73 74 61 67 | /to/filename``.or.add.all.unstag |
| 3b60 | 65 64 20 66 69 6c 65 73 20 60 60 24 20 67 69 74 20 61 64 64 20 2e 60 60 2e 20 41 6c 6c 20 66 69 | ed.files.``$.git.add..``..All.fi |
| 3b80 | 6c 65 73 20 61 64 64 65 64 20 74 6f 20 74 68 65 20 47 69 74 20 69 6e 64 65 78 20 77 69 6c 6c 20 | les.added.to.the.Git.index.will. |
| 3ba0 | 62 65 20 70 61 72 74 20 6f 66 20 79 6f 75 20 66 6f 6c 6c 6f 77 69 6e 67 20 47 69 74 20 63 6f 6d | be.part.of.you.following.Git.com |
| 3bc0 | 6d 69 74 2e 00 41 64 64 72 65 73 73 20 73 70 61 63 65 00 41 6c 6c 20 52 53 54 20 66 69 6c 65 73 | mit..Address.space.All.RST.files |
| 3be0 | 20 6d 75 73 74 20 66 6f 6c 6c 6f 77 20 74 68 65 20 73 61 6d 65 20 54 4f 43 20 4c 65 76 65 6c 20 | .must.follow.the.same.TOC.Level. |
| 3c00 | 73 79 6e 74 61 78 20 61 6e 64 20 68 61 76 65 20 74 6f 20 73 74 61 72 74 20 77 69 74 68 00 41 6e | syntax.and.have.to.start.with.An |
| 3c20 | 20 6f 70 74 69 6f 6e 61 6c 20 73 65 63 74 69 6f 6e 20 66 6f 6c 6c 6f 77 73 2e 20 53 6f 6d 65 20 | .optional.section.follows..Some. |
| 3c40 | 63 6f 6d 6d 61 6e 64 73 20 68 61 76 65 20 72 65 71 75 69 72 65 6d 65 6e 74 73 20 6c 69 6b 65 20 | commands.have.requirements.like. |
| 3c60 | 63 6f 6d 70 61 74 69 62 6c 65 20 68 61 72 64 77 61 72 65 20 28 65 2e 67 2e 20 57 69 66 69 29 20 | compatible.hardware.(e.g..Wifi). |
| 3c80 | 6f 72 20 73 6f 6d 65 20 63 6f 6d 6d 61 6e 64 73 20 79 6f 75 20 68 61 76 65 20 74 6f 20 73 65 74 | or.some.commands.you.have.to.set |
| 3ca0 | 20 62 65 66 6f 72 65 2e 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 69 74 20 69 73 20 72 65 63 6f | .before..For.example,.it.is.reco |
| 3cc0 | 6d 6d 65 6e 64 65 64 20 74 6f 20 73 65 74 20 61 20 72 6f 75 74 65 2d 6d 61 70 20 62 65 66 6f 72 | mmended.to.set.a.route-map.befor |
| 3ce0 | 65 20 63 6f 6e 66 69 67 75 72 69 6e 67 20 42 47 50 2e 00 41 6e 64 20 66 69 6e 61 6c 6c 79 2c 20 | e.configuring.BGP..And.finally,. |
| 3d00 | 72 65 6d 65 6d 62 65 72 20 74 68 61 74 20 74 68 65 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 | remember.that.the.reStructuredTe |
| 3d20 | 78 74 20 66 69 6c 65 73 20 61 72 65 6e 27 74 20 65 78 63 6c 75 73 69 76 65 6c 79 20 66 6f 72 20 | xt.files.aren't.exclusively.for. |
| 3d40 | 67 65 6e 65 72 61 74 69 6e 67 20 48 54 4d 4c 20 61 6e 64 20 50 44 46 2e 20 54 68 65 79 20 73 68 | generating.HTML.and.PDF..They.sh |
| 3d60 | 6f 75 6c 64 20 62 65 20 68 75 6d 61 6e 2d 72 65 61 64 61 62 6c 65 20 61 6e 64 20 65 61 73 69 6c | ould.be.human-readable.and.easil |
| 3d80 | 79 20 70 65 72 75 73 65 64 20 66 72 6f 6d 20 61 20 63 6f 6e 73 6f 6c 65 2e 00 41 6e 79 74 68 69 | y.perused.from.a.console..Anythi |
| 3da0 | 6e 67 20 65 6c 73 65 00 41 6e 79 74 68 69 6e 67 20 65 6c 73 65 20 74 68 61 74 20 69 73 20 6e 6f | ng.else.Anything.else.that.is.no |
| 3dc0 | 74 20 61 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 72 20 61 6e 20 6f 70 65 72 61 74 69 6f | t.a.configuration.or.an.operatio |
| 3de0 | 6e 20 63 6f 6d 6d 61 6e 64 20 68 61 73 20 6e 6f 20 70 72 65 64 65 66 69 6e 65 64 20 73 74 72 75 | n.command.has.no.predefined.stru |
| 3e00 | 63 74 75 72 65 2e 00 41 75 74 6f 6c 69 6e 74 65 72 00 43 68 65 63 6b 20 79 6f 75 72 20 63 68 61 | cture..Autolinter.Check.your.cha |
| 3e20 | 6e 67 65 73 20 62 79 20 6c 6f 63 61 6c 6c 79 20 62 75 69 6c 64 69 6e 67 20 74 68 65 20 64 6f 63 | nges.by.locally.building.the.doc |
| 3e40 | 75 6d 65 6e 74 61 74 69 6f 6e 20 60 60 24 20 6d 61 6b 65 20 6c 69 76 65 68 74 6d 6c 60 60 2e 20 | umentation.``$.make.livehtml``.. |
| 3e60 | 53 70 68 69 6e 78 20 77 69 6c 6c 20 62 75 69 6c 64 20 74 68 65 20 68 74 6d 6c 20 66 69 6c 65 73 | Sphinx.will.build.the.html.files |
| 3e80 | 20 69 6e 20 74 68 65 20 60 60 64 6f 63 73 2f 5f 62 75 69 6c 64 60 60 20 66 6f 6c 64 65 72 2e 20 | .in.the.``docs/_build``.folder.. |
| 3ea0 | 57 65 20 70 72 6f 76 69 64 65 20 79 6f 75 20 77 69 74 68 20 61 20 44 6f 63 6b 65 72 20 63 6f 6e | We.provide.you.with.a.Docker.con |
| 3ec0 | 74 61 69 6e 65 72 20 66 6f 72 20 61 6e 20 65 61 73 79 2d 74 6f 2d 75 73 65 20 75 73 65 72 20 65 | tainer.for.an.easy-to-use.user.e |
| 3ee0 | 78 70 65 72 69 65 6e 63 65 2e 20 43 68 65 63 6b 20 74 68 65 20 52 45 41 44 4d 45 2e 6d 64 5f 20 | xperience..Check.the.README.md_. |
| 3f00 | 66 69 6c 65 20 6f 66 20 74 68 69 73 20 72 65 70 6f 73 69 74 6f 72 79 2e 00 43 68 65 63 6b 20 79 | file.of.this.repository..Check.y |
| 3f20 | 6f 75 72 20 63 6f 6e 66 69 67 75 72 65 64 20 72 65 6d 6f 74 65 20 72 65 70 6f 73 69 74 6f 72 69 | our.configured.remote.repositori |
| 3f40 | 65 73 3a 00 43 6c 6f 6e 65 20 66 6f 72 6b 20 74 6f 20 6c 6f 63 61 6c 20 6d 61 63 68 69 6e 65 2c | es:.Clone.fork.to.local.machine, |
| 3f60 | 20 74 68 65 6e 20 63 68 61 6e 67 65 20 74 6f 20 74 68 61 74 20 64 69 72 65 63 74 6f 72 79 20 60 | .then.change.to.that.directory.` |
| 3f80 | 60 24 20 63 64 20 76 79 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 60 60 00 43 6f 6d 6d 69 | `$.cd.vyos-documentation``.Commi |
| 3fa0 | 74 20 79 6f 75 72 20 63 68 61 6e 67 65 73 20 77 69 74 68 20 74 68 65 20 6d 65 73 73 61 67 65 2c | t.your.changes.with.the.message, |
| 3fc0 | 20 60 60 24 20 67 69 74 20 63 6f 6d 6d 69 74 20 2d 6d 20 22 3c 63 6f 6d 6d 69 74 20 6d 65 73 73 | .``$.git.commit.-m."<commit.mess |
| 3fe0 | 61 67 65 3e 22 60 60 20 6f 72 20 20 75 73 65 20 60 60 24 20 67 69 74 20 63 6f 6d 6d 69 74 20 2d | age>"``.or..use.``$.git.commit.- |
| 4000 | 76 60 60 20 74 6f 20 68 61 76 65 20 79 6f 75 72 20 63 6f 6e 66 69 67 75 72 65 64 20 65 64 69 74 | v``.to.have.your.configured.edit |
| 4020 | 6f 72 20 6c 61 75 6e 63 68 65 64 2e 20 59 6f 75 20 63 61 6e 20 74 79 70 65 20 69 6e 20 61 20 63 | or.launched..You.can.type.in.a.c |
| 4040 | 6f 6d 6d 69 74 20 6d 65 73 73 61 67 65 2e 20 41 67 61 69 6e 20 70 6c 65 61 73 65 20 6d 61 6b 65 | ommit.message..Again.please.make |
| 4060 | 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 6f 75 74 20 72 75 | .yourself.comfortable.without.ru |
| 4080 | 6c 65 73 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 00 43 6f 6e | les.(:ref:`prepare_commit`)..Con |
| 40a0 | 66 69 67 75 72 61 74 69 6f 6e 20 6d 6f 64 65 20 70 61 67 65 73 00 43 72 65 61 74 65 20 61 20 6e | figuration.mode.pages.Create.a.n |
| 40c0 | 65 77 20 62 72 61 6e 63 68 20 66 6f 72 20 79 6f 75 72 20 77 6f 72 6b 2c 20 75 73 65 20 61 20 64 | ew.branch.for.your.work,.use.a.d |
| 40e0 | 65 73 63 72 69 70 74 69 76 65 20 6e 61 6d 65 20 6f 66 20 79 6f 75 72 20 77 6f 72 6b 3a 20 60 60 | escriptive.name.of.your.work:.`` |
| 4100 | 24 20 67 69 74 20 63 68 65 63 6b 6f 75 74 20 2d 62 20 3c 62 72 61 6e 63 68 2d 6e 61 6d 65 3e 60 | $.git.checkout.-b.<branch-name>` |
| 4120 | 60 00 43 72 6f 73 73 2d 52 65 66 65 72 65 6e 63 65 73 00 43 75 73 74 6f 6d 20 53 70 68 69 6e 78 | `.Cross-References.Custom.Sphinx |
| 4140 | 2d 64 6f 63 20 4d 61 72 6b 75 70 00 43 75 73 74 6f 6d 20 63 6f 6d 6d 61 6e 64 73 20 68 61 76 65 | -doc.Markup.Custom.commands.have |
| 4160 | 20 62 65 65 6e 20 64 65 76 65 6c 6f 70 65 64 20 66 6f 72 20 77 72 69 74 69 6e 67 20 74 68 65 20 | .been.developed.for.writing.the. |
| 4180 | 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 50 6c 65 61 73 65 20 6d 61 6b 65 20 79 6f 75 72 73 | documentation..Please.make.yours |
| 41a0 | 65 6c 66 20 63 6f 6d 66 6f 72 74 61 62 6c 65 20 77 69 74 68 20 74 68 6f 73 65 20 63 6f 6d 6d 61 | elf.comfortable.with.those.comma |
| 41c0 | 6e 64 73 20 61 73 20 74 68 69 73 20 65 61 73 65 73 20 74 68 65 20 77 61 79 20 77 65 20 72 65 6e | nds.as.this.eases.the.way.we.ren |
| 41e0 | 64 65 72 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 44 65 73 63 72 69 62 65 20 | der.the.documentation..Describe. |
| 4200 | 43 4c 49 20 69 74 65 6d 73 20 72 65 6c 61 74 65 64 20 74 6f 20 74 68 65 20 73 65 72 76 69 63 65 | CLI.items.related.to.the.service |
| 4220 | 20 6f 72 20 75 73 65 20 63 61 73 65 2e 20 45 61 63 68 20 63 6f 6e 66 69 67 20 6c 69 6e 65 20 6f | .or.use.case..Each.config.line.o |
| 4240 | 72 20 73 65 63 74 69 6f 6e 20 6d 75 73 74 20 62 65 20 65 78 70 6c 61 69 6e 65 64 2c 20 75 73 69 | r.section.must.be.explained,.usi |
| 4260 | 6e 67 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 70 72 6f 76 69 64 65 64 20 69 6e 20 74 68 65 20 31 | ng.information.provided.in.the.1 |
| 4280 | 73 74 20 70 61 72 74 20 6f 66 20 74 68 65 20 70 61 67 65 2e 00 44 65 73 63 72 69 62 65 64 20 70 | st.part.of.the.page..Described.p |
| 42a0 | 72 6f 63 65 64 75 72 65 73 20 66 6f 72 20 64 65 62 75 67 67 69 6e 67 20 61 20 73 65 72 76 69 63 | rocedures.for.debugging.a.servic |
| 42c0 | 65 3a 00 44 6f 6e 27 74 20 66 6f 72 67 65 74 20 74 6f 20 75 70 64 61 74 65 20 60 60 69 6e 64 65 | e:.Don't.forget.to.update.``inde |
| 42e0 | 78 2e 72 73 74 60 60 20 77 68 65 6e 20 61 64 64 69 6e 67 20 61 20 6e 65 77 20 6e 6f 64 65 2e 00 | x.rst``.when.adding.a.new.node.. |
| 4300 | 45 61 63 68 20 47 69 74 48 75 62 20 70 75 6c 6c 20 72 65 71 75 65 73 74 20 69 73 20 61 75 74 6f | Each.GitHub.pull.request.is.auto |
| 4320 | 6d 61 74 69 63 61 6c 6c 79 20 6c 69 6e 74 65 64 20 74 6f 20 63 68 65 63 6b 20 74 68 65 20 61 64 | matically.linted.to.check.the.ad |
| 4340 | 64 72 65 73 73 20 73 70 61 63 65 20 61 6e 64 20 6c 69 6e 65 20 6c 65 6e 67 74 68 2e 00 45 61 63 | dress.space.and.line.length..Eac |
| 4360 | 68 20 70 61 67 65 20 6d 75 73 74 20 63 6f 6e 74 61 69 6e 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e | h.page.must.contain.the.followin |
| 4380 | 67 20 70 61 72 74 73 3a 00 45 78 63 65 70 74 20 69 6e 20 60 60 2e 2e 20 63 6f 64 65 2d 62 6c 6f | g.parts:.Except.in.``...code-blo |
| 43a0 | 63 6b 3a 3a 60 60 20 62 65 63 61 75 73 65 20 69 74 20 75 73 65 73 20 74 68 65 20 68 74 6d 6c 20 | ck::``.because.it.uses.the.html. |
| 43c0 | 74 61 67 20 60 60 3c 70 72 65 3e 60 60 20 61 6e 64 20 72 65 6e 64 65 72 73 20 74 68 65 20 73 61 | tag.``<pre>``.and.renders.the.sa |
| 43e0 | 6d 65 20 6c 69 6e 65 20 66 6f 72 6d 61 74 20 66 72 6f 6d 20 74 68 65 20 73 6f 75 72 63 65 20 72 | me.line.format.from.the.source.r |
| 4400 | 73 74 20 66 69 6c 65 2e 00 46 6f 72 20 61 6e 20 69 6e 6c 69 6e 65 20 63 6f 6e 66 69 67 75 72 61 | st.file..For.an.inline.configura |
| 4420 | 74 69 6f 6e 20 6c 65 76 65 6c 20 63 6f 6d 6d 61 6e 64 2c 20 75 73 65 20 60 60 3a 63 66 67 63 6d | tion.level.command,.use.``:cfgcm |
| 4440 | 64 3a 60 60 00 46 6f 72 20 61 6e 20 69 6e 6c 69 6e 65 20 6f 70 65 72 61 74 69 6f 6e 61 6c 20 6c | d:``.For.an.inline.operational.l |
| 4460 | 65 76 65 6c 20 63 6f 6d 6d 61 6e 64 2c 20 75 73 65 20 60 60 3a 6f 70 63 6d 64 3a 60 60 00 46 6f | evel.command,.use.``:opcmd:``.Fo |
| 4480 | 72 20 65 78 61 6d 70 6c 65 2c 20 79 6f 75 20 77 61 6e 74 20 74 6f 20 72 65 66 65 72 65 6e 63 65 | r.example,.you.want.to.reference |
| 44a0 | 20 74 68 65 20 68 65 61 64 6c 69 6e 65 20 2a 2a 56 4c 41 4e 2a 2a 20 69 6e 20 74 68 65 20 2a 2a | .the.headline.**VLAN**.in.the.** |
| 44c0 | 65 74 68 65 72 6e 65 74 2e 72 73 74 2a 2a 20 70 61 67 65 2e 20 54 68 65 20 70 6c 75 67 69 6e 20 | ethernet.rst**.page..The.plugin. |
| 44e0 | 67 65 6e 65 72 61 74 65 73 20 74 68 65 20 6c 61 62 65 6c 20 62 61 73 65 64 20 6f 6e 20 74 68 65 | generates.the.label.based.on.the |
| 4500 | 20 68 65 61 64 6c 69 6e 65 20 61 6e 64 20 74 68 65 20 66 69 6c 65 20 70 61 74 68 2e 00 46 6f 72 | .headline.and.the.file.path..For |
| 4520 | 20 65 78 61 6d 70 6c 65 3a 00 46 6f 72 6b 20 74 68 69 73 20 70 72 6f 6a 65 63 74 20 6f 6e 20 47 | .example:.Fork.this.project.on.G |
| 4540 | 69 74 48 75 62 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 | itHub.https://github.com/vyos/vy |
| 4560 | 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2f 66 6f 72 6b 00 46 6f 72 6b 69 6e 67 20 57 6f | os-documentation/fork.Forking.Wo |
| 4580 | 72 6b 66 6c 6f 77 00 46 6f 72 6d 61 74 69 6e 67 20 61 6e 64 20 53 70 68 69 6e 78 6d 61 72 6b 75 | rkflow.Formating.and.Sphinxmarku |
| 45a0 | 70 00 46 6f 72 6d 61 74 74 69 6e 67 20 61 6e 64 20 53 70 68 69 6e 78 6d 61 72 6b 75 70 00 47 65 | p.Formatting.and.Sphinxmarkup.Ge |
| 45c0 | 6e 65 72 61 6c 20 63 6f 6e 63 65 70 74 73 20 66 6f 72 20 74 72 6f 75 62 6c 65 73 68 6f 6f 74 69 | neral.concepts.for.troubleshooti |
| 45e0 | 6e 67 20 61 6e 64 20 64 65 74 61 69 6c 65 64 20 70 72 6f 63 65 73 73 20 64 65 73 63 72 69 70 74 | ng.and.detailed.process.descript |
| 4600 | 69 6f 6e 73 20 62 65 6c 6f 6e 67 20 68 65 72 65 2e 00 47 75 69 64 65 6c 69 6e 65 73 00 49 66 20 | ions.belong.here..Guidelines.If. |
| 4620 | 74 68 65 72 65 20 73 6f 6d 65 20 74 72 6f 75 62 6c 65 73 68 6f 6f 74 69 6e 67 20 67 75 69 64 65 | there.some.troubleshooting.guide |
| 4640 | 73 20 72 65 6c 61 74 65 64 20 74 6f 20 74 68 65 20 63 6f 6d 6d 61 6e 64 73 2e 20 45 78 70 6c 61 | s.related.to.the.commands..Expla |
| 4660 | 69 6e 20 69 74 20 69 6e 20 74 68 65 20 6e 65 78 74 20 6f 70 74 69 6f 6e 61 6c 20 70 61 72 74 2e | in.it.in.the.next.optional.part. |
| 4680 | 00 49 66 20 79 6f 75 20 61 6c 73 6f 20 77 61 6e 74 20 74 6f 20 75 70 64 61 74 65 20 79 6f 75 72 | .If.you.also.want.to.update.your |
| 46a0 | 20 66 6f 72 6b 20 6f 6e 20 47 69 74 48 75 62 2c 20 75 73 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 | .fork.on.GitHub,.use.the.followi |
| 46c0 | 6e 67 3a 20 60 60 24 20 67 69 74 20 70 75 73 68 20 6f 72 69 67 69 6e 20 6d 61 73 74 65 72 60 60 | ng:.``$.git.push.origin.master`` |
| 46e0 | 00 49 66 20 79 6f 75 20 61 72 65 20 77 69 6c 6c 69 6e 67 20 74 6f 20 63 6f 6e 74 72 69 62 75 74 | .If.you.are.willing.to.contribut |
| 4700 | 65 20 74 6f 20 6f 75 72 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 74 68 69 73 20 69 73 20 74 | e.to.our.documentation.this.is.t |
| 4720 | 68 65 20 64 65 66 69 6e 69 74 65 20 67 75 69 64 65 20 68 6f 77 20 74 6f 20 64 6f 20 73 6f 2e 00 | he.definite.guide.how.to.do.so.. |
| 4740 | 49 6e 20 63 6f 6e 74 72 61 73 74 20 74 6f 20 73 75 62 6d 69 74 74 69 6e 67 20 63 6f 64 65 20 70 | In.contrast.to.submitting.code.p |
| 4760 | 61 74 63 68 65 73 2c 20 74 68 65 72 65 20 69 73 20 6e 6f 20 72 65 71 75 69 72 65 6d 65 6e 74 20 | atches,.there.is.no.requirement. |
| 4780 | 74 68 61 74 20 79 6f 75 20 6f 70 65 6e 20 75 70 20 61 20 50 68 61 62 72 69 63 61 74 6f 72 5f 20 | that.you.open.up.a.Phabricator_. |
| 47a0 | 74 61 73 6b 20 70 72 69 6f 72 20 74 6f 20 73 75 62 6d 69 74 74 69 6e 67 20 61 20 50 75 6c 6c 2d | task.prior.to.submitting.a.Pull- |
| 47c0 | 52 65 71 75 65 73 74 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 49 6e | Request.to.the.documentation..In |
| 47e0 | 20 74 68 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 70 61 72 74 20 6f 66 20 74 68 65 20 70 | .the.configuration.part.of.the.p |
| 4800 | 61 67 65 2c 20 61 6c 6c 20 70 6f 73 73 69 62 6c 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 | age,.all.possible.configuration. |
| 4820 | 6f 70 74 69 6f 6e 73 20 73 68 6f 75 6c 64 20 62 65 20 64 6f 63 75 6d 65 6e 74 65 64 2e 20 55 73 | options.should.be.documented..Us |
| 4840 | 65 20 60 60 2e 2e 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 65 73 63 72 69 62 65 64 20 61 62 6f 76 | e.``...cfgcmd::``.described.abov |
| 4860 | 65 2e 00 49 6e 64 65 6e 74 20 77 69 74 68 20 74 77 6f 20 73 70 61 63 65 73 2e 00 49 6e 73 74 61 | e..Indent.with.two.spaces..Insta |
| 4880 | 6c 6c 20 74 68 65 20 72 65 71 75 69 72 65 6d 65 6e 74 73 20 60 60 24 20 70 69 70 20 69 6e 73 74 | ll.the.requirements.``$.pip.inst |
| 48a0 | 61 6c 6c 20 2d 72 20 72 65 71 75 69 72 65 6d 65 6e 74 73 2e 74 78 74 60 60 20 28 6f 72 20 73 6f | all.-r.requirements.txt``.(or.so |
| 48c0 | 6d 65 74 68 69 6e 67 20 73 69 6d 69 6c 61 72 29 00 4c 65 61 76 65 20 61 20 6e 65 77 6c 69 6e 65 | mething.similar).Leave.a.newline |
| 48e0 | 20 62 65 66 6f 72 65 20 61 6e 64 20 61 66 74 65 72 20 61 20 68 65 61 64 65 72 2e 00 4c 69 6d 69 | .before.and.after.a.header..Limi |
| 4900 | 74 20 61 6c 6c 20 6c 69 6e 65 73 20 74 6f 20 61 20 6d 61 78 69 6d 75 6d 20 6f 66 20 38 30 20 63 | t.all.lines.to.a.maximum.of.80.c |
| 4920 | 68 61 72 61 63 74 65 72 73 2e 00 4c 69 6e 65 20 6c 65 6e 67 74 68 00 4d 61 6b 65 20 61 6c 6c 20 | haracters..Line.length.Make.all. |
| 4940 | 79 6f 75 72 20 63 68 61 6e 67 65 73 20 2d 20 70 6c 65 61 73 65 20 6b 65 65 70 20 6f 75 72 20 63 | your.changes.-.please.keep.our.c |
| 4960 | 6f 6d 6d 69 74 20 72 75 6c 65 73 20 69 6e 20 6d 69 6e 64 20 28 3a 72 65 66 3a 60 70 72 65 70 61 | ommit.rules.in.mind.(:ref:`prepa |
| 4980 | 72 65 5f 63 6f 6d 6d 69 74 60 29 2e 20 54 68 69 73 20 6d 61 69 6e 6c 79 20 61 70 70 6c 69 65 73 | re_commit`)..This.mainly.applies |
| 49a0 | 20 74 6f 20 70 72 6f 70 65 72 20 63 6f 6d 6d 69 74 20 6d 65 73 73 61 67 65 73 20 64 65 73 63 72 | .to.proper.commit.messages.descr |
| 49c0 | 69 62 69 6e 67 20 79 6f 75 72 20 63 68 61 6e 67 65 20 28 68 6f 77 20 61 6e 64 20 77 68 79 29 2e | ibing.your.change.(how.and.why). |
| 49e0 | 20 50 6c 65 61 73 65 20 63 68 65 63 6b 20 6f 75 74 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 | .Please.check.out.the.documentat |
| 4a00 | 69 6f 6e 20 6f 66 20 53 70 68 69 6e 78 2d 64 6f 63 5f 20 6f 72 20 72 65 53 74 72 75 63 74 75 72 | ion.of.Sphinx-doc_.or.reStructur |
| 4a20 | 65 64 54 65 78 74 5f 20 69 66 20 79 6f 75 20 61 72 65 20 6e 6f 74 20 66 61 6d 69 6c 69 61 72 20 | edText_.if.you.are.not.familiar. |
| 4a40 | 77 69 74 68 20 69 74 2e 20 54 68 69 73 20 69 73 20 75 73 65 64 20 66 6f 72 20 77 72 69 74 69 6e | with.it..This.is.used.for.writin |
| 4a60 | 67 20 6f 75 72 20 64 6f 63 73 2e 20 41 64 64 69 74 69 6f 6e 61 6c 20 64 69 72 65 63 74 69 76 65 | g.our.docs..Additional.directive |
| 4a80 | 73 20 68 6f 77 20 74 6f 20 77 72 69 74 65 20 69 6e 20 52 53 54 20 63 61 6e 20 62 65 20 6f 62 74 | s.how.to.write.in.RST.can.be.obt |
| 4aa0 | 61 69 6e 65 64 20 66 72 6f 6d 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 44 69 72 65 63 | ained.from.reStructuredTextDirec |
| 4ac0 | 74 69 76 65 73 5f 2e 00 4d 75 6c 74 69 63 61 73 74 20 4d 41 43 2d 41 64 64 72 65 73 73 65 73 3a | tives_..Multicast.MAC-Addresses: |
| 4ae0 | 20 60 60 39 30 2d 31 30 2d 30 30 60 60 20 74 6f 20 60 60 39 30 2d 31 30 2d 46 46 60 60 00 4e 6f | .``90-10-00``.to.``90-10-FF``.No |
| 4b00 | 74 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 52 46 43 73 20 28 3a 72 66 63 3a 60 35 37 33 | te.the.following.RFCs.(:rfc:`573 |
| 4b20 | 37 60 2c 20 3a 72 66 63 3a 60 33 38 34 39 60 2c 20 3a 72 66 63 3a 60 35 33 38 39 60 20 61 6e 64 | 7`,.:rfc:`3849`,.:rfc:`5389`.and |
| 4b40 | 20 3a 72 66 63 3a 60 37 30 34 32 60 29 2c 20 77 68 69 63 68 20 64 65 73 63 72 69 62 65 20 74 68 | .:rfc:`7042`),.which.describe.th |
| 4b60 | 65 20 72 65 73 65 72 76 65 64 20 70 75 62 6c 69 63 20 49 50 20 61 64 64 72 65 73 73 65 73 20 61 | e.reserved.public.IP.addresses.a |
| 4b80 | 6e 64 20 61 75 74 6f 6e 6f 6d 6f 75 73 20 73 79 73 74 65 6d 20 6e 75 6d 62 65 72 73 20 66 6f 72 | nd.autonomous.system.numbers.for |
| 4ba0 | 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 3a 00 4f 6e 63 65 20 70 75 6c 6c 20 72 65 | .the.documentation:.Once.pull.re |
| 4bc0 | 71 75 65 73 74 73 20 68 61 76 65 20 62 65 65 6e 20 61 70 70 72 6f 76 65 64 2c 20 79 6f 75 20 6d | quests.have.been.approved,.you.m |
| 4be0 | 61 79 20 77 61 6e 74 20 74 6f 20 6c 6f 63 61 6c 6c 79 20 75 70 64 61 74 65 20 79 6f 75 72 20 66 | ay.want.to.locally.update.your.f |
| 4c00 | 6f 72 6b 65 64 20 72 65 70 6f 73 69 74 6f 72 79 20 74 6f 6f 2e 20 46 69 72 73 74 20 79 6f 75 27 | orked.repository.too..First.you' |
| 4c20 | 6c 6c 20 68 61 76 65 20 74 6f 20 61 64 64 20 61 20 73 65 63 6f 6e 64 20 72 65 6d 6f 74 65 20 63 | ll.have.to.add.a.second.remote.c |
| 4c40 | 61 6c 6c 65 64 20 60 75 70 73 74 72 65 61 6d 60 20 77 68 69 63 68 20 70 6f 69 6e 74 73 20 74 6f | alled.`upstream`.which.points.to |
| 4c60 | 20 6f 75 72 20 6d 61 69 6e 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 60 60 24 20 67 69 74 20 72 65 | .our.main.repository..``$.git.re |
| 4c80 | 6d 6f 74 65 20 61 64 64 20 75 70 73 74 72 65 61 6d 20 68 74 74 70 73 3a 2f 2f 67 69 74 68 75 62 | mote.add.upstream.https://github |
| 4ca0 | 2e 63 6f 6d 2f 76 79 6f 73 2f 76 79 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 67 69 74 | .com/vyos/vyos-documentation.git |
| 4cc0 | 60 60 00 4f 70 65 72 61 74 69 6f 6e 20 6d 6f 64 65 20 63 6f 6d 6d 61 6e 64 73 20 74 68 61 74 20 | ``.Operation.mode.commands.that. |
| 4ce0 | 64 6f 20 6e 6f 74 20 66 69 74 20 69 6e 20 61 20 72 65 6c 61 74 65 64 20 63 6f 6e 66 69 67 75 72 | do.not.fit.in.a.related.configur |
| 4d00 | 61 74 69 6f 6e 20 6d 6f 64 65 20 63 6f 6d 6d 61 6e 64 20 6d 75 73 74 20 62 65 20 64 6f 63 75 6d | ation.mode.command.must.be.docum |
| 4d20 | 65 6e 74 65 64 20 69 6e 20 74 68 69 73 20 70 61 72 74 20 6f 66 20 74 68 65 20 64 6f 63 75 6d 65 | ented.in.this.part.of.the.docume |
| 4d40 | 6e 74 61 74 69 6f 6e 2e 00 4f 70 65 72 61 74 69 6f 6e 20 6d 6f 64 65 20 70 61 67 65 73 00 50 61 | ntation..Operation.mode.pages.Pa |
| 4d60 | 67 65 20 63 6f 6e 74 65 6e 74 00 50 6c 65 61 73 65 20 64 6f 20 6e 6f 74 20 75 73 65 20 6f 74 68 | ge.content.Please.do.not.use.oth |
| 4d80 | 65 72 20 70 75 62 6c 69 63 20 61 64 64 72 65 73 73 20 73 70 61 63 65 2e 00 50 72 61 63 74 69 63 | er.public.address.space..Practic |
| 4da0 | 61 6c 20 65 78 61 6d 70 6c 65 73 20 6f 66 20 74 68 65 20 73 65 72 76 69 63 65 20 6f 72 20 75 73 | al.examples.of.the.service.or.us |
| 4dc0 | 65 20 63 61 73 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2e 20 54 68 65 79 20 6d 75 73 74 20 | e.case.configuration..They.must. |
| 4de0 | 63 6f 6e 74 61 69 6e 20 74 6f 70 6f 6c 6f 67 79 20 6d 61 70 73 20 28 69 66 20 61 70 70 6c 69 63 | contain.topology.maps.(if.applic |
| 4e00 | 61 62 6c 65 29 20 61 6e 64 20 73 68 6f 72 74 20 64 65 73 63 72 69 70 74 69 6f 6e 73 2e 00 50 72 | able).and.short.descriptions..Pr |
| 4e20 | 6f 70 65 72 6c 79 20 71 75 6f 74 65 20 63 6f 6d 6d 61 6e 64 73 2c 20 66 69 6c 65 6e 61 6d 65 73 | operly.quote.commands,.filenames |
| 4e40 | 20 61 6e 64 20 62 72 69 65 66 20 63 6f 64 65 20 73 6e 69 70 70 65 74 73 20 77 69 74 68 20 64 6f | .and.brief.code.snippets.with.do |
| 4e60 | 75 62 6c 65 20 62 61 63 6b 74 69 63 6b 73 2e 00 50 75 73 68 20 63 6f 6d 6d 69 74 73 20 74 6f 20 | uble.backticks..Push.commits.to. |
| 4e80 | 79 6f 75 72 20 47 69 74 48 75 62 20 70 72 6f 6a 65 63 74 3a 20 60 60 24 20 67 69 74 20 70 75 73 | your.GitHub.project:.``$.git.pus |
| 4ea0 | 68 20 2d 75 20 6f 72 69 67 69 6e 20 3c 62 72 61 6e 63 68 2d 6e 61 6d 65 3e 60 60 00 52 65 6c 61 | h.-u.origin.<branch-name>``.Rela |
| 4ec0 | 74 65 64 20 6f 70 65 72 61 74 69 6f 6e 20 63 6f 6d 6d 61 6e 64 20 6d 75 73 74 20 62 65 20 64 6f | ted.operation.command.must.be.do |
| 4ee0 | 63 75 6d 65 6e 74 65 64 20 69 6e 20 74 68 65 20 6e 65 78 74 20 70 61 72 74 20 6f 66 20 74 68 65 | cumented.in.the.next.part.of.the |
| 4f00 | 20 61 72 74 69 63 6c 65 2e 20 55 73 65 20 60 60 3a 3a 6f 70 63 6d 64 2e 2e 60 60 20 66 6f 72 20 | .article..Use.``::opcmd..``.for. |
| 4f20 | 74 68 65 73 65 20 63 6f 6d 6d 61 6e 64 73 2e 00 53 6f 6d 65 74 69 6d 65 73 20 69 74 20 69 73 20 | these.commands..Sometimes.it.is. |
| 4f40 | 6e 65 63 65 73 73 61 72 79 20 74 6f 20 70 72 6f 76 69 64 65 20 72 65 61 6c 20 49 50 20 61 64 64 | necessary.to.provide.real.IP.add |
| 4f60 | 72 65 73 73 65 73 20 6c 69 6b 65 20 69 6e 20 74 68 65 20 3a 72 65 66 3a 60 65 78 61 6d 70 6c 65 | resses.like.in.the.:ref:`example |
| 4f80 | 73 60 2e 20 46 6f 72 20 74 68 69 73 2c 20 70 6c 65 61 73 65 20 75 73 65 20 74 68 65 20 73 70 68 | s`..For.this,.please.use.the.sph |
| 4fa0 | 69 6e 78 20 63 6f 6d 6d 65 6e 74 20 73 79 6e 74 61 78 20 60 60 2e 2e 20 73 74 6f 70 5f 76 79 6f | inx.comment.syntax.``...stop_vyo |
| 4fc0 | 73 6c 69 6e 74 65 72 60 60 20 74 6f 20 73 74 6f 70 20 74 68 65 20 6c 69 6e 74 65 72 20 61 6e 64 | slinter``.to.stop.the.linter.and |
| 4fe0 | 20 60 60 2e 2e 20 73 74 61 72 74 5f 76 79 6f 73 6c 69 6e 74 65 72 60 60 20 74 6f 20 73 74 61 72 | .``...start_vyoslinter``.to.star |
| 5000 | 74 2e 00 53 74 79 6c 65 20 47 75 69 64 65 00 53 75 62 6d 69 74 20 70 75 6c 6c 2d 72 65 71 75 65 | t..Style.Guide.Submit.pull-reque |
| 5020 | 73 74 2e 20 49 6e 20 47 69 74 48 75 62 20 76 69 73 69 74 20 74 68 65 20 6d 61 69 6e 20 72 65 70 | st..In.GitHub.visit.the.main.rep |
| 5040 | 6f 73 69 74 6f 72 79 20 61 6e 64 20 79 6f 75 20 73 68 6f 75 6c 64 20 73 65 65 20 61 20 62 61 6e | ository.and.you.should.see.a.ban |
| 5060 | 6e 65 72 20 73 75 67 67 65 73 74 69 6e 67 20 74 6f 20 6d 61 6b 65 20 61 20 70 75 6c 6c 20 72 65 | ner.suggesting.to.make.a.pull.re |
| 5080 | 71 75 65 73 74 2e 20 46 69 6c 6c 20 6f 75 74 20 74 68 65 20 66 6f 72 6d 20 61 6e 64 20 64 65 73 | quest..Fill.out.the.form.and.des |
| 50a0 | 63 72 69 62 65 20 77 68 61 74 20 79 6f 75 20 64 6f 2e 00 54 4f 43 20 4c 65 76 65 6c 00 54 61 6b | cribe.what.you.do..TOC.Level.Tak |
| 50c0 | 65 20 61 20 6c 6f 6f 6b 20 61 74 20 74 68 65 20 3a 64 6f 63 3a 60 2f 64 6f 63 75 6d 65 6e 74 61 | e.a.look.at.the.:doc:`/documenta |
| 50e0 | 74 69 6f 6e 60 20 70 61 67 65 20 66 6f 72 20 61 6e 20 69 6e 74 72 69 63 61 74 65 20 65 78 70 6c | tion`.page.for.an.intricate.expl |
| 5100 | 61 6e 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 70 72 6f | anation.of.the.documentation.pro |
| 5120 | 63 65 73 73 2e 00 54 68 65 20 46 6f 72 6b 69 6e 67 20 57 6f 72 6b 66 6c 6f 77 20 69 73 20 66 75 | cess..The.Forking.Workflow.is.fu |
| 5140 | 6e 64 61 6d 65 6e 74 61 6c 6c 79 20 64 69 66 66 65 72 65 6e 74 20 66 72 6f 6d 20 6f 74 68 65 72 | ndamentally.different.from.other |
| 5160 | 20 70 6f 70 75 6c 61 72 20 47 69 74 20 77 6f 72 6b 66 6c 6f 77 73 2e 20 49 6e 73 74 65 61 64 20 | .popular.Git.workflows..Instead. |
| 5180 | 6f 66 20 75 73 69 6e 67 20 61 20 73 69 6e 67 6c 65 20 73 65 72 76 65 72 2d 73 69 64 65 20 72 65 | of.using.a.single.server-side.re |
| 51a0 | 70 6f 73 69 74 6f 72 79 20 74 6f 20 61 63 74 20 61 73 20 74 68 65 20 22 63 65 6e 74 72 61 6c 22 | pository.to.act.as.the."central" |
| 51c0 | 20 63 6f 64 65 62 61 73 65 2c 20 69 74 20 67 69 76 65 73 20 65 76 65 72 79 20 64 65 76 65 6c 6f | .codebase,.it.gives.every.develo |
| 51e0 | 70 65 72 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 6f 73 69 | per.their.own.server-side.reposi |
| 5200 | 74 6f 72 79 2e 20 54 68 69 73 20 6d 65 61 6e 73 20 74 68 61 74 20 65 61 63 68 20 63 6f 6e 74 72 | tory..This.means.that.each.contr |
| 5220 | 69 62 75 74 6f 72 20 68 61 73 20 6e 6f 74 20 6f 6e 65 2c 20 62 75 74 20 74 77 6f 20 47 69 74 20 | ibutor.has.not.one,.but.two.Git. |
| 5240 | 72 65 70 6f 73 69 74 6f 72 69 65 73 3a 20 61 20 70 72 69 76 61 74 65 20 6c 6f 63 61 6c 20 6f 6e | repositories:.a.private.local.on |
| 5260 | 65 20 61 6e 64 20 61 20 70 75 62 6c 69 63 20 73 65 72 76 65 72 2d 73 69 64 65 20 6f 6e 65 2e 00 | e.and.a.public.server-side.one.. |
| 5280 | 54 68 65 20 61 72 74 69 63 6c 65 20 73 74 61 72 74 73 20 77 69 74 68 20 61 20 73 68 6f 72 74 20 | The.article.starts.with.a.short. |
| 52a0 | 69 6e 74 72 6f 64 75 63 74 69 6f 6e 20 61 62 6f 75 74 20 74 68 65 20 63 6f 6d 6d 61 6e 64 20 6f | introduction.about.the.command.o |
| 52c0 | 72 20 74 68 65 20 74 65 63 68 6e 6f 6c 6f 67 79 2e 20 50 6c 65 61 73 65 20 69 6e 63 6c 75 64 65 | r.the.technology..Please.include |
| 52e0 | 20 73 6f 6d 65 20 68 65 6c 70 66 75 6c 20 6c 69 6e 6b 73 20 6f 72 20 62 61 63 6b 67 72 6f 75 6e | .some.helpful.links.or.backgroun |
| 5300 | 64 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 00 54 68 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e | d.information..The.configuration |
| 5320 | 20 6d 6f 64 65 20 66 6f 6c 64 65 72 20 61 6e 64 20 74 68 65 20 61 72 74 69 63 6c 65 73 20 63 6f | .mode.folder.and.the.articles.co |
| 5340 | 76 65 72 20 74 68 65 20 73 70 65 63 69 66 69 63 20 6c 65 76 65 6c 20 6f 66 20 74 68 65 20 63 6f | ver.the.specific.level.of.the.co |
| 5360 | 6d 6d 61 6e 64 73 2e 20 54 68 65 20 65 78 61 63 74 20 6c 65 76 65 6c 20 64 65 70 65 6e 64 73 20 | mmands..The.exact.level.depends. |
| 5380 | 6f 6e 20 74 68 65 20 63 6f 6d 6d 61 6e 64 2e 20 54 68 69 73 20 73 68 6f 75 6c 64 20 70 72 6f 76 | on.the.command..This.should.prov |
| 53a0 | 69 64 65 20 73 74 61 62 69 6c 69 74 79 20 66 6f 72 20 55 52 4c 73 20 75 73 65 64 20 69 6e 20 74 | ide.stability.for.URLs.used.in.t |
| 53c0 | 68 65 20 66 6f 72 75 6d 20 6f 72 20 62 6c 6f 67 70 6f 73 74 2e 00 54 68 65 20 64 6f 63 75 6d 65 | he.forum.or.blogpost..The.docume |
| 53e0 | 6e 74 61 74 69 6f 6e 20 68 61 73 20 33 20 64 69 66 66 65 72 65 6e 74 20 74 79 70 65 73 20 6f 66 | ntation.has.3.different.types.of |
| 5400 | 20 70 61 67 65 73 2e 20 54 68 65 20 73 61 6d 65 20 6b 69 6e 64 20 6f 66 20 70 61 67 65 73 20 6d | .pages..The.same.kind.of.pages.m |
| 5420 | 75 73 74 20 68 61 76 65 20 74 68 65 20 73 61 6d 65 20 73 74 72 75 63 74 75 72 65 20 74 6f 20 61 | ust.have.the.same.structure.to.a |
| 5440 | 63 68 69 65 76 65 20 61 20 72 65 63 6f 67 6e 69 74 69 6f 6e 20 66 61 63 74 6f 72 2e 00 54 68 65 | chieve.a.recognition.factor..The |
| 5460 | 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 73 6f 75 72 63 65 20 69 73 20 6b 65 70 74 20 69 6e | .documentation.source.is.kept.in |
| 5480 | 20 74 68 65 20 47 69 74 20 72 65 70 6f 73 69 74 6f 72 79 20 61 74 20 68 74 74 70 73 3a 2f 2f 67 | .the.Git.repository.at.https://g |
| 54a0 | 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 69 6f | ithub.com/vyos/vyos-documentatio |
| 54c0 | 6e 20 61 6e 64 20 79 6f 75 20 63 61 6e 20 66 6f 6c 6c 6f 77 20 74 68 65 20 69 6e 73 74 72 75 63 | n.and.you.can.follow.the.instruc |
| 54e0 | 74 69 6f 6e 73 20 69 6e 20 74 68 65 20 52 45 41 44 4d 45 2e 6d 64 5f 20 74 6f 20 62 75 69 6c 64 | tions.in.the.README.md_.to.build |
| 5500 | 20 61 6e 64 20 74 65 73 74 20 79 6f 75 72 20 63 68 61 6e 67 65 73 2e 00 54 68 65 20 66 6f 6c 6c | .and.test.your.changes..The.foll |
| 5520 | 6f 77 69 6e 67 20 69 73 20 61 20 71 75 69 63 6b 20 73 75 6d 6d 61 72 79 20 6f 66 20 74 68 65 20 | owing.is.a.quick.summary.of.the. |
| 5540 | 72 75 6c 65 73 3a 00 54 68 65 20 6d 61 69 6e 20 61 64 76 61 6e 74 61 67 65 20 6f 66 20 74 68 65 | rules:.The.main.advantage.of.the |
| 5560 | 20 46 6f 72 6b 69 6e 67 20 57 6f 72 6b 66 6c 6f 77 20 69 73 20 74 68 61 74 20 63 6f 6e 74 72 69 | .Forking.Workflow.is.that.contri |
| 5580 | 62 75 74 69 6f 6e 73 20 63 61 6e 20 62 65 20 69 6e 74 65 67 72 61 74 65 64 20 77 69 74 68 6f 75 | butions.can.be.integrated.withou |
| 55a0 | 74 20 74 68 65 20 6e 65 65 64 20 66 6f 72 20 65 76 65 72 79 62 6f 64 79 20 74 6f 20 70 75 73 68 | t.the.need.for.everybody.to.push |
| 55c0 | 20 74 6f 20 61 20 73 69 6e 67 6c 65 20 63 65 6e 74 72 61 6c 20 72 65 70 6f 73 69 74 6f 72 79 2e | .to.a.single.central.repository. |
| 55e0 | 20 44 65 76 65 6c 6f 70 65 72 73 20 70 75 73 68 20 74 6f 20 74 68 65 69 72 20 6f 77 6e 20 73 65 | .Developers.push.to.their.own.se |
| 5600 | 72 76 65 72 2d 73 69 64 65 20 72 65 70 6f 73 69 74 6f 72 69 65 73 2c 20 61 6e 64 20 6f 6e 6c 79 | rver-side.repositories,.and.only |
| 5620 | 20 74 68 65 20 70 72 6f 6a 65 63 74 20 6d 61 69 6e 74 61 69 6e 65 72 20 63 61 6e 20 70 75 73 68 | .the.project.maintainer.can.push |
| 5640 | 20 74 6f 20 74 68 65 20 6f 66 66 69 63 69 61 6c 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 54 68 69 | .to.the.official.repository..Thi |
| 5660 | 73 20 61 6c 6c 6f 77 73 20 74 68 65 20 6d 61 69 6e 74 61 69 6e 65 72 20 74 6f 20 61 63 63 65 70 | s.allows.the.maintainer.to.accep |
| 5680 | 74 20 63 6f 6d 6d 69 74 73 20 66 72 6f 6d 20 61 6e 79 20 64 65 76 65 6c 6f 70 65 72 20 77 69 74 | t.commits.from.any.developer.wit |
| 56a0 | 68 6f 75 74 20 67 69 76 69 6e 67 20 74 68 65 6d 20 77 72 69 74 65 20 61 63 63 65 73 73 20 74 6f | hout.giving.them.write.access.to |
| 56c0 | 20 74 68 65 20 6f 66 66 69 63 69 61 6c 20 63 6f 64 65 62 61 73 65 2e 00 54 68 65 20 70 6c 75 67 | .the.official.codebase..The.plug |
| 56e0 | 69 6e 20 77 69 6c 6c 20 77 61 72 6e 20 6f 6e 20 62 75 69 6c 64 20 69 66 20 61 20 68 65 61 64 6c | in.will.warn.on.build.if.a.headl |
| 5700 | 69 6e 65 20 68 61 73 20 61 20 64 75 70 6c 69 63 61 74 65 20 6e 61 6d 65 20 69 6e 20 74 68 65 20 | ine.has.a.duplicate.name.in.the. |
| 5720 | 73 61 6d 65 20 64 6f 63 75 6d 65 6e 74 2e 20 54 6f 20 70 72 65 76 65 6e 74 20 74 68 69 73 20 77 | same.document..To.prevent.this.w |
| 5740 | 61 72 6e 69 6e 67 2c 20 79 6f 75 20 68 61 76 65 20 74 6f 20 70 75 74 20 61 20 63 75 73 74 6f 6d | arning,.you.have.to.put.a.custom |
| 5760 | 20 6c 69 6e 6b 20 6f 6e 20 74 6f 70 20 6f 66 20 74 68 65 20 68 65 61 64 6c 69 6e 65 2e 00 54 68 | .link.on.top.of.the.headline..Th |
| 5780 | 65 6f 72 65 74 69 63 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 72 65 71 75 69 72 65 64 20 66 | eoretical.information.required.f |
| 57a0 | 6f 72 20 75 73 65 72 73 20 74 6f 20 75 6e 64 65 72 73 74 61 6e 64 20 74 68 65 20 6e 65 78 74 20 | or.users.to.understand.the.next. |
| 57c0 | 64 6f 63 75 6d 65 6e 74 20 73 65 63 74 69 6f 6e 73 3a 00 54 68 65 72 65 20 61 72 65 20 61 20 66 | document.sections:.There.are.a.f |
| 57e0 | 65 77 20 74 68 69 6e 67 73 20 74 6f 20 6b 65 65 70 20 69 6e 20 6d 69 6e 64 20 77 68 65 6e 20 63 | ew.things.to.keep.in.mind.when.c |
| 5800 | 6f 6e 74 72 69 62 75 74 69 6e 67 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e | ontributing.to.the.documentation |
| 5820 | 2c 20 66 6f 72 20 74 68 65 20 73 61 6b 65 20 6f 66 20 63 6f 6e 73 69 73 74 65 6e 63 79 20 61 6e | ,.for.the.sake.of.consistency.an |
| 5840 | 64 20 72 65 61 64 61 62 69 6c 69 74 79 2e 00 54 68 69 73 20 73 65 63 74 69 6f 6e 20 6d 75 73 74 | d.readability..This.section.must |
| 5860 | 20 63 6f 6e 74 61 69 6e 20 61 20 6c 69 73 74 20 6f 66 3a 00 54 6f 20 65 78 74 72 61 63 74 20 61 | .contain.a.list.of:.To.extract.a |
| 5880 | 20 64 65 66 61 75 6c 74 76 61 6c 75 65 20 66 72 6f 6d 20 74 68 65 20 58 4d 4c 20 64 65 66 69 6e | .defaultvalue.from.the.XML.defin |
| 58a0 | 69 74 69 6f 6e 73 20 61 64 64 20 61 20 60 60 3a 64 65 66 61 75 6c 74 76 61 6c 75 65 3a 60 60 20 | itions.add.a.``:defaultvalue:``. |
| 58c0 | 74 6f 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 2e 20 54 6f | to.``...cfgcmd::``.directive..To |
| 58e0 | 20 68 61 76 65 20 74 68 69 73 20 66 65 61 74 75 72 65 20 6c 6f 63 61 6c 6c 79 2c 20 74 68 65 20 | .have.this.feature.locally,.the. |
| 5900 | 76 79 6f 73 2d 31 78 20 73 75 62 6d 6f 64 75 6c 65 20 6d 75 73 74 20 62 65 20 69 6e 69 74 69 61 | vyos-1x.submodule.must.be.initia |
| 5920 | 6c 69 7a 65 64 20 62 65 66 6f 72 65 2e 20 50 6c 65 61 73 65 20 62 65 20 61 77 61 72 65 20 74 6f | lized.before..Please.be.aware.to |
| 5940 | 20 6e 6f 74 20 75 70 64 61 74 65 20 74 68 65 20 73 75 62 6d 6f 64 75 6c 65 20 69 6e 20 79 6f 75 | .not.update.the.submodule.in.you |
| 5960 | 72 20 50 52 2e 00 54 6f 20 6d 69 6e 69 6d 69 7a 65 20 72 65 64 75 6e 64 61 6e 63 79 2c 20 74 68 | r.PR..To.minimize.redundancy,.th |
| 5980 | 65 72 65 20 69 73 20 61 20 73 70 65 63 69 61 6c 20 69 6e 63 6c 75 64 65 20 64 69 72 65 63 74 69 | ere.is.a.special.include.directi |
| 59a0 | 76 65 2e 20 49 74 20 69 6e 63 6c 75 64 65 73 20 61 20 74 78 74 20 66 69 6c 65 20 61 6e 64 20 72 | ve..It.includes.a.txt.file.and.r |
| 59c0 | 65 70 6c 61 63 65 20 74 68 65 20 60 60 7b 7b 20 76 61 72 30 20 7d 7d 60 60 20 2d 20 60 60 7b 7b | eplace.the.``{{.var0.}}``.-.``{{ |
| 59e0 | 20 76 61 72 39 20 7d 7d 60 60 20 77 69 74 68 20 74 68 65 20 63 6f 72 72 65 63 74 20 76 61 6c 75 | .var9.}}``.with.the.correct.valu |
| 5a00 | 65 2e 00 54 72 79 20 6e 6f 74 20 74 6f 20 65 78 63 65 65 64 20 38 30 20 63 68 61 72 61 63 74 65 | e..Try.not.to.exceed.80.characte |
| 5a20 | 72 73 20 70 65 72 20 6c 69 6e 65 2c 20 62 75 74 20 64 6f 6e 27 74 20 62 72 65 61 6b 20 55 52 4c | rs.per.line,.but.don't.break.URL |
| 5a40 | 73 20 6f 76 65 72 20 74 68 69 73 2e 00 55 6e 69 63 61 73 74 20 4d 41 43 20 41 64 64 72 65 73 73 | s.over.this..Unicast.MAC.Address |
| 5a60 | 65 73 3a 20 60 60 30 30 2d 35 33 2d 30 30 60 60 20 74 6f 20 60 60 30 30 2d 35 33 2d 46 46 60 60 | es:.``00-53-00``.to.``00-53-FF`` |
| 5a80 | 00 55 70 64 61 74 65 73 20 74 6f 20 6f 75 72 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 73 68 | .Updates.to.our.documentation.sh |
| 5aa0 | 6f 75 6c 64 20 62 65 20 64 65 6c 69 76 65 72 65 64 20 62 79 20 61 20 47 69 74 48 75 62 20 70 75 | ould.be.delivered.by.a.GitHub.pu |
| 5ac0 | 6c 6c 2d 72 65 71 75 65 73 74 2e 20 54 68 69 73 20 72 65 71 75 69 72 65 73 20 79 6f 75 20 61 6c | ll-request..This.requires.you.al |
| 5ae0 | 72 65 61 64 79 20 68 61 76 65 20 61 20 47 69 74 48 75 62 20 61 63 63 6f 75 6e 74 2e 00 55 73 65 | ready.have.a.GitHub.account..Use |
| 5b00 | 20 41 6d 65 72 69 63 61 6e 20 45 6e 67 6c 69 73 68 20 61 74 20 61 6c 6c 20 74 69 6d 65 73 2e 20 | .American.English.at.all.times.. |
| 5b20 | 49 74 27 73 20 61 6c 77 61 79 73 20 61 20 67 6f 6f 64 20 69 64 65 61 20 74 6f 20 72 75 6e 20 79 | It's.always.a.good.idea.to.run.y |
| 5b40 | 6f 75 72 20 74 65 78 74 20 74 68 72 6f 75 67 68 20 61 20 67 72 61 6d 6d 61 72 20 61 6e 64 20 73 | our.text.through.a.grammar.and.s |
| 5b60 | 70 65 6c 6c 20 63 68 65 63 6b 65 72 2c 20 73 75 63 68 20 61 73 20 60 47 72 61 6d 6d 61 72 6c 79 | pell.checker,.such.as.`Grammarly |
| 5b80 | 60 5f 2e 00 55 73 65 20 6c 69 74 65 72 61 6c 20 62 6c 6f 63 6b 73 20 66 6f 72 20 6c 6f 6e 67 65 | `_..Use.literal.blocks.for.longe |
| 5ba0 | 72 20 73 6e 69 70 70 65 74 73 2e 00 56 69 65 77 20 6d 6f 64 69 66 69 65 64 20 66 69 6c 65 73 20 | r.snippets..View.modified.files. |
| 5bc0 | 62 79 20 63 61 6c 6c 69 6e 67 20 60 60 24 20 67 69 74 20 73 74 61 74 75 73 60 60 2e 20 59 6f 75 | by.calling.``$.git.status``..You |
| 5be0 | 20 77 69 6c 6c 20 67 65 74 20 61 6e 20 6f 76 65 72 76 69 65 77 20 6f 66 20 61 6c 6c 20 66 69 6c | .will.get.an.overview.of.all.fil |
| 5c00 | 65 73 20 6d 6f 64 69 66 69 65 64 20 62 79 20 79 6f 75 2e 20 59 6f 75 20 63 61 6e 20 61 64 64 20 | es.modified.by.you..You.can.add. |
| 5c20 | 69 6e 64 69 76 69 64 75 61 6c 20 66 69 6c 65 73 20 74 6f 20 74 68 65 20 47 69 74 20 49 6e 64 65 | individual.files.to.the.Git.Inde |
| 5c40 | 78 20 69 6e 20 74 68 65 20 6e 65 78 74 20 73 74 65 70 2e 00 56 79 4f 53 20 64 6f 63 75 6d 65 6e | x.in.the.next.step..VyOS.documen |
| 5c60 | 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 72 65 | tation.is.written.in.reStructure |
| 5c80 | 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 65 20 | dText.and.generated.to.Read.the. |
| 5ca0 | 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 20 74 | Docs.pages.with.Sphinx,.as.per.t |
| 5cc0 | 68 65 20 50 79 74 68 6f 6e 20 74 72 61 64 69 74 69 6f 6e 2c 20 61 73 20 77 65 6c 6c 20 61 73 20 | he.Python.tradition,.as.well.as. |
| 5ce0 | 50 44 46 20 66 69 6c 65 73 20 66 6f 72 20 6f 66 66 6c 69 6e 65 20 75 73 65 20 74 68 72 6f 75 67 | PDF.files.for.offline.use.throug |
| 5d00 | 68 20 4c 61 54 65 58 2e 20 57 65 20 77 65 6c 63 6f 6d 65 20 61 6c 6c 20 73 6f 72 74 73 20 6f 66 | h.LaTeX..We.welcome.all.sorts.of |
| 5d20 | 20 63 6f 6e 74 72 69 62 75 74 69 6f 6e 73 20 74 6f 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 | .contributions.to.the.documentat |
| 5d40 | 69 6f 6e 2e 20 4e 6f 74 20 6a 75 73 74 20 6e 65 77 20 61 64 64 69 74 69 6f 6e 73 20 62 75 74 20 | ion..Not.just.new.additions.but. |
| 5d60 | 61 6c 73 6f 20 63 6f 72 72 65 63 74 69 6f 6e 73 20 74 6f 20 65 78 69 73 74 69 6e 67 20 64 6f 63 | also.corrections.to.existing.doc |
| 5d80 | 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 56 79 4f 53 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 69 | umentation..VyOS.documentation.i |
| 5da0 | 73 20 77 72 69 74 74 65 6e 20 69 6e 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 20 61 6e | s.written.in.reStructuredText.an |
| 5dc0 | 64 20 67 65 6e 65 72 61 74 65 64 20 74 6f 20 52 65 61 64 20 74 68 65 20 44 6f 63 73 20 70 61 67 | d.generated.to.Read.the.Docs.pag |
| 5de0 | 65 73 20 77 69 74 68 20 53 70 68 69 6e 78 2c 20 61 73 20 70 65 72 20 74 68 65 20 50 79 74 68 6f | es.with.Sphinx,.as.per.the.Pytho |
| 5e00 | 6e 20 74 72 61 64 69 74 69 6f 6e 2e 20 57 65 20 77 65 6c 63 6f 6d 65 20 61 6c 6c 20 73 6f 72 74 | n.tradition..We.welcome.all.sort |
| 5e20 | 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 64 6f 63 75 6d 65 | s.of.contributions.to.the.docume |
| 5e40 | 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 74 69 6f 6e 73 20 | ntation..Not.just.new.additions. |
| 5e60 | 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 69 73 74 69 6e 67 | but.also.corrections.to.existing |
| 5e80 | 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 57 65 20 65 6e 63 6f 75 72 61 67 65 20 65 76 65 | .documentation..We.encourage.eve |
| 5ea0 | 72 79 20 56 79 4f 53 20 75 73 65 72 20 74 6f 20 68 65 6c 70 20 75 73 20 69 6d 70 72 6f 76 65 20 | ry.VyOS.user.to.help.us.improve. |
| 5ec0 | 6f 75 72 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 61 73 20 77 65 20 68 61 76 65 20 61 20 64 | our.documentation.as.we.have.a.d |
| 5ee0 | 65 66 69 63 69 74 20 6c 69 6b 65 20 6d 6f 73 74 20 73 6f 66 74 77 61 72 65 20 70 72 6f 6a 65 63 | eficit.like.most.software.projec |
| 5f00 | 74 73 2e 20 20 54 68 69 73 20 6e 6f 74 20 6f 6e 6c 79 20 68 65 6c 70 73 20 79 6f 75 20 77 68 65 | ts...This.not.only.helps.you.whe |
| 5f20 | 6e 20 72 65 61 64 69 6e 67 20 62 75 74 20 61 6c 73 6f 20 65 76 65 72 79 6f 6e 65 20 65 6c 73 65 | n.reading.but.also.everyone.else |
| 5f40 | 2e 00 57 65 20 75 73 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 73 79 6e 74 61 78 20 66 6f | ..We.use.the.following.syntax.fo |
| 5f60 | 72 20 48 65 61 64 6c 69 6e 65 73 2e 00 57 68 65 6e 20 64 6f 63 75 6d 65 6e 74 69 6e 67 20 43 4c | r.Headlines..When.documenting.CL |
| 5f80 | 49 20 63 6f 6d 6d 61 6e 64 73 2c 20 75 73 65 20 74 68 65 20 60 60 2e 2e 20 63 66 67 63 6d 64 3a | I.commands,.use.the.``...cfgcmd: |
| 5fa0 | 3a 60 60 20 64 69 72 65 63 74 69 76 65 20 66 6f 72 20 61 6c 6c 20 63 6f 6e 66 69 67 75 72 61 74 | :``.directive.for.all.configurat |
| 5fc0 | 69 6f 6e 20 6d 6f 64 65 20 63 6f 6d 6d 61 6e 64 73 2e 20 41 6e 20 65 78 70 6c 61 6e 61 74 69 6f | ion.mode.commands..An.explanatio |
| 5fe0 | 6e 20 6f 66 20 74 68 65 20 64 65 73 63 72 69 62 65 64 20 63 6f 6d 6d 61 6e 64 20 73 68 6f 75 6c | n.of.the.described.command.shoul |
| 6000 | 64 20 62 65 20 61 64 64 65 64 20 62 65 6c 6f 77 20 74 68 69 73 20 73 74 61 74 65 6d 65 6e 74 2e | d.be.added.below.this.statement. |
| 6020 | 20 52 65 70 6c 61 63 65 20 61 6c 6c 20 76 61 72 69 61 62 6c 65 20 63 6f 6e 74 65 6e 74 73 20 77 | .Replace.all.variable.contents.w |
| 6040 | 69 74 68 20 3c 76 61 6c 75 65 3e 20 6f 72 20 73 6f 6d 65 74 68 69 6e 67 20 73 69 6d 69 6c 61 72 | ith.<value>.or.something.similar |
| 6060 | 2e 00 57 68 65 6e 20 64 6f 63 75 6d 65 6e 74 69 6e 67 20 6f 70 65 72 61 74 69 6f 6e 61 6c 20 6c | ..When.documenting.operational.l |
| 6080 | 65 76 65 6c 20 63 6f 6d 6d 61 6e 64 73 2c 20 75 73 65 20 74 68 65 20 60 60 2e 2e 20 6f 70 63 6d | evel.commands,.use.the.``...opcm |
| 60a0 | 64 3a 3a 60 60 20 64 69 72 65 63 74 69 76 65 2e 20 41 6e 20 65 78 70 6c 61 6e 61 74 69 6f 6e 20 | d::``.directive..An.explanation. |
| 60c0 | 6f 66 20 74 68 65 20 64 65 73 63 72 69 62 65 64 20 63 6f 6d 6d 61 6e 64 20 73 68 6f 75 6c 64 20 | of.the.described.command.should. |
| 60e0 | 62 65 20 61 64 64 65 64 20 62 65 6c 6f 77 20 74 68 69 73 20 73 74 61 74 65 6d 65 6e 74 2e 00 57 | be.added.below.this.statement..W |
| 6100 | 68 65 6e 20 69 6e 20 64 6f 75 62 74 2c 20 66 6f 6c 6c 6f 77 20 74 68 65 20 73 74 79 6c 65 20 6f | hen.in.doubt,.follow.the.style.o |
| 6120 | 66 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 68 65 6e 20 72 | f.existing.documentation..When.r |
| 6140 | 65 66 65 72 65 6e 63 69 6e 67 20 74 6f 20 56 79 4f 53 20 50 68 61 62 72 69 63 61 74 6f 72 20 54 | eferencing.to.VyOS.Phabricator.T |
| 6160 | 61 73 6b 73 2c 20 74 68 65 72 65 20 69 73 20 61 20 63 75 73 74 6f 6d 20 53 70 68 69 6e 78 20 4d | asks,.there.is.a.custom.Sphinx.M |
| 6180 | 61 72 6b 75 70 20 63 6f 6d 6d 61 6e 64 20 63 61 6c 6c 65 64 20 60 60 76 79 74 61 73 6b 60 60 20 | arkup.command.called.``vytask``. |
| 61a0 | 74 68 61 74 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 65 6e 64 65 72 73 20 74 6f 20 61 20 | that.automatically.renders.to.a. |
| 61c0 | 70 72 6f 70 65 72 20 50 68 61 62 72 69 63 61 74 6f 72 20 55 52 4c 2e 20 54 68 69 73 20 69 73 20 | proper.Phabricator.URL..This.is. |
| 61e0 | 68 65 61 76 69 6c 79 20 75 73 65 64 20 69 6e 20 74 68 65 20 3a 72 65 66 3a 60 72 65 6c 65 61 73 | heavily.used.in.the.:ref:`releas |
| 6200 | 65 2d 6e 6f 74 65 73 60 20 73 65 63 74 69 6f 6e 2e 00 57 69 74 68 20 74 68 6f 73 65 20 63 75 73 | e-notes`.section..With.those.cus |
| 6220 | 74 6f 6d 20 63 6f 6d 6d 61 6e 64 73 2c 20 69 74 20 69 73 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 | tom.commands,.it.is.possible.to. |
| 6240 | 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 69 70 74 69 76 | render.them.in.a.more.descriptiv |
| 6260 | 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 2f 50 44 46 20 | e.way.in.the.resulting.HTML/PDF. |
| 6280 | 6d 61 6e 75 61 6c 2e 00 57 69 74 68 20 74 68 6f 73 65 20 63 75 73 74 6f 6d 20 63 6f 6d 6d 61 6e | manual..With.those.custom.comman |
| 62a0 | 64 73 2c 20 69 74 20 77 69 6c 6c 20 62 65 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 72 65 6e 64 65 | ds,.it.will.be.possible.to.rende |
| 62c0 | 72 20 74 68 65 6d 20 69 6e 20 61 20 6d 6f 72 65 20 64 65 73 63 72 69 70 74 69 76 65 20 77 61 79 | r.them.in.a.more.descriptive.way |
| 62e0 | 20 69 6e 20 74 68 65 20 72 65 73 75 6c 74 69 6e 67 20 48 54 4d 4c 2f 50 44 46 20 6d 61 6e 75 61 | .in.the.resulting.HTML/PDF.manua |
| 6300 | 6c 2e 00 57 72 69 74 65 20 44 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 00 59 6f 75 20 63 61 6e 20 65 | l..Write.Documentation.You.can.e |
| 6320 | 69 74 68 65 72 20 69 6e 73 74 61 6c 6c 20 53 70 68 69 6e 78 20 28 61 6e 64 20 54 65 58 20 4c 69 | ither.install.Sphinx.(and.TeX.Li |
| 6340 | 76 65 20 66 6f 72 20 50 44 46 20 6f 75 74 70 75 74 29 20 61 6e 64 20 62 75 69 6c 64 20 74 68 65 | ve.for.PDF.output).and.build.the |
| 6360 | 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 |
| 6380 | 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. |
| 63a0 | 63 6f 6e 74 61 69 6e 65 72 2e 00 59 6f 75 20 63 61 6e 20 65 69 74 68 65 72 20 69 6e 73 74 61 6c | container..You.can.either.instal |
| 63c0 | 6c 20 53 70 68 69 6e 78 20 61 6e 64 20 62 75 69 6c 64 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 | l.Sphinx.and.build.the.documenta |
| 63e0 | 74 69 6f 6e 20 6c 6f 63 61 6c 6c 79 2c 20 6f 72 20 75 73 65 20 74 68 65 20 44 6f 63 6b 65 72 66 | tion.locally,.or.use.the.Dockerf |
| 6400 | 69 6c 65 5f 20 74 6f 20 62 75 69 6c 64 20 69 74 20 69 6e 20 61 20 63 6f 6e 74 61 69 6e 65 72 2e | ile_.to.build.it.in.a.container. |
| 6420 | 00 59 6f 75 72 20 72 65 6d 6f 74 65 20 72 65 70 6f 20 6f 6e 20 47 69 74 68 75 62 20 69 73 20 63 | .Your.remote.repo.on.Github.is.c |
| 6440 | 61 6c 6c 65 64 20 60 60 6f 72 69 67 69 6e 60 60 2c 20 77 68 69 6c 65 20 74 68 65 20 6f 72 69 67 | alled.``origin``,.while.the.orig |
| 6460 | 69 6e 61 6c 20 72 65 70 6f 20 79 6f 75 20 68 61 76 65 20 66 6f 72 6b 65 64 20 69 73 20 63 61 6c | inal.repo.you.have.forked.is.cal |
| 6480 | 6c 65 64 20 60 60 75 70 73 74 72 65 61 6d 60 60 2e 20 4e 6f 77 20 79 6f 75 20 63 61 6e 20 6c 6f | led.``upstream``..Now.you.can.lo |
| 64a0 | 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 2e 00 60 | cally.update.your.forked.repo..` |
| 64c0 | 60 31 39 32 2e 30 2e 32 2e 30 2f 32 34 60 60 00 60 60 31 39 38 2e 35 31 2e 31 30 30 2e 30 2f 32 | `192.0.2.0/24``.``198.51.100.0/2 |
| 64e0 | 34 60 60 00 60 60 32 30 30 31 3a 64 62 38 3a 3a 2f 33 32 60 60 00 60 60 32 30 33 2e 30 2e 31 31 | 4``.``2001:db8::/32``.``203.0.11 |
| 6500 | 33 2e 30 2f 32 34 60 60 00 60 60 3a 72 65 66 3a 60 43 68 65 63 6b 20 6f 75 74 20 56 4c 41 4e 3c | 3.0/24``.``:ref:`Check.out.VLAN< |
| 6520 | 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 68 65 72 6e 65 | configuration/interfaces/etherne |
| 6540 | 74 3a 76 6c 61 6e 3e 60 60 00 60 60 3a 72 65 66 3a 60 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2f | t:vlan>``.``:ref:`configuration/ |
| 6560 | 69 6e 74 65 72 66 61 63 65 73 2f 65 74 68 65 72 6e 65 74 3a 76 6c 61 6e 60 60 00 60 60 73 65 74 | interfaces/ethernet:vlan``.``set |
| 6580 | 20 66 69 72 65 77 61 6c 6c 20 7a 6f 6e 65 60 60 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 60 | .firewall.zone``.is.written.in.` |
| 65a0 | 60 66 69 72 65 77 61 6c 6c 2f 7a 6f 6e 65 2e 72 73 74 60 60 00 60 60 73 65 74 20 69 6e 74 65 72 | `firewall/zone.rst``.``set.inter |
| 65c0 | 66 61 63 65 73 20 65 74 68 65 72 6e 65 74 60 60 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 60 | faces.ethernet``.is.written.in.` |
| 65e0 | 60 69 6e 74 65 72 66 61 63 65 73 2f 65 74 68 65 72 6e 65 74 2e 72 73 74 60 60 00 61 20 73 69 6d | `interfaces/ethernet.rst``.a.sim |
| 6600 | 70 6c 65 20 65 78 70 6c 61 6e 61 74 69 6f 6e 20 6f 66 20 77 68 61 74 20 69 73 20 74 68 69 73 20 | ple.explanation.of.what.is.this. |
| 6620 | 70 61 67 65 20 61 62 6f 75 74 2c 20 77 68 79 20 6f 72 20 77 68 65 6e 20 69 74 20 69 73 20 72 65 | page.about,.why.or.when.it.is.re |
| 6640 | 71 75 69 72 65 64 20 74 6f 20 62 65 20 75 73 65 64 00 63 66 67 63 6d 64 00 63 6d 64 69 6e 63 6c | quired.to.be.used.cfgcmd.cmdincl |
| 6660 | 75 64 65 00 68 61 6e 64 6c 65 20 62 75 69 6c 64 20 65 72 72 6f 72 73 00 68 6f 77 20 74 6f 20 63 | ude.handle.build.errors.how.to.c |
| 6680 | 6f 6c 6c 65 63 74 20 6c 6f 67 73 20 6f 72 20 6f 74 68 65 72 20 64 65 62 75 67 67 69 6e 67 20 69 | ollect.logs.or.other.debugging.i |
| 66a0 | 6e 66 6f 72 6d 61 74 69 6f 6e 20 28 6c 69 6b 65 20 60 73 68 6f 77 60 20 63 6f 6d 6d 61 6e 64 73 | nformation.(like.`show`.commands |
| 66c0 | 20 6f 75 74 70 75 74 29 00 68 6f 77 20 74 6f 20 72 65 61 64 20 61 6e 64 20 77 68 61 74 20 74 6f | .output).how.to.read.and.what.to |
| 66e0 | 20 73 65 61 72 63 68 20 66 6f 72 20 69 6e 20 6c 6f 67 73 20 61 6e 64 20 63 6f 6c 6c 65 63 74 65 | .search.for.in.logs.and.collecte |
| 6700 | 64 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 00 6b 6e 6f 77 6e 20 69 73 73 75 65 73 20 6f 72 20 70 6f | d.information.known.issues.or.po |
| 6720 | 74 65 6e 74 69 61 6c 20 70 72 6f 62 6c 65 6d 73 20 66 6f 72 20 74 68 65 20 73 65 72 76 69 63 65 | tential.problems.for.the.service |
| 6740 | 20 6f 72 20 75 73 65 20 63 61 73 65 00 6f 70 63 6d 64 00 72 65 66 65 72 65 6e 63 65 73 20 74 6f | .or.use.case.opcmd.references.to |
| 6760 | 20 73 74 61 6e 64 61 72 64 73 2c 20 52 46 43 73 00 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20 | .standards,.RFCs.the.content.of. |
| 6780 | 69 6e 74 65 72 66 61 63 65 2d 61 64 64 72 65 73 73 2e 74 78 74 20 6c 6f 6f 6b 73 20 6c 69 6b 65 | interface-address.txt.looks.like |
| 67a0 | 20 74 68 69 73 00 74 6f 20 75 73 65 20 61 6e 20 61 6c 74 65 72 6e 61 74 69 76 65 20 68 79 70 65 | .this.to.use.an.alternative.hype |
| 67c0 | 72 6c 69 6e 6b 20 75 73 65 20 69 74 20 74 68 69 73 20 77 61 79 3a 00 76 79 74 61 73 6b 00 77 68 | rlink.use.it.this.way:.vytask.wh |
| 67e0 | 61 74 20 61 72 65 20 69 6e 64 69 63 61 74 6f 72 73 20 6f 66 20 67 6f 6f 64 20 61 6e 64 20 62 61 | at.are.indicators.of.good.and.ba |
| 6800 | 64 20 73 74 61 74 65 73 20 69 6e 20 64 65 62 75 67 67 69 6e 67 20 6f 75 74 70 75 74 73 00 77 6f | d.states.in.debugging.outputs.wo |
| 6820 | 72 6b 61 72 6f 75 6e 64 73 20 66 6f 72 20 6b 6e 6f 77 6e 20 69 73 73 75 65 73 20 28 69 66 20 61 | rkarounds.for.known.issues.(if.a |
| 6840 | 6e 79 20 65 78 69 73 74 29 00 | ny.exist). |
 |
index : vyos-documentation.git | |
| VyOS readthedocs (mirror of https://github.com/marekm72/vyos-documentation.git) |
| summaryrefslogtreecommitdiff |
blob: 1ced609ef12159fc43bf6e0d5fb3f36b5f60d1e4 (plain)