Merge pull request #1698 from natali-rs1985/T7801

vpp: T7801: Change log level from 'err' to 'error'

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+<!-- All PR should follow this template to allow a clean and transparent review -->
+<!-- Text placed between these delimiters is considered a comment and is not rendered -->
+
+## Change Summary
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Related Task(s)
+<!-- optional: Link related Tasks on Phabricator. -->
+* https://vyos.dev/Txxxx
+
+## Related PR(s)
+<!-- optional: Link here any PRs in other repositories that are related to this PR -->
+
+## Backport
+<!-- optional: the PR should backport to this documentation branch -->
+
+
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] I have read the [**CONTRIBUTING**](https://github.com/vyos/vyos-documentation/blob/current/CONTRIBUTING.md) document

.github/styles/Google/AMPM.yml

@@ -1,9 +0,0 @@
-extends: existence
-message: "Use 'AM' or 'PM' (preceded by a space)."
-link: 'https://developers.google.com/style/word-list'
-level: error
-nonword: true
-tokens:
-  - '\d{1,2}[AP]M'
-  - '\d{1,2} ?[ap]m'
-  - '\d{1,2} ?[aApP]\.[mM]\.'

.github/styles/Google/Acronyms.yml

@@ -1,64 +0,0 @@
-extends: conditional
-message: "Spell out '%s', if it's unfamiliar to the audience."
-link: 'https://developers.google.com/style/abbreviations'
-level: suggestion
-ignorecase: false
-# Ensures that the existence of 'first' implies the existence of 'second'.
-first: '\b([A-Z]{3,5})\b'
-second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
-# ... with the exception of these:
-exceptions:
-  - API
-  - ASP
-  - CLI
-  - CPU
-  - CSS
-  - CSV
-  - DEBUG
-  - DOM
-  - DPI
-  - FAQ
-  - GCC
-  - GDB
-  - GET
-  - GPU
-  - GTK
-  - GUI
-  - HTML
-  - HTTP
-  - HTTPS
-  - IDE
-  - JAR
-  - JSON
-  - JSX
-  - LESS
-  - LLDB
-  - NET
-  - NOTE
-  - NVDA
-  - OSS
-  - PATH
-  - PDF
-  - PHP
-  - POST
-  - RAM
-  - REPL
-  - RSA
-  - SCM
-  - SCSS
-  - SDK
-  - SQL
-  - SSH
-  - SSL
-  - SVG
-  - TBD
-  - TCP
-  - TODO
-  - URI
-  - URL
-  - USB
-  - UTF
-  - XML
-  - XSS
-  - YAML
-  - ZIP

.github/styles/Google/Colons.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "'%s' should be in lowercase."
-link: 'https://developers.google.com/style/colons'
-nonword: true
-level: warning
-tokens:
-  - ':\s[A-Z]'

.github/styles/Google/Contractions.yml

@@ -1,28 +0,0 @@
-extends: substitution
-message: "Feel free to use '%s' instead of '%s'."
-link: 'https://developers.google.com/style/contractions'
-level: suggestion
-ignorecase: true
-swap:
-  are not: aren't
-  cannot: can't
-  could not: couldn't
-  did not: didn't
-  do not: don't
-  does not: doesn't
-  has not: hasn't
-  have not: haven't
-  how is: how's
-  is not: isn't
-  it is: it's
-  should not: shouldn't
-  that is: that's
-  they are: they're
-  was not: wasn't
-  we are: we're
-  we have: we've
-  were not: weren't
-  what is: what's
-  when is: when's
-  where is: where's
-  will not: won't

.github/styles/Google/DateFormat.yml

@@ -1,9 +0,0 @@
-extends: existence
-message: "Use 'July 31, 2016' format, not '%s'."
-link: 'https://developers.google.com/style/dates-times'
-ignorecase: true
-level: error
-nonword: true
-tokens:
-  - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}'
-  - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}'

.github/styles/Google/Ellipses.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "In general, don't use an ellipsis."
-link: 'https://developers.google.com/style/ellipses'
-nonword: true
-level: warning
-tokens:
-  - '\.\.\.'

.github/styles/Google/EmDash.yml

@@ -1,8 +0,0 @@
-extends: existence
-message: "Don't put a space before or after an em dash."
-link: 'https://developers.google.com/style/dashes'
-nonword: true
-level: error
-tokens:
-  - '\s—'
-  - '—\s'

.github/styles/Google/EnDash.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Use an em dash ('—') instead of '–'."
-link: 'https://developers.google.com/style/dashes'
-nonword: true
-level: error
-tokens:
-  - '–'

.github/styles/Google/Exclamation.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Don't use exclamation points in text."
-link: 'https://developers.google.com/style/exclamation-points'
-nonword: true
-level: error
-tokens:
-  - '!'

.github/styles/Google/FirstPerson.yml

@@ -1,11 +0,0 @@
-extends: existence
-message: "Avoid first-person pronouns such as '%s'."
-link: 'https://developers.google.com/style/pronouns#personal-pronouns'
-ignorecase: true
-level: warning
-nonword: true
-tokens:
-  - (?:^|\s)I\s
-  - \bme\b
-  - \bus\b
-  - \bours\b

.github/styles/Google/Gender.yml

@@ -1,9 +0,0 @@
-extends: existence
-message: "Don't use '%s' as a gender-neutral pronoun."
-link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns'
-level: error
-ignorecase: true
-tokens:
-  - he/she
-  - s/he
-  - \(s\)he

.github/styles/Google/GenderBias.yml

@@ -1,45 +0,0 @@
-extends: substitution
-message: "Consider using '%s' instead of '%s'."
-link: 'https://developers.google.com/style/inclusive-documentation'
-ignorecase: true
-level: error
-swap:
-  (?:alumna|alumnus):          graduate
-  (?:alumnae|alumni):          graduates
-  air(?:m[ae]n|wom[ae]n):      pilot(s)
-  anchor(?:m[ae]n|wom[ae]n):   anchor(s)
-  authoress:                   author
-  camera(?:m[ae]n|wom[ae]n):   camera operator(s)
-  chair(?:m[ae]n|wom[ae]n):    chair(s)
-  congress(?:m[ae]n|wom[ae]n): member(s) of congress
-  door(?:m[ae]|wom[ae]n):      concierge(s)
-  draft(?:m[ae]n|wom[ae]n):    drafter(s)
-  fire(?:m[ae]n|wom[ae]n):     firefighter(s)
-  fisher(?:m[ae]n|wom[ae]n):   fisher(s)
-  fresh(?:m[ae]n|wom[ae]n):    first-year student(s)
-  garbage(?:m[ae]n|wom[ae]n):  waste collector(s)
-  lady lawyer:                 lawyer
-  ladylike:                    courteous
-  landlord:                    building manager
-  mail(?:m[ae]n|wom[ae]n):     mail carriers
-  man and wife:                husband and wife
-  man enough:                  strong enough
-  mankind:                     human kind
-  manmade:                     manufactured
-  manpower:                    personnel
-  men and girls:               men and women
-  middle(?:m[ae]n|wom[ae]n):   intermediary
-  news(?:m[ae]n|wom[ae]n):     journalist(s)
-  ombuds(?:man|woman):         ombuds
-  oneupmanship:                upstaging
-  poetess:                     poet
-  police(?:m[ae]n|wom[ae]n):   police officer(s)
-  repair(?:m[ae]n|wom[ae]n):   technician(s)
-  sales(?:m[ae]n|wom[ae]n):    salesperson or sales people
-  service(?:m[ae]n|wom[ae]n):  soldier(s)
-  steward(?:ess)?:             flight attendant
-  tribes(?:m[ae]n|wom[ae]n):   tribe member(s)
-  waitress:                    waiter
-  woman doctor:                doctor
-  woman scientist[s]?:         scientist(s)
-  work(?:m[ae]n|wom[ae]n):     worker(s)

.github/styles/Google/HeadingPunctuation.yml

@@ -1,8 +0,0 @@
-extends: existence
-message: "Don't put a period at the end of a heading."
-link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings'
-nonword: true
-level: warning
-scope: heading
-tokens:
-  - '[a-z0-9][.](?:\s|$)'

.github/styles/Google/Headings.yml

@@ -1,26 +0,0 @@
-extends: capitalization
-message: "'%s' should use sentence-style capitalization."
-link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings'
-level: warning
-scope: heading
-match: $sentence
-exceptions:
-  - Azure
-  - CLI
-  - Code
-  - Cosmos
-  - Docker
-  - Emmet
-  - I
-  - Kubernetes
-  - Linux
-  - macOS
-  - Marketplace
-  - MongoDB
-  - REPL
-  - Studio
-  - TypeScript
-  - URLs
-  - Visual
-  - VS
-  - Windows

.github/styles/Google/Hyphens.yml

@@ -1,8 +0,0 @@
-extends: existence
-message: "Don't place a space on either side of a hyphen (unless it's suspended)."
-link: 'https://developers.google.com/style/hyphens'
-level: warning
-nonword: true
-tokens:
-  - '\s-'
-  - '-\s'

.github/styles/Google/Latin.yml

@@ -1,9 +0,0 @@
-extends: substitution
-message: "Use '%s' instead of '%s'."
-link: 'https://developers.google.com/style/abbreviations'
-ignorecase: true
-level: error
-nonword: true
-swap:
-  '\b(?:eg|e\.g\.)[\s,]': for example
-  '\b(?:ie|i\.e\.)[\s,]': that is

.github/styles/Google/LyHyphens.yml

@@ -1,8 +0,0 @@
-extends: existence
-message: "'%s' doesn't need a hyphen."
-link: 'https://developers.google.com/style/hyphens'
-level: error
-ignorecase: false
-nonword: true
-tokens:
-  - '\s[^\s-]+ly-'

.github/styles/Google/OptionalPlurals.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Don't use plurals in parentheses such as in '%s'."
-link: 'https://developers.google.com/style/plurals-parentheses'
-level: error
-nonword: true
-tokens:
-  - '\b\w+\(s\)'

.github/styles/Google/Ordinal.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Spell out all ordinal numbers ('%s') in text."
-link: 'https://developers.google.com/style/numbers'
-level: error
-nonword: true
-tokens:
-  - \d+(?:st|th|rd)

.github/styles/Google/OxfordComma.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Use the Oxford comma in '%s'."
-link: 'https://developers.google.com/style/commas'
-scope: sentence
-level: warning
-tokens:
-  - '(?:[^,]+,){1,}\s\w+\sand'

.github/styles/Google/Parens.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Use parentheses judiciously."
-link: 'https://developers.google.com/style/parentheses'
-nonword: true
-level: suggestion
-tokens:
-  - '\(.+\)'

.github/styles/Google/Passive.yml

