summaryrefslogtreecommitdiff
path: root/docs/contributing/development.rst
AgeCommit message (Collapse)Author
2026-05-06feat: flip swap mechanism — MD as primary, RST as override (Phase 1)Yuriy Andamasov
This is the first of three phases inverting the per-page swap mechanism so MD becomes the canonical primary and RST becomes the rare override. Phase 1 — file renames + conf.py exclude_patterns flip only: - Rename docs/**/md-<stem>.md to docs/**/<stem>.md (drop md- prefix) for all 254 stems previously listed in docs/_swap.txt - Rename docs/**/<stem>.rst to docs/**/rst-<stem>.rst (add rst- prefix) for the same 254 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty comment-only since no pages need the RST fallback right now - conf.py exclude_patterns flipped: rst-*.rst is now excluded by default instead of md-*.md - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt (Phase 2 will rewrite swap_sources.py to produce these names; for now no swap script runs because overrides list is empty) Phase 2 (next commit on this branch) will rewrite scripts/swap_sources.py with inverted rename direction, delete scripts/import_myst.py + tests, and update tests/test_swap_sources.py for the new semantics. Phase 3 will be the cleanup pass and ready-for-review flip. Generated by robots https://vyos.io
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-01-21Misc updates and outdated info removals in ContributingDaniil Baturin
2024-12-11Fix typos and add constraints on conf-mode scripts under configdJohn Estabrook
2024-01-17Fix spelling in contributingSebastian Weber
2023-02-04contributing: add section about C/C++ backend codeChristian Breunig
2021-09-10Update development.rstGil Obradors
updated broken links
2021-08-16Add new testing sectionChristian Poessinger
(cherry picked from commit 7e782af3c29e28456a00785d773557da235c976a)
2021-03-12more then welcome phrase is corrected as more than welcomeOguz Yilmaz
2020-12-11contributing: fix lint errorsrebortg
2020-12-06arrange examplesrebortg
2020-11-30change include to absolute pathrebortg
2020-09-25development: fix __main__ of Python skeletonChristian Poessinger
2020-09-25development: update python skeletonChristian Poessinger
2020-08-06Split Development and Debugging chapter into individual filesChristian Poessinger
2020-07-08development: add additional link for good commit messagesChristian Poessinger
2020-05-25Add explanation about boot-config-trace generatesEshenko Dmitriy
2020-05-20development: add boottime graph howtoChristian Poessinger
2020-05-15development: fix typo added in config migration sectionChristian Poessinger
2020-05-15development: add hint about config migration testingChristian Poessinger
2020-04-14debug: document the various flagsThomas Mangin
2020-04-07development: fix priority level in hirerarchyChristian Poessinger
2020-04-06development: remove additional ``Christian Poessinger
2020-04-02development: add notes about prioritiesChristian Poessinger
2020-03-16T2132: Document kernel boot parameter 'vyos-config-debug'John Estabrook
2020-02-08fix note due to : vs :: typoThomas Mangin
2020-01-11Fix some typos and capitalizationsStephen James
2019-12-29common-references: migrate all VyOS Phabricator referencesChristian Poessinger
2019-12-29vytask: migrate all task references to new commandChristian Poessinger
2019-12-12development: T1843: add information about GNU preprocessor on XML filesChristian Poessinger
2019-12-12development: improve information about commit messagesChristian Poessinger
... to make it more easy for upcoming contributors
2019-12-10Development: correct redirect linkRobert Göhler
2019-12-07development: adjust headlines to new level syntaxChristian Poessinger
2019-12-07development: reword of commit messagesChristian Poessinger
2019-11-28Refactor "code-block:: console" to "code-block:: none"Christian Poessinger
2019-11-27Refactor "code-block:: sh" to "code-block:: console"Christian Poessinger
This will add proper new-lines into the rendered PDF. Before if it has been a long line, not all content was preserved in the PDF.
2019-11-26development: fix wrong Python ConfigError import statementChristian Poessinger
2019-11-12development: add chapter about Jenkins CIChristian Poessinger
2019-11-11contribution: restructure entire chapterChristian Poessinger
- move subchapters to sub-sub chapters and try to have more internal references to e.g. commit rules.
2019-11-06contribution: rewrite guidelines and add commit examplesChristian Poessinger
- use 80 characters line break - rewrite GitHub guide - Updated commit message guide - explain workflows a bit better
2019-09-30Fix typos in pagesRamax Lo
2019-06-17syntax fixKim
2019-06-17[documentation] T1442: Add documentation how people can add patches and some ↵Kim
guidelines. (#66) * add patching guidelines * fix syntax * add sugestions
2019-05-28Contribution: split source into smaller filesChristian Poessinger