summaryrefslogtreecommitdiff
path: root/docs/contributing
AgeCommit message (Collapse)Author
2026-03-30Split troubleshooting, add contributing index, clean VPN structure (#1804)Yuriy Andamasov
* Add design spec for documentation improvements Covers 4 work streams: mechanical fixes (headings, indentation, typos), content quality (TODO flags, TBD fills, stub markers), structural reorganization (troubleshooting split, contributing index, VPN cleanup), and RTD platform cleanup (hide versions, delete stale redirects). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix spec issues from review: correct heading chars, tab counts, line numbers Addresses 10 reviewer findings: corrected heading character types (^ was actually -), removed ip.rst (already correct), updated file count from 37 to 35, listed all 13 tab-containing files, fixed troubleshooting line count to 460, added heading level guidance for split pages, clarified contributing/documentation.rst scope, removed current from hide list, added rollback verification step, updated success criteria. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Add implementation plan for documentation improvements 16 tasks across 4 work streams: mechanical fixes (PR 1, tasks 1-6), content quality (PR 2, tasks 7-10), structural reorg (PR 3, tasks 11-14), and RTD platform cleanup (tasks 15-16). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix 6 issues from plan review - Replace hardcoded RTD token with $RTD_TOKEN variable - Fix Task 7 heading reference to be format-agnostic - Correct RTD PATCH expected response (200, not 204) - Fix version verification to check hidden field, not active - Account for blank lines 402-403 in troubleshooting split - Clarify start/stop_vyoslinter handling in system.rst Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor: split troubleshooting into 5 focused sub-pages Split monolithic 460-line troubleshooting/index.rst into: - connectivity.rst (ping, traceroute, mtr, IPv6 discovery) - interfaces.rst (interface naming, MAC addresses) - monitoring.rst (traffic dumps, bandwidth, iperf) - terminal.rst (console clearing, counter resets) - system.rst (boot steps, system information) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * refactor: create contributing/index.rst, simplify root toctree * fix: remove 'pages to sort' placeholders from VPN section * fix: wrap long lines in index.rst for linter compliance * Add design spec for sitemap generation improvement * Fix sitemap spec: remove invalid sitemap_excludes, add version pin * fix: address Copilot review suggestions — grammar, typos, RST markup fixes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: resolve remaining long lines in index.rst Shorten :ref: display text on two lines that exceeded the 80-char limit: "Virtual Environment" -> "VM" (line 24, 90 -> 73 chars) and "Configuration Blueprints" -> "Blueprints" (line 51, 85 -> 71 chars). Both targets remain correct; display text is clear in context. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore: remove superpowers specs from PR Specs moved to personal branch yuriy/docs-modernization-specs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-01-30DOC: Remove outdated upstream package documentation (#1746)Quill
* Remove outdated upstream package documentation Upstream packages are now built through a Python script, 'build.py' from the vyos-build repository: https://github.com/vyos/vyos-build/tree/current/scripts/package-build/build.py * Add build.py details to upstream-packages.rst * Fix line length lint errors
2026-01-27Proofread docs in the /contributing directory (#1718)Quill
* Proofread upstream-packages.rst * Fix line length lint errors * Initial copyedit for testing.rst * Proofread build-vyos.rst * Fix line length errors * Proofread debugging.rst * Proofread issues-features.rst * Complete issuesfeatures.rst proofreading * Initial proofread development.rst * Revise proofreading of development.rst * Remove mentions of Phabricator and Jenkins CI * Fix line length lint errors * Fix additional line length lint errors
2025-10-13cla: Add CLA references and instructions (#1690)zdc
- Added a dedicated page describing the process of signing the CLA - Added references to this page on documents explaining how to submit code and documentation changes
2025-09-18Removing extra empty code block (#1684)jsinme
2025-03-29T7289: Add submodule argument to clone examplesarthurdev
2025-01-21Misc updates and outdated info removals in ContributingDaniil Baturin
2025-01-21Document the new status of LTS reposDaniil Baturin
(they are no longer available to people without subscriptions)
2024-12-14debugging: document new config migration helperChristian Breunig
2024-12-11Fix typos and add constraints on conf-mode scripts under configdJohn Estabrook
2024-09-03T6231: Add documentation for building Mellanox OFED drivers (#1488)RageLtMan
2024-07-09Fix Typo in build-vyos.rstMarkus Hauschild
2024-06-05 Changed parameter flavor from iso to generic for 1.5 (circinus, current)Sam
The flavor has been renamed in this branch. https://vyos.dev/T6414
2024-04-21testing: add hint for smoketest debuggingChristian Breunig
2024-04-16Docs: refresh the issue/features page guidelinesDaniil Baturin
2024-01-17Fix typos in build-vyosSebastian Weber
2024-01-17Fix spelling in contributingSebastian Weber
2023-12-30build: improve documentation of current versions and how to build themsofukong
2023-12-22testing: fix typoChristian Breunig
2023-11-02Update build-vyos.rstHarliff
Since "saggita" is no more current branch and links to the "current" pointed to "ciriunus" branch now, I've replaced "current" branch links to "saggita", so 1.4 can be built.
2023-09-12build: update Docker tags for release branchesChristian Breunig
2023-09-12build: remove reference to WireGuard out-of-tree packagesChristian Breunig
2023-07-09Build ISO commands is different for 1.2/1.3 compare to 1.4Kai Stian Olstad
2023-02-04contributing: add section about C/C++ backend codeChristian Breunig
2023-01-29Disambiguate sagitta as currentAli
Separate references mentioning equuleus and state sagitta as current instead
2022-11-05Fixing more lint errors: Warning: Line too long: len=81Alex Oberhauser
2022-11-05Fixing lint error: Warning: Line too long: len=81Alex Oberhauser
2022-11-05Updating the documentation to reflect the new build processAlex Oberhauser
2022-06-27syntax and grammar checksrividya0208
Modified the grammatical error and bgp syntax which is modified in the latest rolling version
2021-09-15build: fix linkrebortg
2021-09-13contributing: clear structurerebortg
2021-09-10Update development.rstGil Obradors
updated broken links
2021-08-19build-vyos: add hint about lo interface sysctl knobChristian Poessinger
2021-08-19build-vyos: current branch now uses Debian 11 (Bullseye)Christian Poessinger
2021-08-16Add new testing sectionChristian Poessinger
(cherry picked from commit 7e782af3c29e28456a00785d773557da235c976a)
2021-08-16Merge contribution documentation and documentation chapterChristian Poessinger
(cherry picked from commit 848c538299fe0098166e052d3238caff60a61915)
2021-04-26T3485: Update build to include MacOS supportRichard Chen Zheng
2021-03-12more then welcome phrase is corrected as more than welcomeOguz Yilmaz
2021-02-17debugging: add hint how to solve ISO build erros on broken package feedChristian Poessinger
2021-01-26contribution: fix duplicate label errorrebortg
2021-01-23docs: Mention proofreading in documentation contribution pageerkin
2021-01-23docs: Fix cross-referenceerkin
2021-01-23docs: Refer to the larger set of documentation guidelineserkin
2021-01-23docs: Add contribution guidelineserkin
2020-12-11contributing: fix lint errorsrebortg
2020-12-10rearrange development partrebortg
2020-12-10styleguide: specify line lenght and exceptionrebortg
2020-12-09contributing: Typographical correctionserkin
2020-12-08fix build error after mergerebortg
2020-12-08Merge branch 'sagitta' of https://github.com/rebortg/vyos-documentationrebortg