@@ -1,184 +0,0 @@
-extends: existence
-link: 'https://developers.google.com/style/voice'
-message: "In general, use active voice instead of passive voice ('%s')."
-ignorecase: true
-level: suggestion
-raw:
-  - \b(am|are|were|being|is|been|was|be)\b\s*
-tokens:
-  - '[\w]+ed'
-  - awoken
-  - beat
-  - become
-  - been
-  - begun
-  - bent
-  - beset
-  - bet
-  - bid
-  - bidden
-  - bitten
-  - bled
-  - blown
-  - born
-  - bought
-  - bound
-  - bred
-  - broadcast
-  - broken
-  - brought
-  - built
-  - burnt
-  - burst
-  - cast
-  - caught
-  - chosen
-  - clung
-  - come
-  - cost
-  - crept
-  - cut
-  - dealt
-  - dived
-  - done
-  - drawn
-  - dreamt
-  - driven
-  - drunk
-  - dug
-  - eaten
-  - fallen
-  - fed
-  - felt
-  - fit
-  - fled
-  - flown
-  - flung
-  - forbidden
-  - foregone
-  - forgiven
-  - forgotten
-  - forsaken
-  - fought
-  - found
-  - frozen
-  - given
-  - gone
-  - gotten
-  - ground
-  - grown
-  - heard
-  - held
-  - hidden
-  - hit
-  - hung
-  - hurt
-  - kept
-  - knelt
-  - knit
-  - known
-  - laid
-  - lain
-  - leapt
-  - learnt
-  - led
-  - left
-  - lent
-  - let
-  - lighted
-  - lost
-  - made
-  - meant
-  - met
-  - misspelt
-  - mistaken
-  - mown
-  - overcome
-  - overdone
-  - overtaken
-  - overthrown
-  - paid
-  - pled
-  - proven
-  - put
-  - quit
-  - read
-  - rid
-  - ridden
-  - risen
-  - run
-  - rung
-  - said
-  - sat
-  - sawn
-  - seen
-  - sent
-  - set
-  - sewn
-  - shaken
-  - shaven
-  - shed
-  - shod
-  - shone
-  - shorn
-  - shot
-  - shown
-  - shrunk
-  - shut
-  - slain
-  - slept
-  - slid
-  - slit
-  - slung
-  - smitten
-  - sold
-  - sought
-  - sown
-  - sped
-  - spent
-  - spilt
-  - spit
-  - split
-  - spoken
-  - spread
-  - sprung
-  - spun
-  - stolen
-  - stood
-  - stridden
-  - striven
-  - struck
-  - strung
-  - stuck
-  - stung
-  - stunk
-  - sung
-  - sunk
-  - swept
-  - swollen
-  - sworn
-  - swum
-  - swung
-  - taken
-  - taught
-  - thought
-  - thrived
-  - thrown
-  - thrust
-  - told
-  - torn
-  - trodden
-  - understood
-  - upheld
-  - upset
-  - wed
-  - wept
-  - withheld
-  - withstood
-  - woken
-  - won
-  - worn
-  - wound
-  - woven
-  - written
-  - wrung

.github/styles/Google/Periods.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Don't use periods with acronyms or initialisms such as '%s'."
-link: 'https://developers.google.com/style/abbreviations'
-level: error
-nonword: true
-tokens:
-  - '\b(?:[A-Z]\.){3,}'

.github/styles/Google/Quotes.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Commas and periods go inside quotation marks."
-link: 'https://developers.google.com/style/quotation-marks'
-level: error
-nonword: true
-tokens:
-  - '"[^"]+"[.,?]'

.github/styles/Google/Ranges.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Don't add words such as 'from' or 'between' to describe a range of numbers."
-link: 'https://developers.google.com/style/hyphens'
-nonword: true
-level: warning
-tokens:
-  - '(?:from|between)\s\d+\s?-\s?\d+'

.github/styles/Google/Semicolons.yml

@@ -1,8 +0,0 @@
-extends: existence
-message: "Use semicolons judiciously."
-link: 'https://developers.google.com/style/semicolons'
-nonword: true
-scope: sentence
-level: suggestion
-tokens:
-  - ';'

.github/styles/Google/Slang.yml

@@ -1,11 +0,0 @@
-extends: existence
-message: "Don't use internet slang abbreviations such as '%s'."
-link: 'https://developers.google.com/style/abbreviations'
-ignorecase: true
-level: error
-tokens:
-  - 'tl;dr'
-  - ymmv
-  - rtfm
-  - imo
-  - fwiw

.github/styles/Google/Spacing.yml

@@ -1,8 +0,0 @@
-extends: existence
-message: "'%s' should have one space."
-link: 'https://developers.google.com/style/sentence-spacing'
-level: error
-nonword: true
-tokens:
-  - '[.?!] {2,}[A-Z]'
-  - '[.?!][A-Z]'

.github/styles/Google/Spelling.yml

@@ -1,8 +0,0 @@
-extends: existence
-message: "In general, use American spelling instead of '%s'."
-link: 'https://developers.google.com/style/spelling'
-ignorecase: true
-level: warning
-tokens:
-  - '(?:\w+)nised?'
-  - '(?:\w+)logue'

.github/styles/Google/Units.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Put a nonbreaking space between the number and the unit in '%s'."
-link: 'https://developers.google.com/style/units-of-measure'
-nonword: true
-level: error
-tokens:
-  - \d+(?:GB|TB|MB)

.github/styles/Google/Will.yml

@@ -1,7 +0,0 @@
-extends: existence
-message: "Avoid using '%s'."
-link: 'https://developers.google.com/style/tense'
-ignorecase: true
-level: warning
-tokens:
-  - will

.github/styles/Google/WordList.yml

@@ -1,79 +0,0 @@
-extends: substitution
-message: "Use %s instead of '%s'."
-link: 'https://developers.google.com/style/word-list'
-level: warning
-ignorecase: false
-swap:
-  '(?:API Console|dev|developer) key': "'API key'"
-  '(?:cell ?phone|smart ?phone)': "'phone' or 'mobile phone'"
-  '(?:dev|developer|APIs) console': "'API console'"
-  '(?:e-mail|Email|E-mail)':  "'email'"
-  '(?:file ?path|path ?name)':  "'path'"
-  '(?:kill|terminate)': "'stop', 'exit', 'cancel', or 'end'"
-  '(?:OAuth ?2|Oauth)': "'OAuth 2.0'"
-  '(?:ok|Okay)': "'OK' or 'okay'"
-  '(?:WiFi|wifi)': "'Wi-Fi'"
-  '[\.]+apk': "'APK'"
-  '3\-D': "'3D'"
-  'Google (?:I\-O|IO)': "'Google I/O'"
-  'tap (?:&|and) hold': "'touch & hold'"
-  'un(?:check|select)': "'clear'"
-  abort: "'stop', 'exit', 'cancel' or 'end'"
-  above: "'preceding'"
-  account name: "'username'"
-  action bar: "'app bar'"
-  admin: "'administrator'"
-  Ajax: "'AJAX'"
-  Android device: "'Android-powered device'"
-  android: "'Android'"
-  API explorer: "'APIs Explorer'"
-  application: "'app'"
-  approx\.: "'approximately'"
-  authN: "'authentication'"
-  authZ: "'authorization'"
-  autoupdate: "'automatically update'"
-  cellular data: "'mobile data'"
-  cellular network: "'mobile network'"
-  chapter: "'documents', 'pages', 'sections'"
-  check box: "'checkbox'"
-  check: "'select'"
-  CLI: "'command-line tool'"
-  click on: "'click' or 'click in'"
-  Cloud: "'Google Cloud Platform' or 'GCP'"
-  Container Engine: "'Kubernetes Engine'"
-  content type: "'media type'"
-  curated roles: "'predefined roles'"
-  data are: "'data is'"
-  Developers Console: "'Google API Console' or 'API Console'"
-  disabled?: "'turn off' or 'off'"
-  ephemeral IP address: "'ephemeral external IP address'"
-  fewer data: "'less data'"
-  file name: "'filename'"
-  firewalls: "'firewall rules'"
-  functionality: "'capability' or 'feature'"
-  Google account: "'Google Account'"
-  Google accounts: "'Google Accounts'"
-  Googling: "'search with Google'"
-  grayed-out: "'unavailable'"
-  HTTPs: "'HTTPS'"
-  in order to: "'to'"
-  ingest: "'import' or 'load'"
-  k8s: "'Kubernetes'"
-  long press: "'touch & hold'"
-  network IP address: "'internal IP address'"
-  omnibox: "'address bar'"
-  open-source: "'open source'"
-  overview screen: "'recents screen'"
-  regex: "'regular expression'"
-  SHA1: "'SHA-1' or 'HAS-SHA1'"
-  sign into: "'sign in to'"
-  sign-?on: "'single sign-on'"
-  static IP address: "'static external IP address'"
-  stylesheet: "'style sheet'"
-  synch: "'sync'"
-  tablename: "'table name'"
-  tablet: "'device'"
-  touch: "'tap'"
-  url:  "'URL'"
-  vs\.: "'versus'"
-  World Wide Web: "'web'"

.github/styles/Google/meta.json

@@ -1,16 +0,0 @@
-{
-  "author": "Joseph Kato",
-  "description": "A Vale-compatible implementation of the Microsoft Writing Style Guide.",
-  "email": "support@errata.ai",
-  "lang": "en",
-  "url": "https://github.com/errata-ai/Google/releases/latest/download/Google.zip",
-  "feed": "https://github.com/errata-ai/Google/releases.atom",
-  "issues": "https://github.com/errata-ai/Google/issues/new",
-  "license": "MIT",
-  "name": "Google",
-  "sources": [
-    "https://developers.google.com/style/"
-  ],
-  "vale_version": ">=1.0.0",
-  "coverage": 0.0
-}

.github/styles/VyOS/Terminology.yml

@@ -1,9 +0,0 @@
-extends: substitution
-message: Prefer '%s' over '%s'
-ignorecase: false
-level: error
-swap:
-  vyos: VyOS
-  Vyos: VyOS
-  VYOS: VyOS
-  Gre: GRE

.github/vyos-linter.py

