ofs | hex dump | ascii |
---|
0000 | de 12 04 95 00 00 00 00 67 00 00 00 1c 00 00 00 54 03 00 00 89 00 00 00 8c 06 00 00 00 00 00 00 | ........g.......T............... |
0020 | b0 08 00 00 1c 00 00 00 b1 08 00 00 1c 00 00 00 ce 08 00 00 97 00 00 00 eb 08 00 00 b4 00 00 00 | ................................ |
0040 | 83 09 00 00 0d 00 00 00 38 0a 00 00 4a 00 00 00 46 0a 00 00 d4 00 00 00 91 0a 00 00 a6 00 00 00 | ........8...J...F............... |
0060 | 66 0b 00 00 0d 00 00 00 0d 0c 00 00 5e 00 00 00 1b 0c 00 00 0a 00 00 00 7a 0c 00 00 06 01 00 00 | f...........^...........z....... |
0080 | 85 0c 00 00 2a 00 00 00 8c 0d 00 00 56 00 00 00 b7 0d 00 00 01 01 00 00 0e 0e 00 00 18 00 00 00 | ....*.......V................... |
00a0 | 10 0f 00 00 6b 00 00 00 29 0f 00 00 10 00 00 00 95 0f 00 00 18 00 00 00 a6 0f 00 00 aa 00 00 00 | ....k...)....................... |
00c0 | bf 0f 00 00 3c 00 00 00 6a 10 00 00 5c 00 00 00 a7 10 00 00 7f 00 00 00 04 11 00 00 3b 00 00 00 | ....<...j...\...............;... |
00e0 | 84 11 00 00 38 00 00 00 c0 11 00 00 9e 00 00 00 f9 11 00 00 0c 00 00 00 98 12 00 00 4b 00 00 00 | ....8.......................K... |
0100 | a5 12 00 00 10 00 00 00 f1 12 00 00 1a 00 00 00 02 13 00 00 53 00 00 00 1d 13 00 00 0a 00 00 00 | ....................S........... |
0120 | 71 13 00 00 63 00 00 00 7c 13 00 00 5f 00 00 00 e0 13 00 00 5e 00 00 00 40 14 00 00 9d 00 00 00 | q...c...|..._.......^...@....... |
0140 | 9f 14 00 00 84 00 00 00 3d 15 00 00 17 00 00 00 c2 15 00 00 55 00 00 00 da 15 00 00 2a 00 00 00 | ........=...........U.......*... |
0160 | 30 16 00 00 2e 00 00 00 5b 16 00 00 0b 00 00 00 8a 16 00 00 90 01 00 00 96 16 00 00 35 00 00 00 | 0.......[...................5... |
0180 | 27 18 00 00 b5 00 00 00 5d 18 00 00 0e 01 00 00 13 19 00 00 85 00 00 00 22 1a 00 00 14 00 00 00 | '.......]..............."....... |
01a0 | a8 1a 00 00 0c 00 00 00 bd 1a 00 00 2d 00 00 00 ca 1a 00 00 51 00 00 00 f8 1a 00 00 4b 00 00 00 | ............-.......Q.......K... |
01c0 | 4a 1b 00 00 73 00 00 00 96 1b 00 00 d2 00 00 00 0a 1c 00 00 0b 00 00 00 dd 1c 00 00 a3 00 00 00 | J...s........................... |
01e0 | e9 1c 00 00 09 00 00 00 8d 1d 00 00 68 00 00 00 97 1d 00 00 59 01 00 00 00 1e 00 00 8e 00 00 00 | ............h.......Y........... |
0200 | 5a 1f 00 00 c6 00 00 00 e9 1f 00 00 86 00 00 00 b0 20 00 00 ba 00 00 00 37 21 00 00 2e 00 00 00 | Z.......................7!...... |
0220 | f2 21 00 00 90 01 00 00 21 22 00 00 a5 00 00 00 b2 23 00 00 7b 00 00 00 58 24 00 00 f1 00 00 00 | .!......!".......#..{...X$...... |
0240 | d4 24 00 00 9c 00 00 00 c6 25 00 00 49 00 00 00 63 26 00 00 33 00 00 00 ad 26 00 00 7b 00 00 00 | .$.......%..I...c&..3....&..{... |
0260 | e1 26 00 00 86 00 00 00 5d 27 00 00 27 00 00 00 e4 27 00 00 a7 00 00 00 0c 28 00 00 37 01 00 00 | .&......]'..'....'.......(..7... |
0280 | b4 28 00 00 b1 00 00 00 ec 29 00 00 2a 00 00 00 9e 2a 00 00 f4 00 00 00 c9 2a 00 00 9c 00 00 00 | .(.......)..*....*.......*...... |
02a0 | be 2b 00 00 3a 00 00 00 5b 2c 00 00 d7 00 00 00 96 2c 00 00 75 00 00 00 6e 2d 00 00 7a 00 00 00 | .+..:...[,.......,..u...n-..z... |
02c0 | e4 2d 00 00 13 00 00 00 5f 2e 00 00 93 00 00 00 73 2e 00 00 9d 00 00 00 07 2f 00 00 10 00 00 00 | .-......_.......s......../...... |
02e0 | a5 2f 00 00 13 00 00 00 b6 2f 00 00 11 00 00 00 ca 2f 00 00 12 00 00 00 dc 2f 00 00 40 00 00 00 | ./......./......./......./..@... |
0300 | ef 2f 00 00 30 00 00 00 30 30 00 00 39 00 00 00 61 30 00 00 45 00 00 00 9b 30 00 00 06 00 00 00 | ./..0...00..9...a0..E....0...... |
0320 | e1 30 00 00 0a 00 00 00 e8 30 00 00 13 00 00 00 f3 30 00 00 05 00 00 00 07 31 00 00 34 00 00 00 | .0.......0.......0.......1..4... |
0340 | 0d 31 00 00 30 00 00 00 42 31 00 00 06 00 00 00 73 31 00 00 e2 00 00 00 7a 31 00 00 1c 00 00 00 | .1..0...B1......s1......z1...... |
0360 | 5d 32 00 00 1c 00 00 00 7a 32 00 00 97 00 00 00 97 32 00 00 b4 00 00 00 2f 33 00 00 0d 00 00 00 | ]2......z2.......2....../3...... |
0380 | e4 33 00 00 4a 00 00 00 f2 33 00 00 d4 00 00 00 3d 34 00 00 a6 00 00 00 12 35 00 00 0d 00 00 00 | .3..J....3......=4.......5...... |
03a0 | b9 35 00 00 5e 00 00 00 c7 35 00 00 0a 00 00 00 26 36 00 00 06 01 00 00 31 36 00 00 2a 00 00 00 | .5..^....5......&6......16..*... |
03c0 | 38 37 00 00 56 00 00 00 63 37 00 00 01 01 00 00 ba 37 00 00 18 00 00 00 bc 38 00 00 6b 00 00 00 | 87..V...c7.......7.......8..k... |
03e0 | d5 38 00 00 10 00 00 00 41 39 00 00 18 00 00 00 52 39 00 00 aa 00 00 00 6b 39 00 00 3c 00 00 00 | .8......A9......R9......k9..<... |
0400 | 16 3a 00 00 5c 00 00 00 53 3a 00 00 7f 00 00 00 b0 3a 00 00 3b 00 00 00 30 3b 00 00 38 00 00 00 | .:..\...S:.......:..;...0;..8... |
0420 | 6c 3b 00 00 9e 00 00 00 a5 3b 00 00 0c 00 00 00 44 3c 00 00 4b 00 00 00 51 3c 00 00 10 00 00 00 | l;.......;......D<..K...Q<...... |
0440 | 9d 3c 00 00 1a 00 00 00 ae 3c 00 00 53 00 00 00 c9 3c 00 00 0a 00 00 00 1d 3d 00 00 63 00 00 00 | .<.......<..S....<.......=..c... |
0460 | 28 3d 00 00 5f 00 00 00 8c 3d 00 00 5e 00 00 00 ec 3d 00 00 9d 00 00 00 4b 3e 00 00 84 00 00 00 | (=.._....=..^....=......K>...... |
0480 | e9 3e 00 00 17 00 00 00 6e 3f 00 00 55 00 00 00 86 3f 00 00 2a 00 00 00 dc 3f 00 00 2e 00 00 00 | .>......n?..U....?..*....?...... |
04a0 | 07 40 00 00 0b 00 00 00 36 40 00 00 90 01 00 00 42 40 00 00 35 00 00 00 d3 41 00 00 b5 00 00 00 | .@......6@......B@..5....A...... |
04c0 | 09 42 00 00 0e 01 00 00 bf 42 00 00 85 00 00 00 ce 43 00 00 14 00 00 00 54 44 00 00 0c 00 00 00 | .B.......B.......C......TD...... |
04e0 | 69 44 00 00 2d 00 00 00 76 44 00 00 51 00 00 00 a4 44 00 00 4b 00 00 00 f6 44 00 00 73 00 00 00 | iD..-...vD..Q....D..K....D..s... |
0500 | 42 45 00 00 d2 00 00 00 b6 45 00 00 0b 00 00 00 89 46 00 00 a3 00 00 00 95 46 00 00 09 00 00 00 | BE.......E.......F.......F...... |
0520 | 39 47 00 00 68 00 00 00 43 47 00 00 59 01 00 00 ac 47 00 00 8e 00 00 00 06 49 00 00 c6 00 00 00 | 9G..h...CG..Y....G.......I...... |
0540 | 95 49 00 00 86 00 00 00 5c 4a 00 00 ba 00 00 00 e3 4a 00 00 2e 00 00 00 9e 4b 00 00 90 01 00 00 | .I......\J.......J.......K...... |
0560 | cd 4b 00 00 a5 00 00 00 5e 4d 00 00 7b 00 00 00 04 4e 00 00 f1 00 00 00 80 4e 00 00 9c 00 00 00 | .K......^M..{....N.......N...... |
0580 | 72 4f 00 00 49 00 00 00 0f 50 00 00 33 00 00 00 59 50 00 00 7b 00 00 00 8d 50 00 00 86 00 00 00 | rO..I....P..3...YP..{....P...... |
05a0 | 09 51 00 00 27 00 00 00 90 51 00 00 a7 00 00 00 b8 51 00 00 37 01 00 00 60 52 00 00 b1 00 00 00 | .Q..'....Q.......Q..7...`R...... |
05c0 | 98 53 00 00 2a 00 00 00 4a 54 00 00 f4 00 00 00 75 54 00 00 9c 00 00 00 6a 55 00 00 3a 00 00 00 | .S..*...JT......uT......jU..:... |
05e0 | 07 56 00 00 d7 00 00 00 42 56 00 00 75 00 00 00 1a 57 00 00 7a 00 00 00 90 57 00 00 13 00 00 00 | .V......BV..u....W..z....W...... |
0600 | 0b 58 00 00 93 00 00 00 1f 58 00 00 9d 00 00 00 b3 58 00 00 10 00 00 00 51 59 00 00 13 00 00 00 | .X.......X.......X......QY...... |
0620 | 62 59 00 00 11 00 00 00 76 59 00 00 12 00 00 00 88 59 00 00 40 00 00 00 9b 59 00 00 30 00 00 00 | bY......vY.......Y..@....Y..0... |
0640 | dc 59 00 00 39 00 00 00 0d 5a 00 00 45 00 00 00 47 5a 00 00 06 00 00 00 8d 5a 00 00 0a 00 00 00 | .Y..9....Z..E...GZ.......Z...... |
0660 | 94 5a 00 00 13 00 00 00 9f 5a 00 00 05 00 00 00 b3 5a 00 00 34 00 00 00 b9 5a 00 00 30 00 00 00 | .Z.......Z.......Z..4....Z..0... |
0680 | ee 5a 00 00 06 00 00 00 1f 5b 00 00 01 00 00 00 00 00 00 00 14 00 00 00 66 00 00 00 2b 00 00 00 | .Z.......[..............f...+... |
06a0 | 00 00 00 00 00 00 00 00 67 00 00 00 00 00 00 00 22 00 00 00 0b 00 00 00 3e 00 00 00 00 00 00 00 | ........g.......".......>....... |
06c0 | 20 00 00 00 00 00 00 00 13 00 00 00 06 00 00 00 07 00 00 00 00 00 00 00 09 00 00 00 3d 00 00 00 | ............................=... |
06e0 | 00 00 00 00 37 00 00 00 11 00 00 00 65 00 00 00 35 00 00 00 31 00 00 00 5a 00 00 00 02 00 00 00 | ....7.......e...5...1...Z....... |
0700 | 18 00 00 00 1a 00 00 00 64 00 00 00 50 00 00 00 4f 00 00 00 60 00 00 00 2a 00 00 00 56 00 00 00 | ........d...P...O...`...*...V... |
0720 | 48 00 00 00 00 00 00 00 00 00 00 00 5e 00 00 00 3c 00 00 00 30 00 00 00 45 00 00 00 23 00 00 00 | H...........^...<...0...E...#... |
0740 | 0d 00 00 00 26 00 00 00 00 00 00 00 03 00 00 00 0c 00 00 00 00 00 00 00 58 00 00 00 62 00 00 00 | ....&...................X...b... |
0760 | 5b 00 00 00 27 00 00 00 55 00 00 00 00 00 00 00 5c 00 00 00 46 00 00 00 43 00 00 00 63 00 00 00 | [...'...U.......\...F...C...c... |
0780 | 00 00 00 00 5d 00 00 00 00 00 00 00 36 00 00 00 1b 00 00 00 12 00 00 00 00 00 00 00 1d 00 00 00 | ....].......6................... |
07a0 | 00 00 00 00 19 00 00 00 0f 00 00 00 3a 00 00 00 53 00 00 00 41 00 00 00 52 00 00 00 2c 00 00 00 | ............:...S...A...R...,... |
07c0 | 00 00 00 00 15 00 00 00 00 00 00 00 47 00 00 00 00 00 00 00 05 00 00 00 34 00 00 00 39 00 00 00 | ............G...........4...9... |
07e0 | 00 00 00 00 2d 00 00 00 29 00 00 00 32 00 00 00 00 00 00 00 0a 00 00 00 00 00 00 00 00 00 00 00 | ....-...)...2................... |
0800 | 0e 00 00 00 51 00 00 00 24 00 00 00 42 00 00 00 61 00 00 00 00 00 00 00 57 00 00 00 4b 00 00 00 | ....Q...$...B...a.......W...K... |
0820 | 2f 00 00 00 44 00 00 00 00 00 00 00 59 00 00 00 21 00 00 00 54 00 00 00 4e 00 00 00 49 00 00 00 | /...D.......Y...!...T...N...I... |
0840 | 16 00 00 00 40 00 00 00 00 00 00 00 00 00 00 00 4a 00 00 00 28 00 00 00 2e 00 00 00 04 00 00 00 | ....@...........J...(........... |
0860 | 25 00 00 00 1e 00 00 00 00 00 00 00 38 00 00 00 5f 00 00 00 00 00 00 00 00 00 00 00 10 00 00 00 | %...........8..._............... |
0880 | 4c 00 00 00 00 00 00 00 3f 00 00 00 3b 00 00 00 1f 00 00 00 4d 00 00 00 33 00 00 00 00 00 00 00 | L.......?...;.......M...3....... |
08a0 | 17 00 00 00 1c 00 00 00 08 00 00 00 00 00 00 00 00 31 36 62 69 74 20 41 53 4e 3a 20 60 60 36 34 | .................16bit.ASN:.``64 |
08c0 | 34 39 36 20 2d 20 36 34 35 31 31 60 60 00 33 32 62 69 74 20 41 53 4e 3a 20 60 60 36 35 35 33 36 | 496.-.64511``.32bit.ASN:.``65536 |
08e0 | 20 2d 20 36 35 35 35 31 60 60 00 41 20 70 6c 75 67 69 6e 20 77 69 6c 6c 20 62 65 20 75 73 65 64 | .-.65551``.A.plugin.will.be.used |
0900 | 20 74 6f 20 67 65 6e 65 72 61 74 65 20 61 20 72 65 66 65 72 65 6e 63 65 20 6c 61 62 65 6c 20 66 | .to.generate.a.reference.label.f |
0920 | 6f 72 20 65 61 63 68 20 68 65 61 64 6c 69 6e 65 2e 20 54 6f 20 72 65 66 65 72 65 6e 63 65 20 61 | or.each.headline..To.reference.a |
0940 | 20 70 61 67 65 20 6f 72 20 61 20 73 65 63 74 69 6f 6e 20 69 6e 20 74 68 65 20 64 6f 63 75 6d 65 | .page.or.a.section.in.the.docume |
0960 | 6e 74 61 74 69 6f 6e 20 75 73 65 20 74 68 65 20 60 60 3a 72 65 66 3a 60 60 20 63 6f 6d 6d 61 6e | ntation.use.the.``:ref:``.comman |
0980 | 64 2e 00 41 64 64 20 6d 6f 64 69 66 69 65 64 20 66 69 6c 65 73 20 74 6f 20 47 69 74 20 69 6e 64 | d..Add.modified.files.to.Git.ind |
09a0 | 65 78 20 60 60 24 20 67 69 74 20 61 64 64 20 70 61 74 68 2f 74 6f 2f 66 69 6c 65 6e 61 6d 65 60 | ex.``$.git.add.path/to/filename` |
09c0 | 60 20 6f 72 20 61 64 64 20 61 6c 6c 20 75 6e 73 74 61 67 65 64 20 66 69 6c 65 73 20 60 60 24 20 | `.or.add.all.unstaged.files.``$. |
09e0 | 67 69 74 20 61 64 64 20 2e 60 60 2e 20 41 6c 6c 20 66 69 6c 65 73 20 61 64 64 65 64 20 74 6f 20 | git.add..``..All.files.added.to. |
0a00 | 74 68 65 20 47 69 74 20 69 6e 64 65 78 20 77 69 6c 6c 20 62 65 20 70 61 72 74 20 6f 66 20 79 6f | the.Git.index.will.be.part.of.yo |
0a20 | 75 20 66 6f 6c 6c 6f 77 69 6e 67 20 47 69 74 20 63 6f 6d 6d 69 74 2e 00 41 64 64 72 65 73 73 20 | u.following.Git.commit..Address. |
0a40 | 73 70 61 63 65 00 41 6c 6c 20 52 53 54 20 66 69 6c 65 73 20 6d 75 73 74 20 66 6f 6c 6c 6f 77 20 | space.All.RST.files.must.follow. |
0a60 | 74 68 65 20 73 61 6d 65 20 54 4f 43 20 4c 65 76 65 6c 20 73 79 6e 74 61 78 20 61 6e 64 20 68 61 | the.same.TOC.Level.syntax.and.ha |
0a80 | 76 65 20 74 6f 20 73 74 61 72 74 20 77 69 74 68 00 41 6e 20 6f 70 74 69 6f 6e 61 6c 20 73 65 63 | ve.to.start.with.An.optional.sec |
0aa0 | 74 69 6f 6e 20 66 6f 6c 6c 6f 77 73 2e 20 53 6f 6d 65 20 63 6f 6d 6d 61 6e 64 73 20 68 61 76 65 | tion.follows..Some.commands.have |
0ac0 | 20 72 65 71 75 69 72 65 6d 65 6e 74 73 20 6c 69 6b 65 20 63 6f 6d 70 61 74 69 62 6c 65 20 68 61 | .requirements.like.compatible.ha |
0ae0 | 72 64 77 61 72 65 20 28 65 2e 67 2e 20 57 69 66 69 29 20 6f 72 20 73 6f 6d 65 20 63 6f 6d 6d 61 | rdware.(e.g..Wifi).or.some.comma |
0b00 | 6e 64 73 20 79 6f 75 20 68 61 76 65 20 74 6f 20 73 65 74 20 62 65 66 6f 72 65 2e 20 46 6f 72 20 | nds.you.have.to.set.before..For. |
0b20 | 65 78 61 6d 70 6c 65 2c 20 69 74 20 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 74 6f 20 73 65 | example,.it.is.recommended.to.se |
0b40 | 74 20 61 20 72 6f 75 74 65 2d 6d 61 70 20 62 65 66 6f 72 65 20 63 6f 6e 66 69 67 75 72 69 6e 67 | t.a.route-map.before.configuring |
0b60 | 20 42 47 50 2e 00 41 6e 64 20 66 69 6e 61 6c 6c 79 2c 20 72 65 6d 65 6d 62 65 72 20 74 68 61 74 | .BGP..And.finally,.remember.that |
0b80 | 20 74 68 65 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 20 66 69 6c 65 73 20 61 72 65 6e | .the.reStructuredText.files.aren |
0ba0 | 27 74 20 65 78 63 6c 75 73 69 76 65 6c 79 20 66 6f 72 20 67 65 6e 65 72 61 74 69 6e 67 20 48 54 | 't.exclusively.for.generating.HT |
0bc0 | 4d 4c 20 61 6e 64 20 50 44 46 2e 20 54 68 65 79 20 73 68 6f 75 6c 64 20 62 65 20 68 75 6d 61 6e | ML.and.PDF..They.should.be.human |
0be0 | 2d 72 65 61 64 61 62 6c 65 20 61 6e 64 20 65 61 73 69 6c 79 20 70 65 72 75 73 65 64 20 66 72 6f | -readable.and.easily.perused.fro |
0c00 | 6d 20 61 20 63 6f 6e 73 6f 6c 65 2e 00 41 6e 79 74 68 69 6e 67 20 65 6c 73 65 00 41 6e 79 74 68 | m.a.console..Anything.else.Anyth |
0c20 | 69 6e 67 20 65 6c 73 65 20 74 68 61 74 20 69 73 20 6e 6f 74 20 61 20 63 6f 6e 66 69 67 75 72 61 | ing.else.that.is.not.a.configura |
0c40 | 74 69 6f 6e 20 6f 72 20 61 6e 20 6f 70 65 72 61 74 69 6f 6e 20 63 6f 6d 6d 61 6e 64 20 68 61 73 | tion.or.an.operation.command.has |
0c60 | 20 6e 6f 20 70 72 65 64 65 66 69 6e 65 64 20 73 74 72 75 63 74 75 72 65 2e 00 41 75 74 6f 6c 69 | .no.predefined.structure..Autoli |
0c80 | 6e 74 65 72 00 43 68 65 63 6b 20 79 6f 75 72 20 63 68 61 6e 67 65 73 20 62 79 20 6c 6f 63 61 6c | nter.Check.your.changes.by.local |
0ca0 | 6c 79 20 62 75 69 6c 64 69 6e 67 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 60 60 | ly.building.the.documentation.`` |
0cc0 | 24 20 6d 61 6b 65 20 6c 69 76 65 68 74 6d 6c 60 60 2e 20 53 70 68 69 6e 78 20 77 69 6c 6c 20 62 | $.make.livehtml``..Sphinx.will.b |
0ce0 | 75 69 6c 64 20 74 68 65 20 68 74 6d 6c 20 66 69 6c 65 73 20 69 6e 20 74 68 65 20 60 60 64 6f 63 | uild.the.html.files.in.the.``doc |
0d00 | 73 2f 5f 62 75 69 6c 64 60 60 20 66 6f 6c 64 65 72 2e 20 57 65 20 70 72 6f 76 69 64 65 20 79 6f | s/_build``.folder..We.provide.yo |
0d20 | 75 20 77 69 74 68 20 61 20 44 6f 63 6b 65 72 20 63 6f 6e 74 61 69 6e 65 72 20 66 6f 72 20 61 6e | u.with.a.Docker.container.for.an |
0d40 | 20 65 61 73 79 2d 74 6f 2d 75 73 65 20 75 73 65 72 20 65 78 70 65 72 69 65 6e 63 65 2e 20 43 68 | .easy-to-use.user.experience..Ch |
0d60 | 65 63 6b 20 74 68 65 20 52 45 41 44 4d 45 2e 6d 64 5f 20 66 69 6c 65 20 6f 66 20 74 68 69 73 20 | eck.the.README.md_.file.of.this. |
0d80 | 72 65 70 6f 73 69 74 6f 72 79 2e 00 43 68 65 63 6b 20 79 6f 75 72 20 63 6f 6e 66 69 67 75 72 65 | repository..Check.your.configure |
0da0 | 64 20 72 65 6d 6f 74 65 20 72 65 70 6f 73 69 74 6f 72 69 65 73 3a 00 43 6c 6f 6e 65 20 66 6f 72 | d.remote.repositories:.Clone.for |
0dc0 | 6b 20 74 6f 20 6c 6f 63 61 6c 20 6d 61 63 68 69 6e 65 2c 20 74 68 65 6e 20 63 68 61 6e 67 65 20 | k.to.local.machine,.then.change. |
0de0 | 74 6f 20 74 68 61 74 20 64 69 72 65 63 74 6f 72 79 20 60 60 24 20 63 64 20 76 79 6f 73 2d 64 6f | to.that.directory.``$.cd.vyos-do |
0e00 | 63 75 6d 65 6e 74 61 74 69 6f 6e 60 60 00 43 6f 6d 6d 69 74 20 79 6f 75 72 20 63 68 61 6e 67 65 | cumentation``.Commit.your.change |
0e20 | 73 20 77 69 74 68 20 74 68 65 20 6d 65 73 73 61 67 65 2c 20 60 60 24 20 67 69 74 20 63 6f 6d 6d | s.with.the.message,.``$.git.comm |
0e40 | 69 74 20 2d 6d 20 22 3c 63 6f 6d 6d 69 74 20 6d 65 73 73 61 67 65 3e 22 60 60 20 6f 72 20 20 75 | it.-m."<commit.message>"``.or..u |
0e60 | 73 65 20 60 60 24 20 67 69 74 20 63 6f 6d 6d 69 74 20 2d 76 60 60 20 74 6f 20 68 61 76 65 20 79 | se.``$.git.commit.-v``.to.have.y |
0e80 | 6f 75 72 20 63 6f 6e 66 69 67 75 72 65 64 20 65 64 69 74 6f 72 20 6c 61 75 6e 63 68 65 64 2e 20 | our.configured.editor.launched.. |
0ea0 | 59 6f 75 20 63 61 6e 20 74 79 70 65 20 69 6e 20 61 20 63 6f 6d 6d 69 74 20 6d 65 73 73 61 67 65 | You.can.type.in.a.commit.message |
0ec0 | 2e 20 41 67 61 69 6e 20 70 6c 65 61 73 65 20 6d 61 6b 65 20 79 6f 75 72 73 65 6c 66 20 63 6f 6d | ..Again.please.make.yourself.com |
0ee0 | 66 6f 72 74 61 62 6c 65 20 77 69 74 68 6f 75 74 20 72 75 6c 65 73 20 28 3a 72 65 66 3a 60 70 72 | fortable.without.rules.(:ref:`pr |
0f00 | 65 70 61 72 65 5f 63 6f 6d 6d 69 74 60 29 2e 00 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 6f | epare_commit`)..Configuration.mo |
0f20 | 64 65 20 70 61 67 65 73 00 43 72 65 61 74 65 20 61 20 6e 65 77 20 62 72 61 6e 63 68 20 66 6f 72 | de.pages.Create.a.new.branch.for |
0f40 | 20 79 6f 75 72 20 77 6f 72 6b 2c 20 75 73 65 20 61 20 64 65 73 63 72 69 70 74 69 76 65 20 6e 61 | .your.work,.use.a.descriptive.na |
0f60 | 6d 65 20 6f 66 20 79 6f 75 72 20 77 6f 72 6b 3a 20 60 60 24 20 67 69 74 20 63 68 65 63 6b 6f 75 | me.of.your.work:.``$.git.checkou |
0f80 | 74 20 2d 62 20 3c 62 72 61 6e 63 68 2d 6e 61 6d 65 3e 60 60 00 43 72 6f 73 73 2d 52 65 66 65 72 | t.-b.<branch-name>``.Cross-Refer |
0fa0 | 65 6e 63 65 73 00 43 75 73 74 6f 6d 20 53 70 68 69 6e 78 2d 64 6f 63 20 4d 61 72 6b 75 70 00 43 | ences.Custom.Sphinx-doc.Markup.C |
0fc0 | 75 73 74 6f 6d 20 63 6f 6d 6d 61 6e 64 73 20 68 61 76 65 20 62 65 65 6e 20 64 65 76 65 6c 6f 70 | ustom.commands.have.been.develop |
0fe0 | 65 64 20 66 6f 72 20 77 72 69 74 69 6e 67 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e | ed.for.writing.the.documentation |
1000 | 2e 20 50 6c 65 61 73 65 20 6d 61 6b 65 20 79 6f 75 72 73 65 6c 66 20 63 6f 6d 66 6f 72 74 61 62 | ..Please.make.yourself.comfortab |
1020 | 6c 65 20 77 69 74 68 20 74 68 6f 73 65 20 63 6f 6d 6d 61 6e 64 73 20 61 73 20 74 68 69 73 20 65 | le.with.those.commands.as.this.e |
1040 | 61 73 65 73 20 74 68 65 20 77 61 79 20 77 65 20 72 65 6e 64 65 72 20 74 68 65 20 64 6f 63 75 6d | ases.the.way.we.render.the.docum |
1060 | 65 6e 74 61 74 69 6f 6e 2e 00 44 6f 6e 27 74 20 66 6f 72 67 65 74 20 74 6f 20 75 70 64 61 74 65 | entation..Don't.forget.to.update |
1080 | 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 6e 65 77 | .``index.rst``.when.adding.a.new |
10a0 | 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 73 74 20 | .node..Each.GitHub.pull.request. |
10c0 | 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 65 63 6b | is.automatically.linted.to.check |
10e0 | 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 65 6e 67 | .the.address.space.and.line.leng |
1100 | 74 68 2e 00 45 78 63 65 70 74 20 69 6e 20 60 60 2e 2e 20 63 6f 64 65 2d 62 6c 6f 63 6b 3a 3a 60 | th..Except.in.``...code-block::` |
1120 | 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 74 61 67 20 60 | `.because.it.uses.the.html.tag.` |
1140 | 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 6d 65 20 6c 69 | `<pre>``.and.renders.the.same.li |
1160 | 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 73 74 20 66 69 | ne.format.from.the.source.rst.fi |
1180 | 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 74 69 6f 6e 20 | le..For.an.inline.configuration. |
11a0 | 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 64 3a 60 60 00 | level.command,.use.``:cfgcmd:``. |
11c0 | 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 65 76 65 6c 20 | For.an.inline.operational.level. |
11e0 | 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 72 20 65 78 61 | command,.use.``:opcmd:``.For.exa |
1200 | 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 20 74 68 65 20 | mple,.you.want.to.reference.the. |
1220 | 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 65 74 68 65 72 | headline.**VLAN**.in.the.**ether |
1240 | 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 67 65 6e 65 72 | net.rst**.page..The.plugin.gener |
1260 | 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 20 68 65 61 64 | ates.the.label.based.on.the.head |
1280 | 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 20 65 78 61 6d | line.and.the.file.path..For.exam |
12a0 | 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 69 74 48 75 62 | ple:.Fork.this.project.on.GitHub |
12c0 | 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 |
12e0 | 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 72 6b 66 6c 6f | cumentation/fork.Forking.Workflo |
1300 | 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 70 00 47 65 6e | w.Formating.and.Sphinxmarkup.Gen |
1320 | 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 6e | eral.concepts.for.troubleshootin |
1340 | 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 69 | g.and.detailed.process.descripti |
1360 | 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 74 | ons.belong.here..Guidelines.If.t |
1380 | 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 73 | here.some.troubleshooting.guides |
13a0 | 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 69 | .related.to.the.commands..Explai |
13c0 | 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 00 | n.it.in.the.next.optional.part.. |
13e0 | 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 20 | If.you.also.want.to.update.your. |
1400 | 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 6e | fork.on.GitHub,.use.the.followin |
1420 | 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 00 | g:.``$.git.push.origin.master``. |
1440 | 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 65 | If.you.are.willing.to.contribute |
1460 | 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 68 | .to.our.documentation.this.is.th |
1480 | 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 49 | e.definite.guide.how.to.do.so..I |
14a0 | 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 61 | n.contrast.to.submitting.code.pa |
14c0 | 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 74 | tches,.there.is.no.requirement.t |
14e0 | 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 74 | hat.you.open.up.a.Phabricator_.t |
1500 | 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 52 | ask.prior.to.submitting.a.Pull-R |
1520 | 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 20 | equest.to.the.documentation..In. |
1540 | 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 61 | the.configuration.part.of.the.pa |
1560 | 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 6f | ge,.all.possible.configuration.o |
1580 | 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 65 | ptions.should.be.documented..Use |
15a0 | 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 65 | .``...cfgcmd::``.described.above |
15c0 | 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 6c | ..Indent.with.two.spaces..Instal |
15e0 | 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 61 | l.the.requirements.``$.pip.insta |
1600 | 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 6d | ll.-r.requirements.txt``.(or.som |
1620 | 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 20 | ething.similar).Leave.a.newline. |
1640 | 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 74 | before.and.after.a.header..Limit |
1660 | 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 68 | .all.lines.to.a.maximum.of.80.ch |
1680 | 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 79 | aracters..Line.length.Make.all.y |
16a0 | 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 6f | our.changes.-.please.keep.our.co |
16c0 | 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 72 | mmit.rules.in.mind.(:ref:`prepar |
16e0 | 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 20 | e_commit`)..This.mainly.applies. |
1700 | 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 69 | to.proper.commit.messages.descri |
1720 | 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 20 | bing.your.change.(how.and.why).. |
1740 | 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 69 | Please.check.out.the.documentati |
1760 | 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 65 | on.of.Sphinx-doc_.or.reStructure |
1780 | 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 77 | dText_.if.you.are.not.familiar.w |
17a0 | 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 67 | ith.it..This.is.used.for.writing |
17c0 | 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 73 | .our.docs..Additional.directives |
17e0 | 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 61 | .how.to.write.in.RST.can.be.obta |
1800 | 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 74 | ined.from.reStructuredTextDirect |
1820 | 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 20 | ives_..Multicast.MAC-Addresses:. |
1840 | 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 74 | ``90-10-00``.to.``90-10-FF``.Not |
1860 | 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 37 | e.the.following.RFCs.(:rfc:`5737 |
1880 | 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 20 | `,.:rfc:`3849`,.:rfc:`5389`.and. |
18a0 | 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 65 | :rfc:`7042`),.which.describe.the |
18c0 | 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 6e | .reserved.public.IP.addresses.an |
18e0 | 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 20 | d.autonomous.system.numbers.for. |
1900 | 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 71 | the.documentation:.Once.pull.req |
1920 | 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 61 | uests.have.been.approved,.you.ma |
1940 | 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 6f | y.want.to.locally.update.your.fo |
1960 | 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 6c | rked.repository.too..First.you'l |
1980 | 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 61 | l.have.to.add.a.second.remote.ca |
19a0 | 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 20 | lled.`upstream`.which.points.to. |
19c0 | 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 6d | our.main.repository..``$.git.rem |
19e0 | 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 2e | ote.add.upstream.https://github. |
1a00 | 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 60 | com/vyos/vyos-documentation.git` |
1a20 | 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 64 | `.Operation.mode.commands.that.d |
1a40 | 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 61 | o.not.fit.in.a.related.configura |
1a60 | 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 65 | tion.mode.command.must.be.docume |
1a80 | 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 6e | nted.in.this.part.of.the.documen |
1aa0 | 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 67 | tation..Operation.mode.pages.Pag |
1ac0 | 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 65 | e.content.Please.do.not.use.othe |
1ae0 | 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 6f 70 65 72 6c 79 | r.public.address.space..Properly |
1b00 | 20 71 75 6f 74 65 20 63 6f 6d 6d 61 6e 64 73 2c 20 66 69 6c 65 6e 61 6d 65 73 20 61 6e 64 20 62 | .quote.commands,.filenames.and.b |
1b20 | 72 69 65 66 20 63 6f 64 65 20 73 6e 69 70 70 65 74 73 20 77 69 74 68 20 64 6f 75 62 6c 65 20 62 | rief.code.snippets.with.double.b |
1b40 | 61 63 6b 74 69 63 6b 73 2e 00 50 75 73 68 20 63 6f 6d 6d 69 74 73 20 74 6f 20 79 6f 75 72 20 47 | ackticks..Push.commits.to.your.G |
1b60 | 69 74 48 75 62 20 70 72 6f 6a 65 63 74 3a 20 60 60 24 20 67 69 74 20 70 75 73 68 20 2d 75 20 6f | itHub.project:.``$.git.push.-u.o |
1b80 | 72 69 67 69 6e 20 3c 62 72 61 6e 63 68 2d 6e 61 6d 65 3e 60 60 00 52 65 6c 61 74 65 64 20 6f 70 | rigin.<branch-name>``.Related.op |
1ba0 | 65 72 61 74 69 6f 6e 20 63 6f 6d 6d 61 6e 64 20 6d 75 73 74 20 62 65 20 64 6f 63 75 6d 65 6e 74 | eration.command.must.be.document |
1bc0 | 65 64 20 69 6e 20 74 68 65 20 6e 65 78 74 20 70 61 72 74 20 6f 66 20 74 68 65 20 61 72 74 69 63 | ed.in.the.next.part.of.the.artic |
1be0 | 6c 65 2e 20 55 73 65 20 60 60 3a 3a 6f 70 63 6d 64 2e 2e 60 60 20 66 6f 72 20 74 68 65 73 65 20 | le..Use.``::opcmd..``.for.these. |
1c00 | 63 6f 6d 6d 61 6e 64 73 2e 00 53 6f 6d 65 74 69 6d 65 73 20 69 74 20 69 73 20 6e 65 63 65 73 73 | commands..Sometimes.it.is.necess |
1c20 | 61 72 79 20 74 6f 20 70 72 6f 76 69 64 65 20 72 65 61 6c 20 49 50 20 61 64 64 72 65 73 73 65 73 | ary.to.provide.real.IP.addresses |
1c40 | 20 6c 69 6b 65 20 69 6e 20 74 68 65 20 3a 72 65 66 3a 60 65 78 61 6d 70 6c 65 73 60 2e 20 46 6f | .like.in.the.:ref:`examples`..Fo |
1c60 | 72 20 74 68 69 73 2c 20 70 6c 65 61 73 65 20 75 73 65 20 74 68 65 20 73 70 68 69 6e 78 20 63 6f | r.this,.please.use.the.sphinx.co |
1c80 | 6d 6d 65 6e 74 20 73 79 6e 74 61 78 20 60 60 2e 2e 20 73 74 6f 70 5f 76 79 6f 73 6c 69 6e 74 65 | mment.syntax.``...stop_vyoslinte |
1ca0 | 72 60 60 20 74 6f 20 73 74 6f 70 20 74 68 65 20 6c 69 6e 74 65 72 20 61 6e 64 20 60 60 2e 2e 20 | r``.to.stop.the.linter.and.``... |
1cc0 | 73 74 61 72 74 5f 76 79 6f 73 6c 69 6e 74 65 72 60 60 20 74 6f 20 73 74 61 72 74 2e 00 53 74 79 | start_vyoslinter``.to.start..Sty |
1ce0 | 6c 65 20 47 75 69 64 65 00 53 75 62 6d 69 74 20 70 75 6c 6c 2d 72 65 71 75 65 73 74 2e 20 49 6e | le.Guide.Submit.pull-request..In |
1d00 | 20 47 69 74 48 75 62 20 76 69 73 69 74 20 74 68 65 20 6d 61 69 6e 20 72 65 70 6f 73 69 74 6f 72 | .GitHub.visit.the.main.repositor |
1d20 | 79 20 61 6e 64 20 79 6f 75 20 73 68 6f 75 6c 64 20 73 65 65 20 61 20 62 61 6e 6e 65 72 20 73 75 | y.and.you.should.see.a.banner.su |
1d40 | 67 67 65 73 74 69 6e 67 20 74 6f 20 6d 61 6b 65 20 61 20 70 75 6c 6c 20 72 65 71 75 65 73 74 2e | ggesting.to.make.a.pull.request. |
1d60 | 20 46 69 6c 6c 20 6f 75 74 20 74 68 65 20 66 6f 72 6d 20 61 6e 64 20 64 65 73 63 72 69 62 65 20 | .Fill.out.the.form.and.describe. |
1d80 | 77 68 61 74 20 79 6f 75 20 64 6f 2e 00 54 4f 43 20 4c 65 76 65 6c 00 54 61 6b 65 20 61 20 6c 6f | what.you.do..TOC.Level.Take.a.lo |
1da0 | 6f 6b 20 61 74 20 74 68 65 20 3a 64 6f 63 3a 60 2f 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 60 20 | ok.at.the.:doc:`/documentation`. |
1dc0 | 70 61 67 65 20 66 6f 72 20 61 6e 20 69 6e 74 72 69 63 61 74 65 20 65 78 70 6c 61 6e 61 74 69 6f | page.for.an.intricate.explanatio |
1de0 | 6e 20 6f 66 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 70 72 6f 63 65 73 73 2e 00 | n.of.the.documentation.process.. |
1e00 | 54 68 65 20 46 6f 72 6b 69 6e 67 20 57 6f 72 6b 66 6c 6f 77 20 69 73 20 66 75 6e 64 61 6d 65 6e | The.Forking.Workflow.is.fundamen |
1e20 | 74 61 6c 6c 79 20 64 69 66 66 65 72 65 6e 74 20 66 72 6f 6d 20 6f 74 68 65 72 20 70 6f 70 75 6c | tally.different.from.other.popul |
1e40 | 61 72 20 47 69 74 20 77 6f 72 6b 66 6c 6f 77 73 2e 20 49 6e 73 74 65 61 64 20 6f 66 20 75 73 69 | ar.Git.workflows..Instead.of.usi |
1e60 | 6e 67 20 61 20 73 69 6e 67 6c 65 20 73 65 72 76 65 72 2d 73 69 64 65 20 72 65 70 6f 73 69 74 6f | ng.a.single.server-side.reposito |
1e80 | 72 79 20 74 6f 20 61 63 74 20 61 73 20 74 68 65 20 22 63 65 6e 74 72 61 6c 22 20 63 6f 64 65 62 | ry.to.act.as.the."central".codeb |
1ea0 | 61 73 65 2c 20 69 74 20 67 69 76 65 73 20 65 76 65 72 79 20 64 65 76 65 6c 6f 70 65 72 20 74 68 | ase,.it.gives.every.developer.th |
1ec0 | 65 69 72 20 6f 77 6e 20 73 65 72 76 65 72 2d 73 69 64 65 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 | eir.own.server-side.repository.. |
1ee0 | 54 68 69 73 20 6d 65 61 6e 73 20 74 68 61 74 20 65 61 63 68 20 63 6f 6e 74 72 69 62 75 74 6f 72 | This.means.that.each.contributor |
1f00 | 20 68 61 73 20 6e 6f 74 20 6f 6e 65 2c 20 62 75 74 20 74 77 6f 20 47 69 74 20 72 65 70 6f 73 69 | .has.not.one,.but.two.Git.reposi |
1f20 | 74 6f 72 69 65 73 3a 20 61 20 70 72 69 76 61 74 65 20 6c 6f 63 61 6c 20 6f 6e 65 20 61 6e 64 20 | tories:.a.private.local.one.and. |
1f40 | 61 20 70 75 62 6c 69 63 20 73 65 72 76 65 72 2d 73 69 64 65 20 6f 6e 65 2e 00 54 68 65 20 61 72 | a.public.server-side.one..The.ar |
1f60 | 74 69 63 6c 65 20 73 74 61 72 74 73 20 77 69 74 68 20 61 20 73 68 6f 72 74 20 69 6e 74 72 6f 64 | ticle.starts.with.a.short.introd |
1f80 | 75 63 74 69 6f 6e 20 61 62 6f 75 74 20 74 68 65 20 63 6f 6d 6d 61 6e 64 20 6f 72 20 74 68 65 20 | uction.about.the.command.or.the. |
1fa0 | 74 65 63 68 6e 6f 6c 6f 67 79 2e 20 50 6c 65 61 73 65 20 69 6e 63 6c 75 64 65 20 73 6f 6d 65 20 | technology..Please.include.some. |
1fc0 | 68 65 6c 70 66 75 6c 20 6c 69 6e 6b 73 20 6f 72 20 62 61 63 6b 67 72 6f 75 6e 64 20 69 6e 66 6f | helpful.links.or.background.info |
1fe0 | 72 6d 61 74 69 6f 6e 2e 00 54 68 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 6f 64 65 20 | rmation..The.configuration.mode. |
2000 | 66 6f 6c 64 65 72 20 61 6e 64 20 74 68 65 20 61 72 74 69 63 6c 65 73 20 63 6f 76 65 72 20 74 68 | folder.and.the.articles.cover.th |
2020 | 65 20 73 70 65 63 69 66 69 63 20 6c 65 76 65 6c 20 6f 66 20 74 68 65 20 63 6f 6d 6d 61 6e 64 73 | e.specific.level.of.the.commands |
2040 | 2e 20 54 68 65 20 65 78 61 63 74 20 6c 65 76 65 6c 20 64 65 70 65 6e 64 73 20 6f 6e 20 74 68 65 | ..The.exact.level.depends.on.the |
2060 | 20 63 6f 6d 6d 61 6e 64 2e 20 54 68 69 73 20 73 68 6f 75 6c 64 20 70 72 6f 76 69 64 65 20 73 74 | .command..This.should.provide.st |
2080 | 61 62 69 6c 69 74 79 20 66 6f 72 20 55 52 4c 73 20 75 73 65 64 20 69 6e 20 74 68 65 20 66 6f 72 | ability.for.URLs.used.in.the.for |
20a0 | 75 6d 20 6f 72 20 62 6c 6f 67 70 6f 73 74 2e 00 54 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f | um.or.blogpost..The.documentatio |
20c0 | 6e 20 68 61 73 20 33 20 64 69 66 66 65 72 65 6e 74 20 74 79 70 65 73 20 6f 66 20 70 61 67 65 73 | n.has.3.different.types.of.pages |
20e0 | 2e 20 54 68 65 20 73 61 6d 65 20 6b 69 6e 64 20 6f 66 20 70 61 67 65 73 20 6d 75 73 74 20 68 61 | ..The.same.kind.of.pages.must.ha |
2100 | 76 65 20 74 68 65 20 73 61 6d 65 20 73 74 72 75 63 74 75 72 65 20 74 6f 20 61 63 68 69 65 76 65 | ve.the.same.structure.to.achieve |
2120 | 20 61 20 72 65 63 6f 67 6e 69 74 69 6f 6e 20 66 61 63 74 6f 72 2e 00 54 68 65 20 64 6f 63 75 6d | .a.recognition.factor..The.docum |
2140 | 65 6e 74 61 74 69 6f 6e 20 73 6f 75 72 63 65 20 69 73 20 6b 65 70 74 20 69 6e 20 74 68 65 20 47 | entation.source.is.kept.in.the.G |
2160 | 69 74 20 72 65 70 6f 73 69 74 6f 72 79 20 61 74 20 68 74 74 70 73 3a 2f 2f 67 69 74 68 75 62 2e | it.repository.at.https://github. |
2180 | 63 6f 6d 2f 76 79 6f 73 2f 76 79 6f 73 2d 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 61 6e 64 20 | com/vyos/vyos-documentation.and. |
21a0 | 79 6f 75 20 63 61 6e 20 66 6f 6c 6c 6f 77 20 74 68 65 20 69 6e 73 74 72 75 63 74 69 6f 6e 73 20 | you.can.follow.the.instructions. |
21c0 | 69 6e 20 74 68 65 20 52 45 41 44 4d 45 2e 6d 64 5f 20 74 6f 20 62 75 69 6c 64 20 61 6e 64 20 74 | in.the.README.md_.to.build.and.t |
21e0 | 65 73 74 20 79 6f 75 72 20 63 68 61 6e 67 65 73 2e 00 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 | est.your.changes..The.following. |
2200 | 69 73 20 61 20 71 75 69 63 6b 20 73 75 6d 6d 61 72 79 20 6f 66 20 74 68 65 20 72 75 6c 65 73 3a | is.a.quick.summary.of.the.rules: |
2220 | 00 54 68 65 20 6d 61 69 6e 20 61 64 76 61 6e 74 61 67 65 20 6f 66 20 74 68 65 20 46 6f 72 6b 69 | .The.main.advantage.of.the.Forki |
2240 | 6e 67 20 57 6f 72 6b 66 6c 6f 77 20 69 73 20 74 68 61 74 20 63 6f 6e 74 72 69 62 75 74 69 6f 6e | ng.Workflow.is.that.contribution |
2260 | 73 20 63 61 6e 20 62 65 20 69 6e 74 65 67 72 61 74 65 64 20 77 69 74 68 6f 75 74 20 74 68 65 20 | s.can.be.integrated.without.the. |
2280 | 6e 65 65 64 20 66 6f 72 20 65 76 65 72 79 62 6f 64 79 20 74 6f 20 70 75 73 68 20 74 6f 20 61 20 | need.for.everybody.to.push.to.a. |
22a0 | 73 69 6e 67 6c 65 20 63 65 6e 74 72 61 6c 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 44 65 76 65 6c | single.central.repository..Devel |
22c0 | 6f 70 65 72 73 20 70 75 73 68 20 74 6f 20 74 68 65 69 72 20 6f 77 6e 20 73 65 72 76 65 72 2d 73 | opers.push.to.their.own.server-s |
22e0 | 69 64 65 20 72 65 70 6f 73 69 74 6f 72 69 65 73 2c 20 61 6e 64 20 6f 6e 6c 79 20 74 68 65 20 70 | ide.repositories,.and.only.the.p |
2300 | 72 6f 6a 65 63 74 20 6d 61 69 6e 74 61 69 6e 65 72 20 63 61 6e 20 70 75 73 68 20 74 6f 20 74 68 | roject.maintainer.can.push.to.th |
2320 | 65 20 6f 66 66 69 63 69 61 6c 20 72 65 70 6f 73 69 74 6f 72 79 2e 20 54 68 69 73 20 61 6c 6c 6f | e.official.repository..This.allo |
2340 | 77 73 20 74 68 65 20 6d 61 69 6e 74 61 69 6e 65 72 20 74 6f 20 61 63 63 65 70 74 20 63 6f 6d 6d | ws.the.maintainer.to.accept.comm |
2360 | 69 74 73 20 66 72 6f 6d 20 61 6e 79 20 64 65 76 65 6c 6f 70 65 72 20 77 69 74 68 6f 75 74 20 67 | its.from.any.developer.without.g |
2380 | 69 76 69 6e 67 20 74 68 65 6d 20 77 72 69 74 65 20 61 63 63 65 73 73 20 74 6f 20 74 68 65 20 6f | iving.them.write.access.to.the.o |
23a0 | 66 66 69 63 69 61 6c 20 63 6f 64 65 62 61 73 65 2e 00 54 68 65 20 70 6c 75 67 69 6e 20 77 69 6c | fficial.codebase..The.plugin.wil |
23c0 | 6c 20 77 61 72 6e 20 6f 6e 20 62 75 69 6c 64 20 69 66 20 61 20 68 65 61 64 6c 69 6e 65 20 68 61 | l.warn.on.build.if.a.headline.ha |
23e0 | 73 20 61 20 64 75 70 6c 69 63 61 74 65 20 6e 61 6d 65 20 69 6e 20 74 68 65 20 73 61 6d 65 20 64 | s.a.duplicate.name.in.the.same.d |
2400 | 6f 63 75 6d 65 6e 74 2e 20 54 6f 20 70 72 65 76 65 6e 74 20 74 68 69 73 20 77 61 72 6e 69 6e 67 | ocument..To.prevent.this.warning |
2420 | 2c 20 79 6f 75 20 68 61 76 65 20 74 6f 20 70 75 74 20 61 20 63 75 73 74 6f 6d 20 6c 69 6e 6b 20 | ,.you.have.to.put.a.custom.link. |
2440 | 6f 6e 20 74 6f 70 20 6f 66 20 74 68 65 20 68 65 61 64 6c 69 6e 65 2e 00 54 68 65 72 65 20 61 72 | on.top.of.the.headline..There.ar |
2460 | 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 69 6e 64 20 77 | e.a.few.things.to.keep.in.mind.w |
2480 | 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 75 6d 65 6e 74 | hen.contributing.to.the.document |
24a0 | 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 69 73 74 65 6e | ation,.for.the.sake.of.consisten |
24c0 | 63 79 20 61 6e 64 20 72 65 61 64 61 62 69 6c 69 74 79 2e 00 54 6f 20 65 78 74 72 61 63 74 20 61 | cy.and.readability..To.extract.a |
24e0 | 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 |
2500 | 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:``. |
2520 | 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 |
2540 | 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. |
2560 | 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 |
2580 | 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 |
25a0 | 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 |
25c0 | 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 |
25e0 | 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 |
2600 | 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 |
2620 | 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.}}``.-.``{{ |
2640 | 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 |
2660 | 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 |
2680 | 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 |
26a0 | 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 |
26c0 | 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`` |
26e0 | 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 |
2700 | 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 |
2720 | 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 |
2740 | 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 |
2760 | 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.. |
2780 | 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 |
27a0 | 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 |
27c0 | 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 |
27e0 | 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 |
2800 | 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. |
2820 | 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 |
2840 | 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 |
2860 | 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. |
2880 | 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 |
28a0 | 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 |
28c0 | 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 |
28e0 | 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. |
2900 | 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 |
2920 | 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. |
2940 | 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 |
2960 | 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 |
2980 | 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 |
29a0 | 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. |
29c0 | 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 |
29e0 | 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 72 79 20 56 | umentation..We.encourage.every.V |
2a00 | 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 6f 75 72 20 | yOS.user.to.help.us.improve.our. |
2a20 | 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 65 66 69 63 | documentation.as.we.have.a.defic |
2a40 | 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 74 73 2e 20 | it.like.most.software.projects.. |
2a60 | 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 6e 20 72 65 | .This.not.only.helps.you.when.re |
2a80 | 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 2e 00 57 65 | ading.but.also.everyone.else..We |
2aa0 | 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 72 20 48 65 | .use.the.following.syntax.for.He |
2ac0 | 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 49 20 63 6f | adlines..When.documenting.CLI.co |
2ae0 | 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 3a 60 60 20 | mmands,.use.the.``...cfgcmd::``. |
2b00 | 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 69 6f 6e 20 | directive.for.all.configuration. |
2b20 | 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 6e 20 6f 66 | mode.commands..An.explanation.of |
2b40 | 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 62 65 | .the.described.command.should.be |
2b60 | 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 20 52 65 70 | .added.below.this.statement..Rep |
2b80 | 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 69 74 68 20 | lace.all.variable.contents.with. |
2ba0 | 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 2e 00 57 68 | <value>.or.something.similar..Wh |
2bc0 | 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 65 76 65 6c | en.documenting.operational.level |
2be0 | 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 64 3a 3a 60 | .commands,.use.the.``...opcmd::` |
2c00 | 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 6f 66 20 74 | `.directive..An.explanation.of.t |
2c20 | 68 65 20 64 65 73 63 72 69 62 65 64 20 63 6f 6d 6d 61 6e 64 20 73 68 6f 75 6c 64 20 62 65 20 61 | he.described.command.should.be.a |
2c40 | 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 68 65 6e 20 | dded.below.this.statement..When. |
2c60 | 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 66 20 65 78 | in.doubt,.follow.the.style.of.ex |
2c80 | 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 65 66 65 72 | isting.documentation..When.refer |
2ca0 | 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 61 73 6b 73 | encing.to.VyOS.Phabricator.Tasks |
2cc0 | 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 61 72 6b 75 | ,.there.is.a.custom.Sphinx.Marku |
2ce0 | 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 74 68 61 74 | p.command.called.``vytask``.that |
2d00 | 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 70 72 6f 70 | .automatically.renders.to.a.prop |
2d20 | 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 68 65 61 76 | er.Phabricator.URL..This.is.heav |
2d40 | 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 65 2d 6e 6f | ily.used.in.the.:ref:`release-no |
2d60 | 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 74 6f 6d 20 | tes`.section..With.those.custom. |
2d80 | 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 72 65 6e 64 | commands,.it.is.possible.to.rend |
2da0 | 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 65 20 77 61 | er.them.in.a.more.descriptive.wa |
2dc0 | 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 6d 61 6e 75 | y.in.the.resulting.HTML/PDF.manu |
2de0 | 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 64 73 2c 20 | al..With.those.custom.commands,. |
2e00 | 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 72 20 74 68 | it.will.be.possible.to.render.th |
2e20 | 65 6d 20 69 6e 20 61 20 6d 6f 72 65 20 64 65 73 63 72 69 70 74 69 76 65 20 77 61 79 20 69 6e 20 | em.in.a.more.descriptive.way.in. |
2e40 | 74 68 65 20 72 65 73 75 6c 74 69 6e 67 20 48 54 4d 4c 2f 50 44 46 20 6d 61 6e 75 61 6c 2e 00 57 | the.resulting.HTML/PDF.manual..W |
2e60 | 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 69 74 68 65 | rite.Documentation.You.can.eithe |
2e80 | 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 76 65 20 66 | r.install.Sphinx.(and.TeX.Live.f |
2ea0 | 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 20 64 6f 63 | or.PDF.output).and.build.the.doc |
2ec0 | 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 68 65 20 44 | umentation.locally,.or.use.the.D |
2ee0 | 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 63 6f 6e 74 | ockerfile_.to.build.it.in.a.cont |
2f00 | 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 69 74 68 75 | ainer..Your.remote.repo.on.Githu |
2f20 | 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 65 20 74 68 | b.is.called.``origin``,.while.th |
2f40 | 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 6b 65 64 20 | e.original.repo.you.have.forked. |
2f60 | 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 79 6f 75 20 | is.called.``upstream``..Now.you. |
2f80 | 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 65 64 20 72 | can.locally.update.your.forked.r |
2fa0 | 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 35 31 2e 31 | epo..``192.0.2.0/24``.``198.51.1 |
2fc0 | 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 60 60 32 30 | 00.0/24``.``2001:db8::/32``.``20 |
2fe0 | 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 20 6f 75 74 | 3.0.113.0/24``.``:ref:`Check.out |
3000 | 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 65 73 2f 65 | .VLAN<configuration/interfaces/e |
3020 | 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 69 67 75 72 | thernet:vlan>``.``:ref:`configur |
3040 | 61 74 69 6f 6e 2f 69 6e 74 65 72 66 61 63 65 73 2f 65 74 68 65 72 6e 65 74 3a 76 6c 61 6e 60 60 | ation/interfaces/ethernet:vlan`` |
3060 | 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 69 74 74 65 | .``set.firewall.zone``.is.writte |
3080 | 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 60 73 65 74 | n.in.``firewall/zone.rst``.``set |
30a0 | 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 69 74 74 65 | .interfaces.ethernet``.is.writte |
30c0 | 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 73 74 60 60 | n.in.``interfaces/ethernet.rst`` |
30e0 | 00 63 66 67 63 6d 64 00 63 6d 64 69 6e 63 6c 75 64 65 00 68 61 6e 64 6c 65 20 62 75 69 6c 64 20 | .cfgcmd.cmdinclude.handle.build. |
3100 | 65 72 72 6f 72 73 00 6f 70 63 6d 64 00 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20 69 6e 74 65 | errors.opcmd.the.content.of.inte |
3120 | 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 20 74 68 69 | rface-address.txt.looks.like.thi |
3140 | 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 72 6c 69 6e | s.to.use.an.alternative.hyperlin |
3160 | 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 4d 49 4d 45 2d 56 | k.use.it.this.way:.vytask.MIME-V |
3180 | 65 72 73 69 6f 6e 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 | ersion:.1.0.Content-Type:.text/p |
31a0 | 6c 61 69 6e 3b 20 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 | lain;.charset=UTF-8.Content-Tran |
31c0 | 73 66 65 72 2d 45 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 | sfer-Encoding:.8bit.X-Generator: |
31e0 | 20 4c 6f 63 61 6c 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 | .Localazy.(https://localazy.com) |
3200 | 0a 50 72 6f 6a 65 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 | .Project-Id-Version:..Language:. |
3220 | 70 74 0a 50 6c 75 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 | pt.Plural-Forms:.nplurals=2;.plu |
3240 | 72 61 6c 3d 28 6e 3e 3d 30 20 26 26 20 6e 3c 3d 31 29 20 3f 20 30 20 3a 20 31 3b 0a 00 31 36 62 | ral=(n>=0.&&.n<=1).?.0.:.1;..16b |
3260 | 69 74 20 41 53 4e 3a 20 60 60 36 34 34 39 36 20 2d 20 36 34 35 31 31 60 60 00 33 32 62 69 74 20 | it.ASN:.``64496.-.64511``.32bit. |
3280 | 41 53 4e 3a 20 60 60 36 35 35 33 36 20 2d 20 36 35 35 35 31 60 60 00 41 20 70 6c 75 67 69 6e 20 | ASN:.``65536.-.65551``.A.plugin. |
32a0 | 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 72 | will.be.used.to.generate.a.refer |
32c0 | 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 6f | ence.label.for.each.headline..To |
32e0 | 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 69 | .reference.a.page.or.a.section.i |
3300 | 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 72 | n.the.documentation.use.the.``:r |
3320 | 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 65 | ef:``.command..Add.modified.file |
3340 | 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 2f | s.to.Git.index.``$.git.add.path/ |
3360 | 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 65 | to/filename``.or.add.all.unstage |
3380 | 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 6c | d.files.``$.git.add..``..All.fil |
33a0 | 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 62 | es.added.to.the.Git.index.will.b |
33c0 | 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 6d | e.part.of.you.following.Git.comm |
33e0 | 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 20 | it..Address.space.All.RST.files. |
3400 | 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 73 | must.follow.the.same.TOC.Level.s |
3420 | 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 20 | yntax.and.have.to.start.with.An. |
3440 | 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 63 | optional.section.follows..Some.c |
3460 | 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 63 | ommands.have.requirements.like.c |
3480 | 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 6f | ompatible.hardware.(e.g..Wifi).o |
34a0 | 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 20 | r.some.commands.you.have.to.set. |
34c0 | 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 6d | before..For.example,.it.is.recom |
34e0 | 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 65 | mended.to.set.a.route-map.before |
3500 | 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 72 | .configuring.BGP..And.finally,.r |
3520 | 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 78 | emember.that.the.reStructuredTex |
3540 | 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 67 | t.files.aren't.exclusively.for.g |
3560 | 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 6f | enerating.HTML.and.PDF..They.sho |
3580 | 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 79 | uld.be.human-readable.and.easily |
35a0 | 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 6e | .perused.from.a.console..Anythin |
35c0 | 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 74 | g.else.Anything.else.that.is.not |
35e0 | 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 6e | .a.configuration.or.an.operation |
3600 | 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 63 | .command.has.no.predefined.struc |
3620 | 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 6e | ture..Autolinter.Check.your.chan |
3640 | 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 75 | ges.by.locally.building.the.docu |
3660 | 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 53 | mentation.``$.make.livehtml``..S |
3680 | 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 20 | phinx.will.build.the.html.files. |
36a0 | 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 57 | in.the.``docs/_build``.folder..W |
36c0 | 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 74 | e.provide.you.with.a.Docker.cont |
36e0 | 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 78 | ainer.for.an.easy-to-use.user.ex |
3700 | 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 66 | perience..Check.the.README.md_.f |
3720 | 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 6f | ile.of.this.repository..Check.yo |
3740 | 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 65 | ur.configured.remote.repositorie |
3760 | 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 20 | s:.Clone.fork.to.local.machine,. |
3780 | 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 60 | then.change.to.that.directory.`` |
37a0 | 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 74 | $.cd.vyos-documentation``.Commit |
37c0 | 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 20 | .your.changes.with.the.message,. |
37e0 | 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 61 | ``$.git.commit.-m."<commit.messa |
3800 | 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 76 | ge>"``.or..use.``$.git.commit.-v |
3820 | 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 6f | ``.to.have.your.configured.edito |
3840 | 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 6f | r.launched..You.can.type.in.a.co |
3860 | 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 20 | mmit.message..Again.please.make. |
3880 | 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 6c | yourself.comfortable.without.rul |
38a0 | 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 66 | es.(:ref:`prepare_commit`)..Conf |
38c0 | 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 65 | iguration.mode.pages.Create.a.ne |
38e0 | 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 65 | w.branch.for.your.work,.use.a.de |
3900 | 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 24 | scriptive.name.of.your.work:.``$ |
3920 | 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 60 | .git.checkout.-b.<branch-name>`` |
3940 | 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 2d | .Cross-References.Custom.Sphinx- |
3960 | 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 20 | doc.Markup.Custom.commands.have. |
3980 | 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 64 | been.developed.for.writing.the.d |
39a0 | 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 65 | ocumentation..Please.make.yourse |
39c0 | 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 6e | lf.comfortable.with.those.comman |
39e0 | 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 64 | ds.as.this.eases.the.way.we.rend |
3a00 | 65 72 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 00 44 6f 6e 27 74 20 66 6f 72 67 | er.the.documentation..Don't.forg |
3a20 | 65 74 20 74 6f 20 75 70 64 61 74 65 20 60 60 69 6e 64 65 78 2e 72 73 74 60 60 20 77 68 65 6e 20 | et.to.update.``index.rst``.when. |
3a40 | 61 64 64 69 6e 67 20 61 20 6e 65 77 20 6e 6f 64 65 2e 00 45 61 63 68 20 47 69 74 48 75 62 20 70 | adding.a.new.node..Each.GitHub.p |
3a60 | 75 6c 6c 20 72 65 71 75 65 73 74 20 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 6c 69 6e | ull.request.is.automatically.lin |
3a80 | 74 65 64 20 74 6f 20 63 68 65 63 6b 20 74 68 65 20 61 64 64 72 65 73 73 20 73 70 61 63 65 20 61 | ted.to.check.the.address.space.a |
3aa0 | 6e 64 20 6c 69 6e 65 20 6c 65 6e 67 74 68 2e 00 45 78 63 65 70 74 20 69 6e 20 60 60 2e 2e 20 63 | nd.line.length..Except.in.``...c |
3ac0 | 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 20 74 68 | ode-block::``.because.it.uses.th |
3ae0 | 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 65 72 73 | e.html.tag.``<pre>``.and.renders |
3b00 | 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 65 20 73 | .the.same.line.format.from.the.s |
3b20 | 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 20 63 6f | ource.rst.file..For.an.inline.co |
3b40 | 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 65 20 60 | nfiguration.level.command,.use.` |
3b60 | 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 72 61 74 | `:cfgcmd:``.For.an.inline.operat |
3b80 | 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 70 63 6d | ional.level.command,.use.``:opcm |
3ba0 | 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 20 72 65 | d:``.For.example,.you.want.to.re |
3bc0 | 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 20 69 6e | ference.the.headline.**VLAN**.in |
3be0 | 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 68 65 20 | .the.**ethernet.rst**.page..The. |
3c00 | 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 73 65 64 | plugin.generates.the.label.based |
3c20 | 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 20 70 61 | .on.the.headline.and.the.file.pa |
3c40 | 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 6f 6a 65 | th..For.example:.Fork.this.proje |
3c60 | 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 6f 6d 2f | ct.on.GitHub.https://github.com/ |
3c80 | 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 46 6f 72 | vyos/vyos-documentation/fork.For |
3ca0 | 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 70 68 69 | king.Workflow.Formating.and.Sphi |
3cc0 | 6e 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 | nxmarkup.General.concepts.for.tr |
3ce0 | 6f 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 | oubleshooting.and.detailed.proce |
3d00 | 73 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 | ss.descriptions.belong.here..Gui |
3d20 | 64 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 | delines.If.there.some.troublesho |
3d40 | 6f 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 | oting.guides.related.to.the.comm |
3d60 | 61 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 | ands..Explain.it.in.the.next.opt |
3d80 | 69 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 | ional.part..If.you.also.want.to. |
3da0 | 75 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 | update.your.fork.on.GitHub,.use. |
3dc0 | 74 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 | the.following:.``$.git.push.orig |
3de0 | 69 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 | in.master``.If.you.are.willing.t |
3e00 | 6f 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 | o.contribute.to.our.documentatio |
3e20 | 6e 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 | n.this.is.the.definite.guide.how |
3e40 | 20 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 | .to.do.so..In.contrast.to.submit |
3e60 | 74 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 | ting.code.patches,.there.is.no.r |
3e80 | 65 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 | equirement.that.you.open.up.a.Ph |
3ea0 | 61 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 | abricator_.task.prior.to.submitt |
3ec0 | 69 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 | ing.a.Pull-Request.to.the.docume |
3ee0 | 6e 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 | ntation..In.the.configuration.pa |
3f00 | 72 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 | rt.of.the.page,.all.possible.con |
3f20 | 66 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 | figuration.options.should.be.doc |
3f40 | 75 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 | umented..Use.``...cfgcmd::``.des |
3f60 | 63 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 | cribed.above..Indent.with.two.sp |
3f80 | 61 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 | aces..Install.the.requirements.` |
3fa0 | 60 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 | `$.pip.install.-r.requirements.t |
3fc0 | 78 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 | xt``.(or.something.similar).Leav |
3fe0 | 65 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 | e.a.newline.before.and.after.a.h |
4000 | 65 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 | eader..Limit.all.lines.to.a.maxi |
4020 | 6d 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 | mum.of.80.characters..Line.lengt |
4040 | 68 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 | h.Make.all.your.changes.-.please |
4060 | 20 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 | .keep.our.commit.rules.in.mind.( |
4080 | 3a 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 | :ref:`prepare_commit`)..This.mai |
40a0 | 6e 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 | nly.applies.to.proper.commit.mes |
40c0 | 73 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 | sages.describing.your.change.(ho |
40e0 | 77 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 | w.and.why)..Please.check.out.the |
4100 | 20 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 | .documentation.of.Sphinx-doc_.or |
4120 | 20 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 | .reStructuredText_.if.you.are.no |
4140 | 74 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 | t.familiar.with.it..This.is.used |
4160 | 20 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 | .for.writing.our.docs..Additiona |
4180 | 6c 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 | l.directives.how.to.write.in.RST |
41a0 | 20 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 | .can.be.obtained.from.reStructur |
41c0 | 65 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 | edTextDirectives_..Multicast.MAC |
41e0 | 2d 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 | -Addresses:.``90-10-00``.to.``90 |
4200 | 2d 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 | -10-FF``.Note.the.following.RFCs |
4220 | 20 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 | .(:rfc:`5737`,.:rfc:`3849`,.:rfc |
4240 | 3a 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 | :`5389`.and.:rfc:`7042`),.which. |
4260 | 64 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 | describe.the.reserved.public.IP. |
4280 | 61 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 | addresses.and.autonomous.system. |
42a0 | 6e 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 | numbers.for.the.documentation:.O |
42c0 | 6e 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 | nce.pull.requests.have.been.appr |
42e0 | 6f 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 | oved,.you.may.want.to.locally.up |
4300 | 64 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 | date.your.forked.repository.too. |
4320 | 20 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 | .First.you'll.have.to.add.a.seco |
4340 | 6e 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 | nd.remote.called.`upstream`.whic |
4360 | 68 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 | h.points.to.our.main.repository. |
4380 | 20 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 | .``$.git.remote.add.upstream.htt |
43a0 | 70 73 3a 2f 2f 67 69 74 68 75 62 2e 63 6f 6d 2f 76 79 6f 73 2f 76 79 6f 73 2d 64 6f 63 75 6d 65 | ps://github.com/vyos/vyos-docume |
43c0 | 6e 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 | ntation.git``.Operation.mode.com |
43e0 | 6d 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 | mands.that.do.not.fit.in.a.relat |
4400 | 65 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 | ed.configuration.mode.command.mu |
4420 | 73 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 | st.be.documented.in.this.part.of |
4440 | 20 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 | .the.documentation..Operation.mo |
4460 | 64 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 | de.pages.Page.content.Please.do. |
4480 | 6e 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 | not.use.other.public.address.spa |
44a0 | 63 65 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 20 66 69 6c | ce..Properly.quote.commands,.fil |
44c0 | 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 74 73 20 77 | enames.and.brief.code.snippets.w |
44e0 | 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 6f 6d 6d 69 | ith.double.backticks..Push.commi |
4500 | 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 60 24 20 67 | ts.to.your.GitHub.project:.``$.g |
4520 | 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 6d 65 3e 60 | it.push.-u.origin.<branch-name>` |
4540 | 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 6d 75 73 74 | `.Related.operation.command.must |
4560 | 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 61 72 74 20 | .be.documented.in.the.next.part. |
4580 | 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 64 2e 2e 60 | of.the.article..Use.``::opcmd..` |
45a0 | 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 6d 65 73 20 | `.for.these.commands..Sometimes. |
45c0 | 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 65 61 6c 20 | it.is.necessary.to.provide.real. |
45e0 | 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 66 3a 60 65 | IP.addresses.like.in.the.:ref:`e |
4600 | 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 73 65 20 74 | xamples`..For.this,.please.use.t |
4620 | 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 2e 20 73 74 | he.sphinx.comment.syntax.``...st |
4640 | 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 6c 69 6e 74 | op_vyoslinter``.to.stop.the.lint |
4660 | 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 60 60 20 74 | er.and.``...start_vyoslinter``.t |
4680 | 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 70 75 6c 6c | o.start..Style.Guide.Submit.pull |
46a0 | 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 65 20 6d 61 | -request..In.GitHub.visit.the.ma |
46c0 | 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 20 73 65 65 | in.repository.and.you.should.see |
46e0 | 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 20 61 20 70 | .a.banner.suggesting.to.make.a.p |
4700 | 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 72 6d 20 61 | ull.request..Fill.out.the.form.a |
4720 | 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 20 4c 65 76 | nd.describe.what.you.do..TOC.Lev |
4740 | 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 2f 64 6f 63 | el.Take.a.look.at.the.:doc:`/doc |
4760 | 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 69 63 61 74 | umentation`.page.for.an.intricat |
4780 | 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 74 61 74 69 | e.explanation.of.the.documentati |
47a0 | 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 66 6c 6f 77 | on.process..The.Forking.Workflow |
47c0 | 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 66 72 6f 6d | .is.fundamentally.different.from |
47e0 | 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 2e 20 49 6e | .other.popular.Git.workflows..In |
4800 | 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 65 72 2d 73 | stead.of.using.a.single.server-s |
4820 | 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 20 22 63 65 | ide.repository.to.act.as.the."ce |
4840 | 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 65 72 79 20 | ntral".codebase,.it.gives.every. |
4860 | 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 69 64 65 20 | developer.their.own.server-side. |
4880 | 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 65 61 63 68 | repository..This.means.that.each |
48a0 | 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 74 20 74 77 | .contributor.has.not.one,.but.tw |
48c0 | 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 65 20 6c 6f | o.Git.repositories:.a.private.lo |
48e0 | 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 73 69 64 65 | cal.one.and.a.public.server-side |
4900 | 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 68 20 61 20 | .one..The.article.starts.with.a. |
4920 | 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 20 63 6f 6d | short.introduction.about.the.com |
4940 | 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 73 65 20 69 | mand.or.the.technology..Please.i |
4960 | 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 20 62 61 63 | nclude.some.helpful.links.or.bac |
4980 | 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 66 69 67 75 | kground.information..The.configu |
49a0 | 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 72 74 69 63 | ration.mode.folder.and.the.artic |
49c0 | 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 20 6f 66 20 | les.cover.the.specific.level.of. |
49e0 | 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 6c 20 64 65 | the.commands..The.exact.level.de |
4a00 | 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 68 6f 75 6c | pends.on.the.command..This.shoul |
4a20 | 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 20 75 73 65 | d.provide.stability.for.URLs.use |
4a40 | 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 54 68 65 20 | d.in.the.forum.or.blogpost..The. |
4a60 | 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 74 20 74 79 | documentation.has.3.different.ty |
4a80 | 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 6f 66 20 70 | pes.of.pages..The.same.kind.of.p |
4aa0 | 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 63 74 75 72 | ages.must.have.the.same.structur |
4ac0 | 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 61 63 74 6f | e.to.achieve.a.recognition.facto |
4ae0 | 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 69 73 20 6b | r..The.documentation.source.is.k |
4b00 | 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 20 68 74 74 | ept.in.the.Git.repository.at.htt |
4b20 | 70 73 3a 2f 2f 67 69 74 68 75 62 2e 63 6f 6d 2f 76 79 6f 73 2f 76 79 6f 73 2d 64 6f 63 75 6d 65 | ps://github.com/vyos/vyos-docume |
4b40 | 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 68 65 20 69 | ntation.and.you.can.follow.the.i |
4b60 | 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 5f 20 74 6f | nstructions.in.the.README.md_.to |
4b80 | 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 2e 00 54 68 | .build.and.test.your.changes..Th |
4ba0 | 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 72 79 20 6f | e.following.is.a.quick.summary.o |
4bc0 | 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 61 67 65 20 | f.the.rules:.The.main.advantage. |
4be0 | 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 68 61 74 20 | of.the.Forking.Workflow.is.that. |
4c00 | 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 74 65 64 20 | contributions.can.be.integrated. |
4c20 | 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 64 79 20 74 | without.the.need.for.everybody.t |
4c40 | 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 65 70 6f 73 | o.push.to.a.single.central.repos |
4c60 | 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 65 69 72 20 | itory..Developers.push.to.their. |
4c80 | 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 2c 20 61 6e | own.server-side.repositories,.an |
4ca0 | 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 72 20 63 61 | d.only.the.project.maintainer.ca |
4cc0 | 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 69 74 6f 72 | n.push.to.the.official.repositor |
4ce0 | 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 72 20 74 6f | y..This.allows.the.maintainer.to |
4d00 | 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 65 6c 6f 70 | .accept.commits.from.any.develop |
4d20 | 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 20 61 63 63 | er.without.giving.them.write.acc |
4d40 | 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 2e 00 54 68 | ess.to.the.official.codebase..Th |
4d60 | 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 69 66 20 61 | e.plugin.will.warn.on.build.if.a |
4d80 | 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 6d 65 20 69 | .headline.has.a.duplicate.name.i |
4da0 | 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 65 6e 74 20 | n.the.same.document..To.prevent. |
4dc0 | 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 74 20 61 20 | this.warning,.you.have.to.put.a. |
4de0 | 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 61 64 6c 69 | custom.link.on.top.of.the.headli |
4e00 | 6e 65 2e 00 54 68 65 72 65 20 61 72 65 20 61 20 66 65 77 20 74 68 69 6e 67 73 20 74 6f 20 6b 65 | ne..There.are.a.few.things.to.ke |
4e20 | 65 70 20 69 6e 20 6d 69 6e 64 20 77 68 65 6e 20 63 6f 6e 74 72 69 62 75 74 69 6e 67 20 74 6f 20 | ep.in.mind.when.contributing.to. |
4e40 | 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 66 6f 72 20 74 68 65 20 73 61 6b 65 20 | the.documentation,.for.the.sake. |
4e60 | 6f 66 20 63 6f 6e 73 69 73 74 65 6e 63 79 20 61 6e 64 20 72 65 61 64 61 62 69 6c 69 74 79 2e 00 | of.consistency.and.readability.. |
4e80 | 54 6f 20 65 78 74 72 61 63 74 20 61 20 64 65 66 61 75 6c 74 76 61 6c 75 65 20 66 72 6f 6d 20 74 | To.extract.a.defaultvalue.from.t |
4ea0 | 68 65 20 58 4d 4c 20 64 65 66 69 6e 69 74 69 6f 6e 73 20 61 64 64 20 61 20 60 60 3a 64 65 66 61 | he.XML.definitions.add.a.``:defa |
4ec0 | 75 6c 74 76 61 6c 75 65 3a 60 60 20 74 6f 20 60 60 2e 2e 20 63 66 67 63 6d 64 3a 3a 60 60 20 64 | ultvalue:``.to.``...cfgcmd::``.d |
4ee0 | 69 72 65 63 74 69 76 65 2e 20 54 6f 20 68 61 76 65 20 74 68 69 73 20 66 65 61 74 75 72 65 20 6c | irective..To.have.this.feature.l |
4f00 | 6f 63 61 6c 6c 79 2c 20 74 68 65 20 76 79 6f 73 2d 31 78 20 73 75 62 6d 6f 64 75 6c 65 20 6d 75 | ocally,.the.vyos-1x.submodule.mu |
4f20 | 73 74 20 62 65 20 69 6e 69 74 69 61 6c 69 7a 65 64 20 62 65 66 6f 72 65 2e 20 50 6c 65 61 73 65 | st.be.initialized.before..Please |
4f40 | 20 62 65 20 61 77 61 72 65 20 74 6f 20 6e 6f 74 20 75 70 64 61 74 65 20 74 68 65 20 73 75 62 6d | .be.aware.to.not.update.the.subm |
4f60 | 6f 64 75 6c 65 20 69 6e 20 79 6f 75 72 20 50 52 2e 00 54 6f 20 6d 69 6e 69 6d 69 7a 65 20 72 65 | odule.in.your.PR..To.minimize.re |
4f80 | 64 75 6e 64 61 6e 63 79 2c 20 74 68 65 72 65 20 69 73 20 61 20 73 70 65 63 69 61 6c 20 69 6e 63 | dundancy,.there.is.a.special.inc |
4fa0 | 6c 75 64 65 20 64 69 72 65 63 74 69 76 65 2e 20 49 74 20 69 6e 63 6c 75 64 65 73 20 61 20 74 78 | lude.directive..It.includes.a.tx |
4fc0 | 74 20 66 69 6c 65 20 61 6e 64 20 72 65 70 6c 61 63 65 20 74 68 65 20 60 60 7b 7b 20 76 61 72 30 | t.file.and.replace.the.``{{.var0 |
4fe0 | 20 7d 7d 60 60 20 2d 20 60 60 7b 7b 20 76 61 72 39 20 7d 7d 60 60 20 77 69 74 68 20 74 68 65 20 | .}}``.-.``{{.var9.}}``.with.the. |
5000 | 63 6f 72 72 65 63 74 20 76 61 6c 75 65 2e 00 54 72 79 20 6e 6f 74 20 74 6f 20 65 78 63 65 65 64 | correct.value..Try.not.to.exceed |
5020 | 20 38 30 20 63 68 61 72 61 63 74 65 72 73 20 70 65 72 20 6c 69 6e 65 2c 20 62 75 74 20 64 6f 6e | .80.characters.per.line,.but.don |
5040 | 27 74 20 62 72 65 61 6b 20 55 52 4c 73 20 6f 76 65 72 20 74 68 69 73 2e 00 55 6e 69 63 61 73 74 | 't.break.URLs.over.this..Unicast |
5060 | 20 4d 41 43 20 41 64 64 72 65 73 73 65 73 3a 20 60 60 30 30 2d 35 33 2d 30 30 60 60 20 74 6f 20 | .MAC.Addresses:.``00-53-00``.to. |
5080 | 60 60 30 30 2d 35 33 2d 46 46 60 60 00 55 70 64 61 74 65 73 20 74 6f 20 6f 75 72 20 64 6f 63 75 | ``00-53-FF``.Updates.to.our.docu |
50a0 | 6d 65 6e 74 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20 62 65 20 64 65 6c 69 76 65 72 65 64 20 62 79 | mentation.should.be.delivered.by |
50c0 | 20 61 20 47 69 74 48 75 62 20 70 75 6c 6c 2d 72 65 71 75 65 73 74 2e 20 54 68 69 73 20 72 65 71 | .a.GitHub.pull-request..This.req |
50e0 | 75 69 72 65 73 20 79 6f 75 20 61 6c 72 65 61 64 79 20 68 61 76 65 20 61 20 47 69 74 48 75 62 20 | uires.you.already.have.a.GitHub. |
5100 | 61 63 63 6f 75 6e 74 2e 00 55 73 65 20 41 6d 65 72 69 63 61 6e 20 45 6e 67 6c 69 73 68 20 61 74 | account..Use.American.English.at |
5120 | 20 61 6c 6c 20 74 69 6d 65 73 2e 20 49 74 27 73 20 61 6c 77 61 79 73 20 61 20 67 6f 6f 64 20 69 | .all.times..It's.always.a.good.i |
5140 | 64 65 61 20 74 6f 20 72 75 6e 20 79 6f 75 72 20 74 65 78 74 20 74 68 72 6f 75 67 68 20 61 20 67 | dea.to.run.your.text.through.a.g |
5160 | 72 61 6d 6d 61 72 20 61 6e 64 20 73 70 65 6c 6c 20 63 68 65 63 6b 65 72 2c 20 73 75 63 68 20 61 | rammar.and.spell.checker,.such.a |
5180 | 73 20 60 47 72 61 6d 6d 61 72 6c 79 60 5f 2e 00 55 73 65 20 6c 69 74 65 72 61 6c 20 62 6c 6f 63 | s.`Grammarly`_..Use.literal.bloc |
51a0 | 6b 73 20 66 6f 72 20 6c 6f 6e 67 65 72 20 73 6e 69 70 70 65 74 73 2e 00 56 69 65 77 20 6d 6f 64 | ks.for.longer.snippets..View.mod |
51c0 | 69 66 69 65 64 20 66 69 6c 65 73 20 62 79 20 63 61 6c 6c 69 6e 67 20 60 60 24 20 67 69 74 20 73 | ified.files.by.calling.``$.git.s |
51e0 | 74 61 74 75 73 60 60 2e 20 59 6f 75 20 77 69 6c 6c 20 67 65 74 20 61 6e 20 6f 76 65 72 76 69 65 | tatus``..You.will.get.an.overvie |
5200 | 77 20 6f 66 20 61 6c 6c 20 66 69 6c 65 73 20 6d 6f 64 69 66 69 65 64 20 62 79 20 79 6f 75 2e 20 | w.of.all.files.modified.by.you.. |
5220 | 59 6f 75 20 63 61 6e 20 61 64 64 20 69 6e 64 69 76 69 64 75 61 6c 20 66 69 6c 65 73 20 74 6f 20 | You.can.add.individual.files.to. |
5240 | 74 68 65 20 47 69 74 20 49 6e 64 65 78 20 69 6e 20 74 68 65 20 6e 65 78 74 20 73 74 65 70 2e 00 | the.Git.Index.in.the.next.step.. |
5260 | 56 79 4f 53 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e | VyOS.documentation.is.written.in |
5280 | 20 72 65 53 74 72 75 63 74 75 72 65 64 54 65 78 74 20 61 6e 64 20 67 65 6e 65 72 61 74 65 64 20 | .reStructuredText.and.generated. |
52a0 | 74 6f 20 52 65 61 64 20 74 68 65 20 44 6f 63 73 20 70 61 67 65 73 20 77 69 74 68 20 53 70 68 69 | to.Read.the.Docs.pages.with.Sphi |
52c0 | 6e 78 2c 20 61 73 20 70 65 72 20 74 68 65 20 50 79 74 68 6f 6e 20 74 72 61 64 69 74 69 6f 6e 2c | nx,.as.per.the.Python.tradition, |
52e0 | 20 61 73 20 77 65 6c 6c 20 61 73 20 50 44 46 20 66 69 6c 65 73 20 66 6f 72 20 6f 66 66 6c 69 6e | .as.well.as.PDF.files.for.offlin |
5300 | 65 20 75 73 65 20 74 68 72 6f 75 67 68 20 4c 61 54 65 58 2e 20 57 65 20 77 65 6c 63 6f 6d 65 20 | e.use.through.LaTeX..We.welcome. |
5320 | 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 74 68 | all.sorts.of.contributions.to.th |
5340 | 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 61 64 | e.documentation..Not.just.new.ad |
5360 | 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 6f 20 | ditions.but.also.corrections.to. |
5380 | 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 6f 75 | existing.documentation..We.encou |
53a0 | 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 73 20 | rage.every.VyOS.user.to.help.us. |
53c0 | 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 65 20 | improve.our.documentation.as.we. |
53e0 | 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 61 72 | have.a.deficit.like.most.softwar |
5400 | 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 70 73 | e.projects...This.not.only.helps |
5420 | 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 72 79 | .you.when.reading.but.also.every |
5440 | 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 20 73 | one.else..We.use.the.following.s |
5460 | 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 6d 65 | yntax.for.Headlines..When.docume |
5480 | 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 2e 2e | nting.CLI.commands,.use.the.``.. |
54a0 | 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 63 6f | .cfgcmd::``.directive.for.all.co |
54c0 | 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 65 78 | nfiguration.mode.commands..An.ex |
54e0 | 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 |
5500 | 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 |
5520 | 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 63 6f | atement..Replace.all.variable.co |
5540 | 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 6e 67 | ntents.with.<value>.or.something |
5560 | 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 72 61 | .similar..When.documenting.opera |
5580 | 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 20 60 | tional.level.commands,.use.the.` |
55a0 | 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 70 6c | `...opcmd::``.directive..An.expl |
55c0 | 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 6e 64 | anation.of.the.described.command |
55e0 | 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 61 74 | .should.be.added.below.this.stat |
5600 | 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 68 65 | ement..When.in.doubt,.follow.the |
5620 | 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 6f 6e | .style.of.existing.documentation |
5640 | 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 62 72 | ..When.referencing.to.VyOS.Phabr |
5660 | 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 6d 20 | icator.Tasks,.there.is.a.custom. |
5680 | 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 60 76 | Sphinx.Markup.command.called.``v |
56a0 | 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 64 65 | ytask``.that.automatically.rende |
56c0 | 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 2e 20 | rs.to.a.proper.Phabricator.URL.. |
56e0 | 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 65 66 | This.is.heavily.used.in.the.:ref |
5700 | 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 20 74 | :`release-notes`.section..With.t |
5720 | 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 73 73 | hose.custom.commands,.it.is.poss |
5740 | 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 64 65 | ible.to.render.them.in.a.more.de |
5760 | 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 20 48 | scriptive.way.in.the.resulting.H |
5780 | 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 74 6f | TML/PDF.manual..With.those.custo |
57a0 | 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 65 20 | m.commands,.it.will.be.possible. |
57c0 | 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 69 70 | to.render.them.in.a.more.descrip |
57e0 | 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 2f 50 | tive.way.in.the.resulting.HTML/P |
5800 | 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 00 59 | DF.manual..Write.Documentation.Y |
5820 | 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 61 6e | ou.can.either.install.Sphinx.(an |
5840 | 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 20 62 | d.TeX.Live.for.PDF.output).and.b |
5860 | 75 69 6c 64 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 6c 6f 63 61 6c 6c 79 2c 20 | uild.the.documentation.locally,. |
5880 | 6f 72 20 75 73 65 20 74 68 65 20 44 6f 63 6b 65 72 66 69 6c 65 5f 20 74 6f 20 62 75 69 6c 64 20 | or.use.the.Dockerfile_.to.build. |
58a0 | 69 74 20 69 6e 20 61 20 63 6f 6e 74 61 69 6e 65 72 2e 00 59 6f 75 72 20 72 65 6d 6f 74 65 20 72 | it.in.a.container..Your.remote.r |
58c0 | 65 70 6f 20 6f 6e 20 47 69 74 68 75 62 20 69 73 20 63 61 6c 6c 65 64 20 60 60 6f 72 69 67 69 6e | epo.on.Github.is.called.``origin |
58e0 | 60 60 2c 20 77 68 69 6c 65 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 72 65 70 6f 20 79 6f 75 20 | ``,.while.the.original.repo.you. |
5900 | 68 61 76 65 20 66 6f 72 6b 65 64 20 69 73 20 63 61 6c 6c 65 64 20 60 60 75 70 73 74 72 65 61 6d | have.forked.is.called.``upstream |
5920 | 60 60 2e 20 4e 6f 77 20 79 6f 75 20 63 61 6e 20 6c 6f 63 61 6c 6c 79 20 75 70 64 61 74 65 20 79 | ``..Now.you.can.locally.update.y |
5940 | 6f 75 72 20 66 6f 72 6b 65 64 20 72 65 70 6f 2e 00 60 60 31 39 32 2e 30 2e 32 2e 30 2f 32 34 60 | our.forked.repo..``192.0.2.0/24` |
5960 | 60 00 60 60 31 39 38 2e 35 31 2e 31 30 30 2e 30 2f 32 34 60 60 00 60 60 32 30 30 31 3a 64 62 38 | `.``198.51.100.0/24``.``2001:db8 |
5980 | 3a 3a 2f 33 32 60 60 00 60 60 32 30 33 2e 30 2e 31 31 33 2e 30 2f 32 34 60 60 00 60 60 3a 72 65 | ::/32``.``203.0.113.0/24``.``:re |
59a0 | 66 3a 60 43 68 65 63 6b 20 6f 75 74 20 56 4c 41 4e 3c 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2f | f:`Check.out.VLAN<configuration/ |
59c0 | 69 6e 74 65 72 66 61 63 65 73 2f 65 74 68 65 72 6e 65 74 3a 76 6c 61 6e 3e 60 60 00 60 60 3a 72 | interfaces/ethernet:vlan>``.``:r |
59e0 | 65 66 3a 60 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2f 69 6e 74 65 72 66 61 63 65 73 2f 65 74 68 | ef:`configuration/interfaces/eth |
5a00 | 65 72 6e 65 74 3a 76 6c 61 6e 60 60 00 60 60 73 65 74 20 66 69 72 65 77 61 6c 6c 20 7a 6f 6e 65 | ernet:vlan``.``set.firewall.zone |
5a20 | 60 60 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 60 60 66 69 72 65 77 61 6c 6c 2f 7a 6f 6e 65 | ``.is.written.in.``firewall/zone |
5a40 | 2e 72 73 74 60 60 00 60 60 73 65 74 20 69 6e 74 65 72 66 61 63 65 73 20 65 74 68 65 72 6e 65 74 | .rst``.``set.interfaces.ethernet |
5a60 | 60 60 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e 20 60 60 69 6e 74 65 72 66 61 63 65 73 2f 65 74 | ``.is.written.in.``interfaces/et |
5a80 | 68 65 72 6e 65 74 2e 72 73 74 60 60 00 63 66 67 63 6d 64 00 63 6d 64 69 6e 63 6c 75 64 65 00 68 | hernet.rst``.cfgcmd.cmdinclude.h |
5aa0 | 61 6e 64 6c 65 20 62 75 69 6c 64 20 65 72 72 6f 72 73 00 6f 70 63 6d 64 00 74 68 65 20 63 6f 6e | andle.build.errors.opcmd.the.con |
5ac0 | 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 6c 6f | tent.of.interface-address.txt.lo |
5ae0 | 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 61 74 | oks.like.this.to.use.an.alternat |
5b00 | 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 00 76 | ive.hyperlink.use.it.this.way:.v |
5b20 | 79 74 61 73 6b 00 | ytask. |