@@ -1,177 +0,0 @@
-import os
-import re
-import ipaddress
-import sys
-import ast
-
-IPV4SEG  = r'(?:25[0-5]|(?:2[0-4]|1{0,1}[0-9]){0,1}[0-9])'
-IPV4ADDR = r'\b(?:(?:' + IPV4SEG + r'\.){3,3}' + IPV4SEG + r')\b'
-IPV6SEG  = r'(?:(?:[0-9a-fA-F]){1,4})'
-IPV6GROUPS = (
-    r'(?:' + IPV6SEG + r':){7,7}' + IPV6SEG,                  # 1:2:3:4:5:6:7:8
-    r'(?:\s' + IPV6SEG + r':){1,7}:',                           # 1::                                 1:2:3:4:5:6:7::
-    r'(?:' + IPV6SEG + r':){1,6}:' + IPV6SEG,                 # 1::8               1:2:3:4:5:6::8   1:2:3:4:5:6::8
-    r'(?:' + IPV6SEG + r':){1,5}(?::' + IPV6SEG + r'){1,2}',  # 1::7:8             1:2:3:4:5::7:8   1:2:3:4:5::8
-    r'(?:' + IPV6SEG + r':){1,4}(?::' + IPV6SEG + r'){1,3}',  # 1::6:7:8           1:2:3:4::6:7:8   1:2:3:4::8
-    r'(?:' + IPV6SEG + r':){1,3}(?::' + IPV6SEG + r'){1,4}',  # 1::5:6:7:8         1:2:3::5:6:7:8   1:2:3::8
-    r'(?:' + IPV6SEG + r':){1,2}(?::' + IPV6SEG + r'){1,5}',  # 1::4:5:6:7:8       1:2::4:5:6:7:8   1:2::8
-    IPV6SEG + r':(?:(?::' + IPV6SEG + r'){1,6})',             # 1::3:4:5:6:7:8     1::3:4:5:6:7:8   1::8
-    r':(?:(?::' + IPV6SEG + r'){1,7}|:)',                     # ::2:3:4:5:6:7:8    ::2:3:4:5:6:7:8  ::8       ::
-    r'fe80:(?::' + IPV6SEG + r'){0,4}%[0-9a-zA-Z]{1,}',       # fe80::7:8%eth0     fe80::7:8%1  (link-local IPv6 addresses with zone index)
-    r'::(?:ffff(?::0{1,4}){0,1}:){0,1}[^\s:]' + IPV4ADDR,     # ::255.255.255.255  ::ffff:255.255.255.255  ::ffff:0:255.255.255.255 (IPv4-mapped IPv6 addresses and IPv4-translated addresses)
-    r'(?:' + IPV6SEG + r':){1,4}:[^\s:]' + IPV4ADDR,          # 2001:db8:3:4::192.0.2.33  64:ff9b::192.0.2.33 (IPv4-Embedded IPv6 Address)
-)
-IPV6ADDR = '|'.join(['(?:{})'.format(g) for g in IPV6GROUPS[::-1]])  # Reverse rows for greedy match
-
-MAC = r'([0-9A-F]{2}[:-]){5}([0-9A-F]{2})'
-
-NUMBER = r"([\s']\d+[\s'])"
-
-
-def lint_mac(cnt, line):
-    mac = re.search(MAC, line, re.I)
-    if mac is not None:
-        mac = mac.group()
-        u_mac = re.search(r'((00)[:-](53)([:-][0-9A-F]{2}){4})', mac, re.I)
-        m_mac = re.search(r'((90)[:-](10)([:-][0-9A-F]{2}){4})', mac, re.I)
-        if u_mac is None and m_mac is None:
-            return (f"Use MAC reserved for Documentation (RFC7042): {mac}", cnt, 'error')
-
-
-def lint_ipv4(cnt, line):
-    ip = re.search(IPV4ADDR, line, re.I)
-    if ip is not None:
-        ip = ipaddress.ip_address(ip.group().strip(' '))
-        # https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.is_private
-        if ip.is_private:
-            return None
-        if ip.is_multicast:
-            return None
-        if ip.is_global is False:
-            return None
-        return (f"Use IPv4 reserved for Documentation (RFC 5737) or private Space: {ip}", cnt, 'error')
-
-
-def lint_ipv6(cnt, line):
-    ip = re.search(IPV6ADDR, line, re.I)
-    if ip is not None:
-        ip = ipaddress.ip_address(ip.group().strip(' '))
-        if ip.is_private:
-            return None
-        if ip.is_multicast:
-            return None
-        if ip.is_global is False:
-            return None
-        return (f"Use IPv6 reserved for Documentation (RFC 3849) or private Space: {ip}", cnt, 'error')
-
-
-def lint_AS(cnt, line):
-    number = re.search(NUMBER, line, re.I)
-    if number:
-        pass
-        # find a way to detect AS numbers
-
-
-def lint_linelen(cnt, line):
-    line = line.rstrip()
-    if len(line) > 80:
-        return (f"Line too long: len={len(line)}", cnt, 'warning')
-
-def handle_file_action(filepath):
-    errors = []
-    try:
-        with open(filepath) as fp:
-            line = fp.readline()
-            cnt = 1
-            test_line_lenght = True
-            start_vyoslinter = True
-            indentation = 0
-            while line:
-                # search for ignore linter comments in lines
-                if ".. stop_vyoslinter" in line:
-                    start_vyoslinter = False
-                if ".. start_vyoslinter" in line:
-                    start_vyoslinter = True
-                if start_vyoslinter:
-                    # ignore every '.. code-block::' for line lenght
-                    # rst code-block have its own style in html the format in rst
-                    # and the build page must be the same
-                    if test_line_lenght is False:
-                        if len(line) > indentation:
-                            #print(f"'{line}'")
-                            #print(indentation)
-                            if line[indentation].isspace() is False:
-                                test_line_lenght = True
-
-                    if ".. code-block::" in line:
-                        test_line_lenght = False
-                        indentation = 0
-                        for i in line:
-                            if i.isspace():
-                                indentation = indentation + 1
-                            else:
-                                break
-                    
-                    err_mac = lint_mac(cnt, line.strip())
-                    # disable mac detection for the moment, too many false positives
-                    err_mac = None
-                    err_ip4 = lint_ipv4(cnt, line.strip())
-                    err_ip6 = lint_ipv6(cnt, line.strip())
-                    if test_line_lenght:
-                        err_len = lint_linelen(cnt, line)
-                    else:
-                        err_len = None
-                    if err_mac:
-                        errors.append(err_mac)
-                    if err_ip4:
-                        errors.append(err_ip4)
-                    if err_ip6:
-                        errors.append(err_ip6)
-                    if err_len:
-                        errors.append(err_len)
-                
-                line = fp.readline()
-                cnt += 1
-            
-            # ensure linter was not stop on top and forgot to tun on again
-            if start_vyoslinter == False:
-                errors.append((f"Don't forgett to turn linter back on", cnt, 'error'))
-    finally:
-        fp.close()
-
-    if len(errors) > 0:
-        '''
-        "::{$type} file={$filename},line={$line},col=$column::{$log}"
-        '''
-        print(f"File: {filepath}")
-        for error in errors:
-            print(f"::{error[2]} file={filepath},line={error[1]}::{error[0]}")
-        print('')
-        return False
-
-
-def main():
-    bool_error = True
-    print('start')
-    try:
-        files = ast.literal_eval(sys.argv[1])
-        for file in files:
-                if file[-4:] in [".rst", ".txt"] and "_build" not in file:
-                    if handle_file_action(file) is False:
-                        bool_error = False
-    except Exception as e:
-        for root, dirs, files in os.walk("docs"):
-            path = root.split(os.sep)
-            for file in files:
-                if file[-4:] in [".rst", ".txt"] and "_build" not in path:
-                    fpath = '/'.join(path)
-                    filepath = f"{fpath}/{file}"
-                    if handle_file_action(filepath) is False:
-                        bool_error = False
-
-    return bool_error
-
-
-if __name__ == "__main__":
-    if main() == False:
-        exit(1)

.github/workflows/auto-author-assign.yml

@@ -0,0 +1,14 @@
+name: "PR Triage"
+on:
+  pull_request_target:
+    types: [opened, reopened, ready_for_review, locked]
+
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  assign-author:
+    uses: vyos/.github/.github/workflows/assign-author.yml@current
+    secrets: inherit

.github/workflows/check-open-prs-conflict.yml

@@ -0,0 +1,17 @@
+name: "Open PRs Conflicts checker"
+on:
+  push:
+    branches:
+      - current
+      - sagitta
+      - circinus
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  check-pr-conflict-call:
+    uses: vyos/.github/.github/workflows/check-open-prs-conflict.yml@current
+    secrets: inherit

.github/workflows/check-pr-conflicts.yml

@@ -0,0 +1,14 @@
+
+name: "PR Conflicts checker"
+on:
+  pull_request_target:
+    types: [synchronize]
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  check-pr-conflict-call:
+    uses: vyos/.github/.github/workflows/check-pr-merge-conflict.yml@current
+    secrets: inherit

.github/workflows/cla-check.yml

@@ -0,0 +1,18 @@
+name: "CLA Check"
+
+permissions:
+  actions: write
+  contents: read
+  pull-requests: write
+  statuses: write
+
+on:
+  pull_request_target:
+    types: [opened, synchronize, closed]
+  issue_comment:
+    types: [created]
+
+jobs:
+  call-cla-assistant:
+    uses: vyos/vyos-cla-signatures/.github/workflows/cla-reusable.yml@current
+    secrets: inherit

.github/workflows/lint-doc.yml

@@ -0,0 +1,10 @@
+name: Lint Doc
+on:
+  pull_request:
+
+jobs:
+  lint-doc:
+    uses: vyos/.github/.github/workflows/lint-doc.yml@current
+    secrets: inherit
+    
+    

.github/workflows/main.yml

@@ -1,32 +0,0 @@
-name: Linting
-on:
-  pull_request:
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-
-    - name: File Changes
-      id: file_changes
-      uses: trilom/file-changes-action@v1.2.3
-
-    #- name: Vale
-    #  uses: errata-ai/vale-action@v1.3.0
-    #  with:
-    #    files: '${{ steps.file_changes.outputs.files_modified }}' 
-
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.x'
-
-    - name: run python based linter
-      run: python .github/vyos-linter.py '${{ steps.file_changes.outputs.files_modified }}'
-
-    env:
-      GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-    
-    

.github/workflows/submodules.yml

@@ -5,12 +5,82 @@ on:
   # 06:00 UTC on Monday
     - cron:  '0 6 * * 1'
 jobs:
-  updatVyOS-1x:
+  update_current:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
         with:
           repository: ${{ github.repository }}
+
+      - name: update submodule
+        run: |
+          git submodule status
+          git submodule update --init --force
+          cd docs/_include/vyos-1x
+          git checkout sagitta
+          git pull
+          git submodule status
+      - name: update releasenotes
+        env:
+          PHABRICATOR_API: ${{ secrets.PHABRICATOR_API }}
+        if: env.PHABRICATOR_API != null
+        run: |
+          pip3 install phabricator==0.8.0
+          python3 docs/_ext/releasenotes.py -t ${{ secrets.PHABRICATOR_API }} -b circinus sagitta equuleus
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ secrets.PR_ACTION_DOCUMENTATION_SUBMODULE_UPDATE }}
+          commit-message: "Github: update current branch"
+          title: "Github: update current branch"
+          body: |
+            Autoupdate vyos-1x submodule
+            update releasenotes
+          branch: update-dependencies-current
+          delete-branch: true
+
+  update_sagitta:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          repository: ${{ github.repository }}
+          ref: sagitta
+      - name: update submodule
+        run: |
+          git submodule status
+          git submodule update --init --force
+          cd docs/_include/vyos-1x
+          git checkout sagitta
+          git pull
+          git submodule status
+      - name: update releasenotes
+        env:
+          PHABRICATOR_API: ${{ secrets.PHABRICATOR_API }}
+        if: env.PHABRICATOR_API != null
+        run: |
+          pip3 install phabricator==0.8.0
+          python3 docs/_ext/releasenotes.py -t ${{ secrets.PHABRICATOR_API }} -b sagitta equuleus
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ secrets.PR_ACTION_DOCUMENTATION_SUBMODULE_UPDATE }}
+          commit-message: "Github: update sagitta branch"
+          title: "Github: update sagitta branch"
+          body: |
+            Autoupdate vyos-1x submodule
+            update releasenotes
+          branch: update-dependencies-sagitta
+          delete-branch: true
+
+
+  update_equuleus:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          repository: ${{ github.repository }}
+          ref: equuleus
       - name: update submodule
         run: |
           git submodule status
@@ -19,14 +89,21 @@ jobs:
           git checkout equuleus
           git pull
           git submodule status
+      - name: update releasenotes
+        env:
+          PHABRICATOR_API: ${{ secrets.PHABRICATOR_API }}
+        if: env.PHABRICATOR_API != null
+        run: |
+          pip3 install phabricator==0.8.0
+          python3 docs/_ext/releasenotes.py -t ${{ secrets.PHABRICATOR_API }} -b equuleus
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v3
+        uses: peter-evans/create-pull-request@v6
         with:
-          token: ${{secrets.GITHUB_TOKEN}}
-          commit-message: Update vyos-1x submodule
-          committer: GitHub <noreply@github.com>
-          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
-          title: Update vyos-1x submodule
+          token: ${{ secrets.PR_ACTION_DOCUMENTATION_SUBMODULE_UPDATE }}
+          commit-message: "Github: update equuleus branch"
+          title: "Github: update equuleus branch"
           body: |
             Autoupdate vyos-1x submodule
-          branch: update-dependencies
+            update releasenotes
+          branch: update-dependencies-equuleus
+          delete-branch: true

.github/workflows/update-translations.yml

@@ -0,0 +1,62 @@
+name: "translation: generate, upload, download"
+on:
+  workflow_dispatch:
+  schedule:
+  # 06:00 UTC on Monday
+    - cron:  '0 6 * * 1'
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      - name: Set Up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11.x
+
+      - name: install lxml dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y libxml2-dev libxslt-dev python3-lxml
+
+      - name: Install Dev Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Build Documentation
+        run: |
+          cd docs
+          make gettext
+          cd ..
+
+      - name: upload pot files
+        uses: localazy/upload@v1
+        with:
+          read_key: ${{ secrets.LOCALAZY_READ_KEY }}
+          write_key: ${{ secrets.LOCALAZY_WRITE_KEY }}
+
+      - name: download translation files
+        uses: localazy/download@v1
+        with:
+          read_key: ${{ secrets.LOCALAZY_READ_KEY }}
+          write_key: ${{ secrets.LOCALAZY_WRITE_KEY }}
+
+      - name: set file ownership
+        run: |
+          sudo chown -R 1001 docs/_locale
+  
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ secrets.PR_ACTION_DOCUMENTATION_SUBMODULE_UPDATE }}
+          commit-message: "Github: update translations"
+          title: "Github: update translations"
+          body: |
+            Generate, upload new and download translation files 
+          branch: update-translations-current
+          delete-branch: true
+    

.gitignore

@@ -1,10 +1,13 @@
 # Sphinx
 _build/
+localazy_private.json
 
 # python virtualenv
 venv/
 ENV/
 .venv
+Pipfile.lock
+Pipfile
 
 # put various editor ignores here
 .vscode/
@@ -12,6 +15,9 @@ ENV/
 *.vpw
 *.vpwhist
 *.vtg
+.idea/
+.idea
+.idea/*
 
 # python cache files
 *.pyc

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "docs/_include/vyos-1x"]
 	path = docs/_include/vyos-1x
 	url = https://github.com/vyos/vyos-1x
-	branch = equuleus
+	branch = sagitta

.readthedocs.yml

@@ -4,6 +4,10 @@
 
 # Required
 version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -19,9 +23,8 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
   install:
     - requirements: requirements.txt
 
 submodules:
-  include: all
+  include: all

CODEOWNERS

@@ -0,0 +1,2 @@
+# * @vyos/reviewers
+* @rebortg

CONTRIBUTING.md

@@ -1,4 +1,4 @@
 # Documentation Contribution
 
 Please follow the guide in our documentation. It can be found here:
-https://docs.vyos.io/en/latest/contributing/documentation.html
+https://docs.vyos.io/en/latest/documentation.html

Pipfile

@@ -1,16 +0,0 @@
-[[source]]
-url = "https://pypi.org/simple"
-verify_ssl = true
-name = "pypi"
-
-[packages]
-sphinx-rtd-theme = "*"
-docutils = "*"
-lxml = "*"
-sphinx-notfound-page = "*"
-Sphinx = ">=1.4.3"
-
-[dev-packages]
-
-[requires]
-python_version = "3.9"

README.md

@@ -1,29 +1,38 @@
-Starting with VyOS 1.2 (`crux`) documentation is being migrated from the old wiki
-to ReadTheDocs. Documentation can be accessed via the following URL:
+Starting with VyOS 1.2 (`crux`) our documentation is hosted on ReadTheDocs at https://docs.vyos.io
 
-* https://docs.vyos.io
+Our old wiki with documentation from the VyOS 1.1.x and early 1.2.0 era can still be accessed via the
+[Wayback Machine](https://web.archive.org/web/20200225171529/https://wiki.vyos.net/wiki/Main_Page)
 
 # Build
 
 [![Documentation Status](https://readthedocs.org/projects/vyos/badge/?version=latest)](https://docs.vyos.io/en/latest/?badge=latest)
 
-## Native
+# Versions
 
-To build the manual, run the following commands inside the `docs` folder:
+Our documentation repository follows the same branching scheme as the VyOS source itself.
+We maintain one documentation branch per VyOS release.
+The default branch that contains the most recent VyOS documentation is called `current`
+and matches the latest VyOS rolling release.
 
-* `make html` for an HTML manual
-* `make latexpdf` for a LaTeX rendered PDF
+All new documentation enhancements go to the `current` branch. If those changes
+are beneficial for previous VyOS documentation versions they will be
+cherry-picked to the appropriate branch(es).
 
-Required Debian Packages:
-* `latexmk`
-* `texlive-latex-recommended`
-* `texlive-fonts-recommended`
-* `texlive-latex-extra`
-* `sphinx`
+VyOS branches are named after constellations sorted by area from smallest to largest.
+There are 88 of them, here's the
+[complete list](https://en.wikipedia.org/wiki/IAU_designated_constellations_by_area).
 
-### sphinx
+The branches we have had so far:
+
+* 1.5.x: `circinus` (Compasses)
+* 1.4.x: `sagitta` (Arrow)
+* 1.3.x: `equuleus` (Little Horse)
+* 1.2.x: `crux` (Southern Cross)
+
+### Sphinx
 Debian requires some extra steps for
-installing `sphinx`, `sphinx-autobuild` and `sphinx-rtd-theme` packages:
+installing `sphinx`, `sphinx-autobuild`, `sphinx-notfound-page`, `sphinx-panels`,
+`sphinx-rtd-theme`, `lxml`, and `myst-parser` packages:
 
 First ensure that Python 2 & Python 3 are installed and Python 3 is the default:
 ```bash
@@ -52,11 +61,10 @@ python --version
 Then run:
 
 ```bash
-sudo pip install sphinx-rtd-theme
+sudo pip install sphinx-autobuild sphinx-notfound-page sphinx-panels sphinx-rtd-theme lxml myst-parser
 ```
 
-
-Do the following to build the HTML and start a webserver:
+Do the following to build the HTML and start a web server:
 * Run `make livehtml` inside the `docs` folder
 
 Then, to view the live output:
@@ -84,28 +92,26 @@ If the `vyos/vyos-documentation` container could not be found locally it will be
 automatically fetched from Dockerhub.
 
 ```bash
-$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \
-  -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make html
+$ git clone https://github.com/vyos/vyos-documentation.git
 
-# sphinx autobuild
-$ docker run --rm -it -p 8000:8000 -v "$(pwd)":/vyos -w /vyos/docs -e \
-  GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make livehtml
+$ cd vyos-documentation
+
+$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make html
+
+# For sphinx autobuild
+$ docker run --rm -it -p 8000:8000 -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make livehtml
 ```
 
 ### Test the docs
 
-Discuss in this Phabricator task: [T1731](https://phabricator.vyos.net/T1731)
-
-To test all files run:
+To test all files, run:
 
 ```bash
-$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \
-  -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale .
+$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale .
 ```
 
-to test a specific file (e.g. `clustering.rst`)
+to test a specific file (e.g. `quick-start.rst`)
 
 ```bash
-$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) \
-  -e GOSU_GID=$(id -g) vyos/vyos-documentation vale clustering.rst
+$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale quick-start.rst
 ```

docker/Dockerfile

@@ -1,7 +1,7 @@
 # Must be run with --privileged flag
 # Recommended to run the container with a volume mapped
 # in order to easy exprort images built to "external" world
-FROM debian:buster
+FROM debian:12
 LABEL authors="VyOS Maintainers <maintainers@vyos.io>"
 
 ENV DEBIAN_FRONTEND noninteractive
@@ -27,14 +27,14 @@ RUN apt-get update && apt-get install -y \
     curl \
     dos2unix
 
-
-
-RUN pip3 install Sphinx
-RUN pip3 install sphinx-rtd-theme
-RUN pip3 install sphinx-autobuild
-RUN pip3 install sphinx-notfound-page
-RUN pip3 install lxml
-
+RUN pip3 install --break-system-packages \
+    Sphinx \
+    sphinx-rtd-theme \
+    sphinx-autobuild \
+    sphinx-notfound-page \
+    lxml \
+    myst-parser \
+    sphinx_design
 
 # Cleanup
 RUN rm -rf /var/lib/apt/lists/*
@@ -42,15 +42,11 @@ RUN rm -rf /var/lib/apt/lists/*
 EXPOSE 8000
 
 # Allow password-less 'sudo' for all users in group 'sudo'
-RUN sed "s/^%sudo.*/%sudo\tALL=(ALL) NOPASSWD:ALL/g" -i /etc/sudoers && \
-    chmod a+s /usr/sbin/useradd /usr/sbin/groupadd /usr/sbin/gosu /usr/sbin/usermod
-
-# vale
-RUN curl -sfL https://install.goreleaser.com/github.com/ValeLint/vale.sh | sh -s v1.7.1
+RUN sed "s/^%sudo.*/%sudo\tALL=(ALL) NOPASSWD:ALL/g" -i /etc/sudoers
 
 COPY entrypoint.sh /usr/local/bin/entrypoint.sh
 
-# we need to convert the entrypoint with appropriate line endings, else
+# We need to convert the entrypoint with appropriate line endings, else
 # there will be an error:
 #     standard_init_linux.go:175: exec user process caused
 #     "no such file or directory"

docker/entrypoint.sh

@@ -23,10 +23,10 @@ if ! grep -q $NEW_GID /etc/group; then
     groupadd --gid $NEW_GID $USER_NAME
 fi
 
-useradd --shell /bin/bash --uid $NEW_UID --gid $NEW_GID --non-unique --create-home $USER_NAME
+useradd --shell /bin/bash --uid $NEW_UID --gid $NEW_GID --non-unique --create-home $USER_NAME --key UID_MIN=500
 usermod --append --groups sudo $USER_NAME
-sudo chown $NEW_UID:$NEW_GID /home/$USER_NAME
+chown $NEW_UID:$NEW_GID /home/$USER_NAME
 export HOME=/home/$USER_NAME
 
 # Execute process
-exec /usr/sbin/gosu $USER_NAME "$@"
+/usr/sbin/gosu $USER_NAME "$@"

docs/404.rst

@@ -7,4 +7,6 @@ Sorry, We could not find a page.
 Try using the search box or go to the release homepage:
 
   * `1.2.x (crux) <https://docs.vyos.io/en/crux/>`_
-  * `rolling release (equuleus) <https://docs.vyos.io/en/latest/>`_
+  * `1.3.x (equuleus) <https://docs.vyos.io/en/equuleus/>`_
+  * `1.4.x (sagitta) <https://docs.vyos.io/en/sagitta/>`_
+  * `rolling release (circinus) <https://docs.vyos.io/en/latest/>`_

docs/Makefile

@@ -27,3 +27,7 @@ livehtml:
 	sphinx-autobuild --host $(AUTOHOST) --port $(AUTOPORT) $(AUTOOPTS) \
 		"$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+
+defaultvalue: export VYOS_DEFAULT=True
+defaultvalue:	
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_ext/autosectionlabel.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+"""
+    sphinx.ext.autosectionlabel
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    Allow reference sections by :ref: role using its title.
+
+    :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+
+    from sphinx version 1.8.4 to get readthedocs working
+"""
+
+from docutils import nodes
+
+from sphinx.locale import __
+from sphinx.util import logging
+from sphinx.util.nodes import clean_astext
+
+if False:
+    # For type annotation
+    from typing import Any, Dict  # NOQA
+    from sphinx.application import Sphinx  # NOQA
+
+
+logger = logging.getLogger(__name__)
+
+if False:
+    # For type annotation
+    from typing import Any, Dict  # NOQA
+    from sphinx.application import Sphinx  # NOQA
+
+
+def register_sections_as_label(app, document):
+    # type: (Sphinx, nodes.Node) -> None
+    labels = app.env.domaindata['std']['labels']
+    anonlabels = app.env.domaindata['std']['anonlabels']
+    for node in document.traverse(nodes.section):
+        labelid = node['ids'][0]
+        docname = app.env.docname
+        ref_name = getattr(node[0], 'rawsource', node[0].astext())
+        if app.config.autosectionlabel_prefix_document:
+            name = nodes.fully_normalize_name(docname + ':' + ref_name)
+        else:
+            name = nodes.fully_normalize_name(ref_name)
+        sectname = clean_astext(node[0])
+
+        if name in labels:
+            if len(node['ids']) > 1:
+                continue
+            logger.warning(__('duplicate label %s, other instance in %s'),
+                           name, app.env.doc2path(labels[name][0]),
+                           location=node)
+
+        anonlabels[name] = docname, labelid
+        labels[name] = docname, labelid, sectname
+
+
+def setup(app):
+    # type: (Sphinx) -> Dict[unicode, Any]
+    app.add_config_value('autosectionlabel_prefix_document', False, 'env')
+    app.connect('doctree-read', register_sections_as_label)
+
+    return {
+        'version': 'builtin',
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }

docs/_ext/releasenotes.py

@@ -0,0 +1,116 @@
+from datetime import datetime
+from phabricator import Phabricator
+import argparse
+
+parser = argparse.ArgumentParser()
+parser.add_argument("-t", "--token", type=str, help="API token", required=True)
+parser.add_argument("-b", "--branch", nargs="+", help="List of github branches", required=True)
+
+args = parser.parse_args()
+
+
+phab = Phabricator(host='https://vyos.dev/api/', token=args.token)
+
+'''
+# code to find new PHIDs
+# show project ids
+projects = phab.project.query(limit=200)
+for project in projects.response['data']:
+    print(projects.response['data'][project]['phid'], projects.response['data'][project]['name'])
+'''
+
+# find phid here https://vyos.dev/conduit/method/project.query/
+projects = {
+    'equuleus': {
+        'phid': 'PHID-PROJ-zu26ui4vbmvykpjtepij',
+        'name': '1.3 Equuleus',
+        'filename': 'docs/changelog/1.3.rst',
+        'tasks': [],
+        'releasenotes': []
+    },
+    'sagitta': {
+        'phid': 'PHID-PROJ-m4utvy456e2shcprpq3b',
+        'name': '1.4 Sagitta',
+        'filename': 'docs/changelog/1.4.rst',
+        'tasks': [],
+        'releasenotes': []
+    },
+    'circinus': {
+        'phid': 'PHID-PROJ-cfi33xi3uijxyjsxoqzv',
+        'name': '1.5 Circinus',
+        'filename': 'docs/changelog/1.5.rst',
+        'tasks': [],
+        'releasenotes': []
+    }
+}
+
+for b in args.branch:
+    if b not in projects.keys():
+        raise Exception('given branch not defined')
+
+# get project tasks
+
+for project in projects:
+    if project not in args.branch:
+        continue
+
+    _after = None
+
+    # get tasks from API
+    while True:
+        #print(f'get {_after}')
+        _tasks = phab.maniphest.search(
+            constraints={
+                'projects': [projects[project]['phid']],
+                #'statuses': ['closed'],
+            },
+            after=_after)
+
+        projects[project]['tasks'].extend(_tasks.response['data'])
+        _after = _tasks.response['cursor']['after']
+        if _after is None:
+            break
+    
+    # prepare tasks for release notes
+    for task in projects[project]['tasks']:
+        if task['fields']['status']['value'] in ['resolved']:
+            #_info = phab.maniphest.info(task_id=task['id'])
+            #_info = _info.response
+            releasenote = {}
+            releasenote['type'] = task['fields']['subtype']
+            date = datetime.fromtimestamp(task['fields']['dateClosed'])
+            releasenote['closedate'] = date.strftime('%Y-%m-%d')
+            releasenote['name'] = task['fields']['name']
+            releasenote['id'] = task['id']
+            #print(f"{project}: {task['fields']['status']} {task['id']}")
+            projects[project]['releasenotes'].append(releasenote)
+    
+    projects[project]['releasenotes'] = sorted(
+                projects[project]['releasenotes'], key = lambda x: x['closedate'],
+                reverse=True
+    )
+    
+    rst_text = "#" * len(projects[project]['name'])
+    rst_text += f"\n{projects[project]['name']}\n"
+    rst_text += "#" * len(projects[project]['name'])
+    rst_text += "\n"
+
+    rst_text += "\n"
+    rst_text += "..\n"
+    rst_text += "   Please don't add anything by hand.\n"
+    rst_text += "   This file is managed by the script:\n"
+    rst_text += "   _ext/releasenotes.py\n"
+
+    date = None
+    for rn in projects[project]['releasenotes']:
+        if date != rn['closedate']:
+            rst_text += "\n\n"
+            rst_text += f"{rn['closedate']}\n"
+            underline = '=' * len(rn['closedate'])
+            rst_text += f"{underline}\n\n"
+        date = rn['closedate']
+        rst_text += f"* :vytask:`T{rn['id']}` ``({rn['type']}): {rn['name'].strip()}``\n"
+    
+    f = open(projects[project]['filename'], "w")
+    f.write(rst_text)
+    f.close()

docs/_ext/testcoverage.py

@@ -1,14 +1,13 @@
 '''
 generate json with all commands from xml for vyos documentation coverage
-
 '''
 
-
 import sys
 import os
 import json
 import re
 import logging
+import datetime
 
 from io import BytesIO
 from lxml import etree as ET
@@ -33,11 +32,32 @@ input_data = [
     }
 ]
 
+vyos_commands_dir = "_include/coverage"
+
 node_data = {
     'cfgcmd': {},
     'opcmd': {},
 }
 
+
+def get_vyos_commands():
+    return_data = None
+    for (dirpath, dirnames, filenames) in os.walk(vyos_commands_dir):
+        for file in filenames:
+            with open(f"{vyos_commands_dir}/{file}") as f:
+                data = json.load(f)
+            
+            if not return_data:
+                return_data = data
+            
+            # find latestes export
+            if datetime.datetime.fromisoformat(return_data['date']) < datetime.datetime.fromisoformat(data['date']):
+                return_data = data
+    
+    return return_data
+
+
+
 def get_properties(p):
     props = {}
     props['valueless'] = False
@@ -155,12 +175,18 @@ def get_properties(p):
 
 def process_node(n, f):
 
+
     props_elem = n.find("properties")
     children = n.find("children")
     command = n.find("command")
     children_nodes = []
     owner = n.get("owner")
     node_type = n.tag
+    defaultvalue = n.find("defaultValue")
+
+    if defaultvalue is not None:
+        defaultvalue = defaultvalue.text
+
 
     name = n.get("name")
     props = get_properties(props_elem)
@@ -198,7 +224,9 @@ def process_node(n, f):
         'children': children_nodes,
         'props': props,
         'command': test_command,
-        'filename': f
+        'filename': f,
+        'defaultvalue': defaultvalue
+
     }
     return node
 
@@ -212,9 +240,11 @@ def create_commands(data, parent_list=[], level=0):
         'tag_help': [],
         'level': level,
         'no_childs': False,
-        'filename': None
+        'filename': None,
+        'defaultvalue': None,
     }
     command['filename'] = data['filename']
+    command['defaultvalue'] = data['defaultvalue']
     command['name'].extend(parent_list)
     command['name'].append(data['name'])
 
@@ -298,7 +328,7 @@ def get_working_commands():
                 if not validator.validate(xml):
                     print(validator.error_log)
                     print("Interface definition file {0} does not match the schema!".format(f))
-                    sys.exit(1)
+                    #sys.exit(1)
             except Exception as e:
                 print("Failed to load the XML schema {0}".format(entry['schema_file']))
                 print(e)
@@ -328,6 +358,7 @@ def get_working_commands():
                     'children': [],
                     'command': node_data[kind][entry]['command'],
                     'filename': node_data[kind][entry]['filename'],
+                    'defaultvalue': node_data[kind][entry]['defaultvalue']
                 }
             config_tree_new[kind][node_0]['children'].extend(node_data[kind][entry]['children'])
     
@@ -337,7 +368,8 @@ def get_working_commands():
     }
     for kind in  config_tree_new:
         for e in config_tree_new[kind]:
-            result[kind].extend(create_commands(config_tree_new[kind][e]))
+            if config_tree_new[kind][e]['name']:
+                result[kind].extend(create_commands(config_tree_new[kind][e]))
     
     for cmd in result['cfgcmd']:
         cmd['cmd'] = " ".join(cmd['name'])
@@ -377,6 +409,4 @@ def override_element(l: list):
         el.getparent().remove(el)
 
 if __name__ == "__main__":
-    res = get_working_commands()
-    print(json.dumps(res))
-    #print(res['cfgcmd'][0])
+    get_vyos_commands()

docs/_ext/vyos.py

@@ -1,20 +1,25 @@
 import re
 import json
 import os
+from datetime import datetime
+from unittest import defaultTestLoader
 from docutils import io, nodes, utils, statemachine
 from docutils.parsers.rst.roles import set_classes
 from docutils.parsers.rst import Directive, directives, states
 
 from sphinx.util.docutils import SphinxDirective
 
-from testcoverage import get_working_commands
+from testcoverage import get_working_commands, get_vyos_commands
 
+from sphinx.util import logging
+
+logger = logging.getLogger(__name__)
 
 def setup(app):
 
     app.add_config_value(
         'vyos_phabricator_url',
-        'https://phabricator.vyos.net/',
+        'https://vyos.dev/',
         'html'
     )
 
@@ -24,6 +29,11 @@ def setup(app):
         #{"cfgcmd": [], "opcmd": []},
         'html'
     )
+    app.add_config_value(
+        'vyos_commands',
+        get_vyos_commands(),
+        'html'
+    )
     app.add_config_value(
         'vyos_coverage',
         {
@@ -73,7 +83,9 @@ def setup(app):
     app.add_directive('cfgcmd', CfgCmdDirective)
     app.add_directive('opcmd', OpCmdDirective)
     app.add_directive('cmdinclude', CfgInclude)
+    app.add_directive('cmdincludemd', CmdInclude)
     app.connect('doctree-resolved', process_cmd_nodes)
+    app.connect('doctree-read', handle_document_meta_data)
 
 class CfgcmdList(nodes.General, nodes.Element):
     pass
@@ -209,7 +221,7 @@ class CfgInclude(SphinxDirective):
             path = os.path.join(self.standard_include_path, path[1:-1])
         path = os.path.normpath(os.path.join(source_dir, path))
         path = utils.relative_path(None, path)
-        path = nodes.reprunicode(path)
+        path = str(path)
         encoding = self.options.get(
             'encoding', self.state.document.settings.input_encoding)
         e_handler=self.state.document.settings.input_encoding_error_handler
@@ -314,6 +326,47 @@ class CfgInclude(SphinxDirective):
         self.state_machine.insert_input(new_include_lines, path)
         return []
 
+class CmdInclude(SphinxDirective):
+    '''
+    2nd CMDInclude only for Markdown, just the migration process
+    '''
+    
+    has_content = False
+    required_arguments = 1
+    optional_arguments = 0
+    option_spec = {
+        'var0': str,
+        'var1': str,
+        'var2': str,
+        'var3': str,
+        'var4': str,
+        'var5': str,
+        'var6': str,
+        'var7': str,
+        'var8': str,
+        'var9': str
+    }
+    
+    def run(self):
+        include_file = self.env.relfn2path(self.arguments[0])
+
+        f = open(include_file[1], "r")
+        file_content = f.readlines()
+        f.close()
+        
+        new_include_lines = []
+        for line in file_content:
+            for i in range(10):
+                value = self.options.get(f'var{i}','')
+                if value == '':
+                    line = re.sub('\s?{{\s?var' + str(i) + '\s?}}',value,line)
+                else:
+                    line = re.sub('{{\s?var' + str(i) + '\s?}}',value,line)
+            new_include_lines.append(line)
+        
+        self.state._renderer.nested_render_text(''.join(new_include_lines), self.lineno)
+        return []
+
 
 class CfgcmdlistDirective(Directive):
     has_content = False
@@ -346,6 +399,21 @@ class OpcmdlistDirective(Directive):
         return [oplist]
 
 
+def get_default_value(title_text, config, cfgmode):
+    title_text = strip_cmd(title_text)
+    for cmd in config.vyos_working_commands[cfgmode]:
+        cmd_joined = ' '.join(cmd['name'])
+        cmd_striped = strip_cmd(cmd_joined)
+        if "table-size" in cmd['name']:
+            pass
+            #print(cmd)
+            #print(cmd_striped)
+            #print(title_text)
+            #print()
+        if cmd_striped == title_text:
+            if cmd['defaultvalue']:
+                return cmd['defaultvalue']
+    return None
 
 class CmdDirective(SphinxDirective):
 
@@ -358,19 +426,31 @@ class CmdDirective(SphinxDirective):
         content_list = []
         title_text = ''
         content_text = ''
+        defaultvalue = None
         has_body = False
 
         cfgmode = self.custom_class + "cmd"
+        try:
+            if '' in self.content:
+                index = self.content.index('')
+                title_list = self.content[0:index]
+                content_list = self.content[index + 1:]
 
-        if '' in self.content:
-            index = self.content.index('')
-            title_list = self.content[0:index]
-            content_list = self.content[index + 1:]
-            title_text = ' '.join(title_list)
-            content_text = '\n'.join(content_list)
-            has_body = True
-        else:
-            title_text = ' '.join(self.content)
+                title_text = ' '.join(title_list)
+                content_text = content_text + '\n'.join(content_list)
+                has_body = True
+            else:
+                title_list = self.content
+                title_text = ' '.join(title_list)
+        except Exception as e:
+            print("error", e)
+
+        # render defaultvalue
+        if os.getenv('VYOS_DEFAULT') or ':defaultvalue:' in title_text:
+            value = get_default_value(title_list, self.config, cfgmode)
+            title_text = title_text.replace(":defaultvalue:", '')
+            if value:
+                defaultvalue = f"default: {value}\n"
 
         anchor_id = nodes.make_id(self.custom_class + "cmd-" + title_text)
         target = nodes.target(ids=[anchor_id])
@@ -392,6 +472,11 @@ class CmdDirective(SphinxDirective):
         heading_element['classes'] += [self.custom_class + 'cmd-heading']
 
         panel_element.append(heading_element)
+        if defaultvalue:
+            defaultvalue_element = nodes.paragraph(text=defaultvalue)
+            defaultvalue_element['classes'] = ["defaultvalue"]
+            panel_element.append(defaultvalue_element)
+
 
         append_list = {
             'docname': self.env.docname,
@@ -432,26 +517,53 @@ class CfgCmdDirective(CmdDirective):
 
 
 def strip_cmd(cmd, debug=False):
+
+    # find all [...] and also nested [...]
+    # regex and str.find() had problems with nested [...]
+    appearance = 0
+    cmd_new = ""
+    for c in cmd:
+        if c == "[":
+            appearance = appearance + 1
+        if appearance == 0:
+            cmd_new = f"{cmd_new}{c}"
+        if c == "]":
+            appearance = appearance - 1
+
+    # only if all [..] will be delete if appearance > 0 there is a syntax error
+    if appearance == 0:
+        cmd = cmd_new
+    
+    # same for <...>
+    appearance = 0
+    cmd_new = ""
+    for c in cmd:
+        if c == "<":
+            appearance = appearance + 1
+        if appearance == 0:
+            cmd_new = f"{cmd_new}{c}"
+        if c == ">":
+            appearance = appearance - 1
+
+    # only if all <..> will be delete if appearance > 0 there is a syntax error
+    if appearance == 0:
+        cmd = cmd_new
+
     if debug:
         print("")
         print(cmd)
-    cmd = re.sub('set','',cmd)
+    cmd = re.sub('^set','',cmd)
     if debug:
         print(cmd)
-    #while " | " in cmd:
-    cmd = re.sub('\s+\|\s+','',cmd)
-    if debug:
-        print(cmd)
-    cmd = re.sub('<\S*>','',cmd)
-    if debug:
-        print(cmd)
-    cmd = re.sub('\[\S\]','',cmd)
+    cmd = cmd.replace('|','')
     if debug:
         print(cmd)
     cmd = re.sub('\s+','',cmd)
+    cmd = cmd.replace(':defaultvalue:','')
     if debug:
         print(cmd)
         print("")
+    
     return cmd
 
 def build_row(app, fromdocname, rowdata):   
@@ -467,10 +579,10 @@ def build_row(app, fromdocname, rowdata):
                     entry += nodes.paragraph(text=item)
         elif isinstance(cell, bool):
             if cell:
-                entry += nodes.paragraph(text="")
+                entry += nodes.paragraph(text="✔")
                 entry['classes'] = ['coverage-ok']
             else:
-                entry += nodes.paragraph(text="")
+                entry += nodes.paragraph(text="✕")
                 entry['classes'] = ['coverage-fail']
         else:
             entry += nodes.paragraph(text=cell)
@@ -478,30 +590,28 @@ def build_row(app, fromdocname, rowdata):
 
 
 
-def process_coverage(app, fromdocname, doccmd, xmlcmd, cli_type):
+def process_coverage(app, fromdocname, doccmd, xmlcmd, vyoscmd, cli_type):
     coverage_list = {}
-    int_docs = 0
-    int_xml = 0
+    strip_true_list = []
     for cmd in doccmd:
         coverage_item = {
             'doccmd': None,
             'xmlcmd': None,
+            'vyoscmd': None,
             'doccmd_item': None,
             'xmlcmd_item': None,
+            'vyoscmd_item': None,
             'indocs': False,
             'inxml': False,
+            'invyos': False,
             'xmlfilename': None
         }
         coverage_item['doccmd'] = cmd['cmd']
         coverage_item['doccmd_item'] = cmd
         coverage_item['indocs'] = True
-        int_docs += 1
 
         coverage_list[strip_cmd(cmd['cmd'])] = dict(coverage_item)
 
-    
-    #print(coverage_list.keys())
-    
     for cmd in xmlcmd:
         
         strip = strip_cmd(cmd['cmd'])
@@ -509,34 +619,69 @@ def process_coverage(app, fromdocname, doccmd, xmlcmd, cli_type):
             coverage_item = {
                 'doccmd': None,
                 'xmlcmd': None,
+                'vyoscmd': None,
                 'doccmd_item': None,
                 'xmlcmd_item': None,
+                'vyoscmd_item': None,
                 'indocs': False,
                 'inxml': False,
+                'invyos': False,
                 'xmlfilename': None
             }
             coverage_item['xmlcmd'] = cmd['cmd']
             coverage_item['xmlcmd_item'] = cmd
             coverage_item['inxml'] = True
             coverage_item['xmlfilename'] = cmd['filename']
-            int_xml += 1
             coverage_list[strip] = dict(coverage_item)
         else:
             coverage_list[strip]['xmlcmd'] = cmd['cmd']
             coverage_list[strip]['xmlcmd_item'] = cmd
             coverage_list[strip]['inxml'] = True
             coverage_list[strip]['xmlfilename'] = cmd['filename']
-            int_xml += 1
 
+    
+    for item in vyoscmd[cli_type]:
+        cmd = ' '.join(item['cmd'])
+        strip = strip_cmd(cmd)
+        if strip not in coverage_list.keys():
+            coverage_item = {
+                'doccmd': None,
+                'xmlcmd': None,
+                'vyoscmd': None,
+                'doccmd_item': None,
+                'xmlcmd_item': None,
+                'vyoscmd_item': None,
+                'indocs': False,
+                'inxml': False,
+                'invyos': False,
+                'xmlfilename': None
+            }
+            coverage_item['vyoscmd'] = cmd
+            coverage_item['invyos'] = True
+            coverage_list[strip] = dict(coverage_item)
+        else:
+            coverage_list[strip]['vyoscmd'] = cmd
+            coverage_list[strip]['invyos'] = True
+            if coverage_list[strip]['indocs'] and coverage_list[strip]['inxml']:
+                strip_true_list.append(strip)
+
+    
+
+    strip_true_list = list(set(strip_true_list))
+
+    # to find syntax errors in cfg or cmd commands
+    #for k in coverage_list.keys():
+    #    if ("[" in k) or ("]" in k) or ("<" in k) or (">" in k) or ("|" in k):
+    #        print(coverage_list[k])
 
     
 
     table = nodes.table()
-    tgroup = nodes.tgroup(cols=3)
+    tgroup = nodes.tgroup(cols=4)
     table += tgroup
 
-    header = (f'{int_docs}/{len(coverage_list)} in Docs', f'{int_xml}/{len(coverage_list)} in XML', 'Command')
-    colwidths = (1, 1, 8)
+    header = (f'Status {len(strip_true_list)}/{len(coverage_list)}', 'Documentation', 'XML', f'in VyOS {vyoscmd["os"]}')
+    colwidths = (5, 33 , 33, 33)
     table = nodes.table()
     tgroup = nodes.tgroup(cols=len(header))
     table += tgroup
@@ -548,28 +693,42 @@ def process_coverage(app, fromdocname, doccmd, xmlcmd, cli_type):
     tbody = nodes.tbody()
     tgroup += tbody
     for entry in sorted(coverage_list):
-        body_text_list = []
+        doc_cmd_text = []
+        doc_xml_text = []
+        doc_vyos_text = []
         if coverage_list[entry]['indocs']:
-            body_text_list.append(coverage_list[entry]['doccmd_item'])
+            doc_cmd_text.append(coverage_list[entry]['doccmd_item'])
         else:
-            body_text_list.append('Not documented yet')
+            doc_cmd_text.append('not yet documented')
 
         if coverage_list[entry]['inxml']:
-            body_text_list.append("------------------")
-            body_text_list.append(str(coverage_list[entry]['xmlfilename']) + ":")
-            body_text_list.append(coverage_list[entry]['xmlcmd'])
+            doc_xml_text.append(str(coverage_list[entry]['xmlfilename']) + ":")
+            doc_xml_text.append(coverage_list[entry]['xmlcmd'])
         else:
-            body_text_list.append('Nothing found in XML Definitions')
+            doc_xml_text.append('Nothing found in XML Definitions')
+        
+        if coverage_list[entry]['invyos']:
+            doc_vyos_text.append(coverage_list[entry]['vyoscmd'])
+        else:
+            doc_vyos_text.append('Nothing found in VyOS')
 
-            
+
+        if not coverage_list[entry]['indocs'] or not coverage_list[entry]['inxml'] or not coverage_list[entry]['invyos']:
+            status = False
+        else:
+            status = True
+        
         tbody += build_row(app, fromdocname, 
             (
-                coverage_list[entry]['indocs'],
-                coverage_list[entry]['inxml'],
-                body_text_list
+                status,
+                doc_cmd_text,
+                doc_xml_text,
+                doc_vyos_text
+
             )
         )
 
+    table['ids'] = [f'table-{cli_type}']
     return table
 
 def process_cmd_node(app, cmd, fromdocname, cli_type):
@@ -599,6 +758,7 @@ def process_cmd_nodes(app, doctree, fromdocname):
                         fromdocname,
                         env.vyos_cfgcmd,
                         app.config.vyos_working_commands['cfgcmd'],
+                        app.config.vyos_commands,
                         'cfgcmd'
                         )
                     )
@@ -616,6 +776,7 @@ def process_cmd_nodes(app, doctree, fromdocname):
                         fromdocname,
                         env.vyos_opcmd,
                         app.config.vyos_working_commands['opcmd'],
+                        app.config.vyos_commands,
                         'opcmd'
                         )
                     )
@@ -640,4 +801,21 @@ def vytask_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
 
 def cmd_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
     node = nodes.literal(text, text)
-    return [node], []
+    return [node], []
+
+
+def handle_document_meta_data(app, document):
+    docname = app.env.docname
+    lastproofread = app.env.metadata[docname].get('lastproofread', False)
+    if lastproofread:
+        try:
+            lastproofread_time = datetime.strptime(lastproofread, '%Y-%m-%d')
+            delta = datetime.now() - lastproofread_time
+            if delta.days > 365:
+                logger.warning(f'{delta.days} days since last proofread {app.env.doc2path(docname)}')
+
+        except Exception as e:
+            logger.warning(f'lastproofread meta data error in {app.env.doc2path(docname)}: {e}')
+    else:
+        pass
+        #logger.warning(f'lastproofread meta data missing in {app.env.doc2path(docname)}')

docs/_html_extra/robots.txt

@@ -0,0 +1,7 @@
+User-agent: atlassian-bot
+Disallow: 
+
+User-agent: *
+Disallow: # Allow everything
+
+Sitemap: https://docs.vyos.io/sitemap.xml

docs/_include/common-references.txt

@@ -2,8 +2,10 @@
 
 .. _`accel-ppp`: https://accel-ppp.org/
 .. _`Secure Socket Tunneling Protocol`: https://en.wikipedia.org/wiki/Secure_Socket_Tunneling_Protocol
-.. _Phabricator: https://phabricator.vyos.net/
+.. _Phabricator: https://vyos.dev/
 .. _802.1ad: https://en.wikipedia.org/wiki/IEEE_802.1ad
 .. _802.1q: https://en.wikipedia.org/wiki/IEEE_802.1Q
+.. _`VyOS CI`: https://ci.vyos.net
+.. _vyos-build: https://github.com/vyos/vyos-build
 
-.. start_vyoslinter
+.. start_vyoslinter

docs/_include/draw.io/vpn_s2s_ikev2_c.drawio

@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2021-06-29T11:55:47.927Z" agent="5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36" etag="Bz4WAiXHzjjCvDkoEJPw" version="14.8.1" type="device"><diagram id="aAslkehIyZXHwb55RWRM" name="Page-1">7VpLc6M4EP41PpoCSbyOdhLPHjJVmUpVNnuUQbapBeQFObb3168EwjwkPzJrHKcK5xDUEq1W99etVosRfEh2PzK8Xv2kIYlHwAx3I/g4AgDYjsf/Ccq+pFi2bZaUZRaFklYTXqN/iSRWwzZRSPLWQEZpzKJ1mxjQNCUBa9FwltFte9iCxu1Z13hJFMJrgGOV+mcUslVJ9apVCPofJFquqpktU/YkuBosCfkKh3TbIMGnEXzIKGXlU7J7ILHQXqWX8r3Zkd6DYBlJ2SUvPMcQwd02m7w95GM/fv71vsVjyeUDxxu5YCks21cayOgmDYlgYo3gdLuKGHld40D0brnROW3Fklh2q0JVM5CMkV2DJIX8QWhCWLbnQ2TvGNlO+Y7EzBjaksm2tgBCqKStGtqHsLK8tPrywL1WDH+QuvmEnsAd6skyPXh3ioLnFcUdYS0ek91SBA0jiPKAGlx9jGS5/N/WVojzVaFZkzcWURw/0JhmBTdoQsfzXU7PWUb/Jo2eRfE79FTuy1U6FVqOuJM/4zmJX2gesYimvG9OGaNJY8Akjpaig1FhwNrEQpCDQ4tGQJMoqCSkKZvhJIqFXd5IFuIUS7IMcBa4GgZs1MYA8G0FA9DTYMDy/J4wgAYM3BIDCN4fBOwBAreEgItcw26DwLPgV4PAOQ8CEvJsSzZzsky4Dp5q0pSk4UQkcbw3pSlpw4HsIvYudM2XXrb+kpoXz4+7ZmPfsEkDG1M4mzmOiqbQJl6IdGhynCmYzRQ0QTnRC8kirjyB3HLylCuyFLIwdtEuxDT8qllLWrT2zZbKL5xFwgpF6yh0crrJAnJ+m2Y4WxJ23o+FmU4CsQGyKjVuYqyiZSTGLPpo59Y63MkZXmjEV1bj3HOg4cH610l/gNPmWKpBMmmmxgpf/xRf13cNp/Gz27OUSlRm4cDF+8awtRiQn1zckTh+XOzuG8g984ZrWiff4A+l3LXXH6z8+4HAHQJBIxB43h0FAvQ9AwFyQMthzY7L8iO60XHTi4MBdC3DUt29Ym07liZWXDsYAAQ+6dqoKpnc1LU9jWs7Mbf2dM4flqwAZ0kQLtdyeuefDa06xnmREk34AMtb7+rOiovlA24VzzANvswZQBVX3igZtyfj5IYAnWDD0yrWDiFt95YhphkLJAnLRDDgjlakp90MMYnCsIhYugJAO3G8RuKn7AC2qeb+FrJVT6zKUlfP+vxbIcIA9oCCclfvosCpij7NQpB7QxBUsegGKBBTDSAAYx+Y3TMgrElfBgRdhXkIB70iAZl3Fw509fMhHPQJAtCtCh5q/l8GAt3dQD+5ostzRc8AJhiSxebBxr+7ZNHS3RVcAwIfLKojwTzrWjxf4/Q4861cumCf0izBsQZjpjiKGGL9wrEOQCo5K/hqw64DsTOXhRfWm9uFCGt0UQUajZSax8IWf0dxLl6WolsaTJcl8mvA1TK7R2/f0qQzoDr7t+oMsC/A6m42vhNg4QDYvgCr1Gx886vRqruC+Z9bLkA6+GbFaoZttijEKZmX9himKY/2t8/qSvC9ACEmiwEHcv9C3QsqXQreEwze8zeeBrNfP6eTcLcC28dJvNB+7tVztfbUpqZSvjtiFHhoQHSimotQt4TjWuoewhOjG2JGd3TvWKBxOxfEOM/FDq9+7da5O7pIMze6TnL9zs7tmh11Xnx7pLByvA6rI1dEv3Ejo7XX7U/Z1kknv45LZ4SLg+fFAOFueMNoLlPCT3myvHnj09jTkf2oDwzaANKDv9tO198PaGn6O7zOHsGb9efGJdzqr7bh038=</diagram></mxfile>

docs/_include/interface-address-with-dhcp.txt

@@ -11,11 +11,19 @@
   * **dhcpv6** interface address is received by DHCPv6 from a DHCPv6
     server on this segment.
 
+  .. note:: When using DHCP to retrieve IPv4 address and if local
+     customizations are needed, they should be possible using the enter and
+     exit hooks provided. The hook dirs are:
+
+     * ``/config/scripts/dhcp-client/pre-hooks.d/``
+     * ``/config/scripts/dhcp-client/post-hooks.d/``
+
+
   Example:
 
   .. code-block:: none
 
     set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} address 192.0.2.1/24
     set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} address 2001:db8::1/64
-    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp
-    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} address dhcp
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} address dhcpv6

docs/_include/interface-common-without-mac.txt

@@ -0,0 +1,31 @@
+.. cmdinclude:: /_include/interface-description.txt
+  :var0: {{ var0 }}
+  :var1: {{ var1 }}
+
+.. cmdinclude:: /_include/interface-disable.txt
+  :var0: {{ var0 }}
+  :var1: {{ var1 }}
+
+.. cmdinclude:: /_include/interface-disable-flow-control.txt
+  :var0: {{ var0 }}
+  :var1: {{ var1 }}
+
+.. cmdinclude:: /_include/interface-disable-link-detect.txt
+  :var0: {{ var0 }}
+  :var1: {{ var1 }}
+
+.. cmdinclude:: /_include/interface-mtu.txt
+  :var0: {{ var0 }}
+  :var1: {{ var1 }}
+
+.. cmdinclude:: /_include/interface-ip.txt
+  :var0: {{ var0 }}
+  :var1: {{ var1 }}
+
+.. cmdinclude:: /_include/interface-ipv6.txt
+  :var0: {{ var0 }}
+  :var1: {{ var1 }}
+
+.. cmdinclude:: /_include/interface-vrf.txt
+  :var0: {{ var0 }}
+  :var1: {{ var1 }}

docs/_include/interface-dhcp-options.txt

@@ -28,6 +28,11 @@
 .. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
   {{ var5 }} {{ var6 }} dhcp-options vendor-class-id <vendor-id>
 
+  This option is used by some DHCP clients to identify the vendor type and
+  possibly the configuration of a DHCP client. The information is a string of
+  bytes whose contents are specific to the vendor and are not specified in a
+  standard.
+
   The vendor-class-id option can be used to request a specific class of vendor
   options from the server.
 
@@ -48,3 +53,43 @@
   .. code-block:: none
 
     set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options no-default-route
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+  {{ var5 }} {{ var6 }} dhcp-options default-route-distance <distance>
+
+  Set the distance for the default gateway sent by the DHCP server.
+
+  Example:
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options default-route-distance 220
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+  {{ var5 }} {{ var6 }} dhcp-options reject <address>
+
+  Reject DHCP leases from a given address or range.
+  This is useful when a modem gives a local IP when first starting.
+
+  * **address** can be specified multiple times,
+    e.g. 192.168.100.1 and/or 192.168.100.0/24
+
+  Example:
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options reject 192.168.100.0/24
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+  {{ var5 }} {{ var6 }} dhcp-options user-class <string>
+
+  This option is used by some DHCP clients as a way for users to specify
+  identifying information to the client. This can be used in a similar way to
+  the vendor-class-identifier option, but the value of the option is specified
+  by the user, not the vendor.
+
+  Example:
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options user-class VyOS

docs/_include/interface-dhcpv6-options.txt

@@ -11,6 +11,17 @@
 
     set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} duid '0e:00:00:01:00:01:27:71:db:f0:00:50:56:bf:c5:6d'
 
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+  {{ var5 }} {{ var6 }} dhcpv6-options no-release
+
+  When no-release is specified, dhcp6c will avoid sending a release message on
+  client exit in order to prevent losing an assigned address or prefix.
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options no-release
+
+
 .. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
   {{ var5 }} {{ var6 }} dhcpv6-options parameters-only
 

docs/_include/interface-dhcpv6-prefix-delegation.txt

@@ -24,7 +24,7 @@ networks.
   {{ var5 }} {{ var6 }} dhcpv6-options pd <id> interface <delegatee>
   address <address>
 
-  Specify the interface address used locally on the interfcae where the prefix
+  Specify the interface address used locally on the interface where the prefix
   has been delegated to. ID must be a decimal integer.
 
   It will be combined with the delegated prefix and the sla-id to form a

docs/_include/interface-eapol.txt

@@ -7,31 +7,35 @@ EAPoL comes with an identify option. We automatically use the interface MAC
 address as identity parameter.
 
 .. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
-  {{ var5 }} {{ var6 }} eapol ca-cert-file <file>
+  {{ var5 }} {{ var6 }} eapol ca-certificate <name>
 
-  SSL :abbr:`CA (Certificate Authority)` x509 PEM file used afor authentication
-  of the remote side.
+  Set the name of the SSL :abbr:`CA (Certificate Authority)` PKI entry used for
+  authentication of the remote side. If an intermediate CA certificate is
+  specified, then all parent CA certificates that exist in the PKI, such as the
+  root CA or additional intermediate CAs, will automatically be used during
+  certificate validation to ensure that the full chain of trust is available.
+
+  Example:
 
   .. code-block:: none
 
-    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} eapol ca-cert-file /config/auth/ca.pem
+    set pki ca eapol-server-intermediate-ca <Server intermediate CA contents>
+    set pki ca eapol-server-root-ca <Server root CA contents>
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} eapol ca-certificate eapol-server-intermediate-ca
 
 .. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
-  {{ var5 }} {{ var6 }} eapol cert-file <file>
+  {{ var5 }} {{ var6 }} eapol certificate <name>
 
-  SSL/x509 public certificate file provided by the client to authenticate
-  against the 802.1x system.
+  Set the name of the x509 client keypair used to authenticate against the
+  802.1x system. All parent CA certificates of the client certificate, such as
+  intermediate and root CAs, will be sent as part of the EAP-TLS handshake.
+
+  Example:
 
   .. code-block:: none
 
-    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} eapol cert-file /config/auth/public.pem
-
-.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
-  {{ var5 }} {{ var6 }} eapol key-file <file>
-
-  SSL/x509 private certificate file provided by the client to authenticate
-  against the 802.1x system.
-
-  .. code-block:: none
-
-    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} eapol key-file /config/auth/private.key
+    set pki ca eapol-client-intermediate-ca <Client intermediate CA contents>
+    set pki ca eapol-client-root-ca <Client root CA contents>
+    set pki certificate eapol-client certificate <Client certificate contents>
+    set pki certificate eapol-client private key <Client private key contents>
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} eapol certificate eapol-client

docs/_include/interface-evpn-uplink.txt

@@ -0,0 +1,11 @@
+.. cfgcmd:: set interfaces {{ var0 }} <interface> evpn uplink
+
+  When all the underlay links go down the PE no longer has access
+  to the VxLAN +overlay. To prevent blackholing of traffic the
+  server/ES links are protodowned on the PE.
+
+  A link can be setup for uplink tracking via the following example:
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} evpn uplink

docs/_include/interface-ip.txt

@@ -1,8 +1,25 @@
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+  {{ var5 }} {{ var6 }} ip adjust-mss <mss | clamp-mss-to-pmtu>
+
+  As Internet wide PMTU discovery rarely works, we sometimes need to clamp our
+  TCP MSS value to a specific value. This is a field in the TCP options part of
+  a SYN packet. By setting the MSS value, you are telling the remote side
+  unequivocally 'do not try to send me packets bigger than this value'.
+
+  .. note:: This command was introduced in VyOS 1.4 - it was previously called:
+    ``set firewall options interface <name> adjust-mss <value>``
+
+  .. hint:: MSS value = MTU - 20 (IP header) - 20 (TCP header), resulting in
+    1452 bytes on a 1492 byte MTU.
+
+  Instead of a numerical MSS value `clamp-mss-to-pmtu` can be used to
+  automatically set the proper value.
+
 .. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
   {{ var5 }} {{ var6 }} ip arp-cache-timeout
 
   Once a neighbor has been found, the entry is considered to be valid for at
-  least for this specifc time. An entry's validity will be extended if it
+  least for this specific time. An entry's validity will be extended if it
   receives positive feedback from higher level protocols.
 
   This defaults to 30 seconds.
@@ -46,10 +63,26 @@
 
     set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip disable-forwarding
 
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+  {{ var5 }} {{ var6 }} ip enable-directed-broadcast
+
+  Define different modes for IP directed broadcast forwarding as described in
+  :rfc:`1812` and :rfc:`2644`.
+
+  If configured, incoming IP directed broadcast packets on this interface will
+  be forwarded.
+
+  If this option is unset (default), incoming IP directed broadcast packets
+  will not be forwarded.
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-directed-broadcast
+
 .. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
   {{ var5 }} {{ var6 }} ip enable-arp-accept
 
-  Define behavior for gratuitous ARP frames who's IP is not already present in
+  Define behavior for gratuitous ARP frames whose IP is not already present in
   the ARP table. If configured create new entries in the ARP table.
 
   Both replies and requests type gratuitous arp will trigger the ARP table to be
@@ -126,7 +159,7 @@
   possible to allow these hosts to communicate through the upstream router by
   proxy_arp'ing.
 
-  .. note:: Don't need to be used together with proxy_arp.
+  .. note:: Does not need to be used together with proxy_arp.
 
   This technology is known by different names:
 

docs/_include/interface-ipv6.txt

@@ -53,3 +53,48 @@
   .. code-block:: none
 
     set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 disable-forwarding
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+  {{ var5 }} {{ var6 }} ipv6 adjust-mss <mss | clamp-mss-to-pmtu>
+
+  As Internet wide PMTU discovery rarely works, we sometimes need to clamp our
+  TCP MSS value to a specific value. This is a field in the TCP options part of
+  a SYN packet. By setting the MSS value, you are telling the remote side
+  unequivocally 'do not try to send me packets bigger than this value'.
+
+  .. note:: This command was introduced in VyOS 1.4 - it was previously called:
+    ``set firewall options interface <name> adjust-mss6 <value>``
+
+  .. hint:: MSS value = MTU - 40 (IPv6 header) - 20 (TCP header), resulting in
+    1432 bytes on a 1492 byte MTU.
+
+  Instead of a numerical MSS value `clamp-mss-to-pmtu` can be used to
+  automatically set the proper value.
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+  {{ var5 }} {{ var6 }} ipv6 accept-dad <1-3>
+
+  Whether to accept DAD (Duplicate Address Detection).
+
+  - 0: Disable DAD
+  - 1: Enable DAD (default)
+  - 2: Enable DAD, and disable IPv6 operation if MAC-based duplicate link-local address has been found.
+
+  Example:
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 accept-dad 2
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+  {{ var5 }} {{ var6 }} ipv6 dup-addr-detect-transmits <n>
+
+  The amount of Duplicate Address Detection probes to send.
+
+  Default: 1
+
+  Example:
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 dup-addr-detect-transmits 5

docs/_include/interface-mac.txt

@@ -8,4 +8,4 @@
 
   .. code-block:: none
 
-    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} mac '00:01:02:03:04:05'
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} mac '00:53:01:02:03:04'

docs/_include/interface-mirror.txt

@@ -1,7 +1,10 @@
 SPAN port mirroring can copy the inbound/outbound traffic of the interface to
 the specified interface, usually the interface can be connected to some special
-equipment, such as behavior control system, intrusion detection system and
-traffic collector, and can copy all related traffic from this port
+equipment, such as a behavior control system, intrusion detection system or
+traffic collector, and can copy all related traffic from this port.
+The benefit of mirroring the traffic is that the application is isolated from 
+the source traffic and so application processing does not affect the traffic 
+or the system performance.
 
 VyOS uses the `mirror` option to configure port mirroring. The configuration
 is divided into 2 different directions. Destination ports should be configured

docs/_include/interface-mtu.txt

@@ -8,4 +8,4 @@
 
   .. code-block:: none
 
-    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} mtu 9000
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} mtu 1600

docs/_include/interface-per-client-thread.txt

@@ -0,0 +1,14 @@
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+  {{ var5 }} {{ var6 }} per-client-thread
+
+  Provides a per-device control to enable/disable the threaded mode for
+  all the NAPI instances of the given network device, without the need for
+  a device up/down.
+
+  If CLI option is not specified, this feature is disabled.
+
+  Example:
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} per-client-thread

docs/_include/interface-xdp.txt

@@ -1,27 +0,0 @@
-.. cfgcmd:: set interfaces {{ var0 }} <interface> xdp
-
-  Enable support for Linux :abbr:`XDP (eXpress Data Path)` on recent 1.3 rolling
-  releases. You must enable it for every interface which should participate in
-  the XDP forwarding.
-
-  XDP is an eBPF based high performance data path merged in the Linux kernel
-  since version 4.8. The idea behind XDP is to add an early hook in the RX path
-  of the kernel, and let a user supplied eBPF program decide the fate of the
-  packet. The hook is placed in the NIC driver just after the interrupt
-  processing, and before any memory allocation needed by the network stack
-  itself, because memory allocation can be an expensive operation.
-
-  .. warning:: This is highly experimental!
-
-  .. note:: Enabling this feature will break any form of NAT or Firewalling on
-    this interface, as XDP is handled way earlier in the driver then iptables/
-    nftables.
-
-  Enabling this feature will only load the XDP router code as described here:
-  https://blog.apnic.net/2020/04/30/how-to-build-an-xdp-based-bgp-peering-router/
-
-  Example:
-
-  .. code-block:: none
-
-    set interfaces {{ var0 }} {{ var1 }} xdp

docs/_include/vyos-1x

@@ -1 +1 @@
-Subproject commit 86209c679c6b7ca9d5bac1f67ffd391b9b16c008
+Subproject commit f980f8b8010a9681c387d47c476254c89b0c4a25

docs/_locale/de/404.pot

@@ -0,0 +1,37 @@
+msgid ""
+msgstr ""
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Localazy (https://localazy.com)\n"
+"Project-Id-Version: VyOS Documentation\n"
+"Language: de\n"
+"Plural-Forms: nplurals=2; plural=(n==1) ? 0 : 1;\n"
+
+#: ../../404.rst:4
+msgid "Page Not Found"
+msgstr "Seite nicht gefunden"
+
+#: ../../404.rst:6
+msgid "Sorry, We could not find a page. Try using the search box or go to the release homepage:"
+msgstr "Entschuldigung, wir konnten keine Seite finden. Versuchen Sie es mit dem Suchfeld oder gehen Sie auf die Homepage der Veröffentlichung:"
+
+#: ../../404.rst:9
+msgid "`1.2.x (crux) <https://docs.vyos.io/en/crux/>`_"
+msgstr "`1.2.x (crux) <https://docs.vyos.io/en/crux/>`_"
+
+#: ../../404.rst:10
+msgid "`1.3.x (equuleus) <https://docs.vyos.io/en/equuleus/>`_"
+msgstr "`1.3.x (equuleus) <https://docs.vyos.io/en/equuleus/>`_"
+
+#: ../../404.rst:11
+msgid "`1.4.x (sagitta) <https://docs.vyos.io/en/sagitta/>`_"
+msgstr "`1.4.x (sagitta) <https://docs.vyos.io/en/sagitta/>`_"
+
+#: ../../404.rst:12
+msgid "`rolling release (circinus) <https://docs.vyos.io/en/latest/>`_"
+msgstr "`rolling release (circinus) <https://docs.vyos.io/en/latest/>`_"
+
+#: ../../404.rst:11
+msgid "`rolling release (sagitta) <https://docs.vyos.io/en/latest/>`_"
+msgstr "`Rolling Release (Sagitta) <https://docs.vyos.io/en/latest/>`_"