summaryrefslogtreecommitdiff
path: root/doc/contributing/submitting-changes.chapter.md (follow)
Commit message (Expand)AuthorAgeFilesLines
* doc/submitting-changes: Rough move to new contribution doc files•••No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided. Silvan Mosberger2023-08-131-278/+22
* Revert "Revert "submitting-changes.chapter.md: explain *why* we have three br...•••This reverts commit 7e6c518ce4f316cba803a40c19160606a8bfab9f. I misinterpreted Github's CI failure in the notification tab and thought that I had broken CI on origin/master, so I panic-reverted before I merged it (I thought they had). On closer inspection, it appears that the CI failure was not from the tip that I merged. This PR resubmits the reverted change. I'll wait for OfBorg to finish this time. Adam Joseph2023-06-291-10/+65
* Revert "submitting-changes.chapter.md: explain *why* we have three branches"Adam Joseph2023-07-121-65/+10
* submitting-changes.chapter.md: explain *why* we have three branches•••The manual does an okay job of explaining the rules for each of the three development branches, but really doesn't give any intuition as to why there are three (why not four? or two?) or how we got where we are today. This commit attempts to fix that, by explaining that there is one branch that allows mass-rebuild commits, and it has a fast-building branch both upstream and downstream of it (from the perspective of automated merges). I have also removed the term "stabilization" from the arc labels. This vague term is not defined anywhere, and does communicate any useful information without a longer explanation. Therefore it is not appropriate for use in a diagram. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Adam Joseph2023-06-291-10/+65
* doc: render nixpkgs manual with nrd•••also updates nixdoc to 2.3.0. the nixdoc update is not a separate commit because that would leave the manual build broken for one commit, potentially breaking bisects and rebases. pennae2023-07-011-18/+5
* doc: assign ids to many headings•••without stable ids on headings we cannot generate stable links to these headings. nrd complains about this, but the current docbook workflow does not. a few generated ids remain, mostly in examples and footnotes. most of the examples are generated by nixdoc (which has since gained MD export functions, and the MD export does generate IDs). pennae2023-03-271-1/+1
* doc,nixos/doc: unescape ellipses•••Leftovers from the CommonMark conversion. Naïm Favier2022-12-271-1/+1
* doc: use sri hash syntax•••The nixpkgs manual contains references to both sri hash and explicit sha256 attributes. This is at best confusing to new users. Since the final destination is exclusive use of sri hashes, see nixos/rfcs#131, might as well push new users in that direction gently. Notable exceptions to sri hash support are builtins.fetchTarball, cataclysm-dda, coq, dockerTools.pullimage, elixir.override, and fetchCrate. None, other than builtins.fetchTarball, are fundamentally incompatible, but all currently accept explicit sha256 attributes as input. Because adding backwards compatibility is out of scope for this change, they have been left intact, but migration to sri format has been made for any using old hash formats. All hashes have been manually tested to be accurate, and updates were only made for missing upstream artefacts or bugs. Colin Arnott2022-12-041-1/+1
* Merge pull request #173506 from helsinki-systems/feat/document-no-breaking-co...•••doc: Document that the staging branches may be restrictedJanne Heß2022-10-211-0/+4
|\
| * doc: Document that the staging branches may be restrictedJanne Heß2022-05-181-0/+4
* | doc/contributing: fix whitespaceSandro2022-09-071-1/+1
* | doc/contributing: replace outdated 'nix run' commands•••Use `nix-shell` instead, but also give an example of the correct flakes version of the commands. Johannes Maier2022-07-031-7/+13
* | Merge #162960: staging docs: explain that purple arrows are manualVladimír Čunát2022-06-141-1/+1
|\ \ | |/ |/|
| * submitting-changes.chapter.md: avoid being specific•••There is some doubt as to exactly how to enumerate all the merges from one branch to another reliably. In the meantime, let's be a little more vague. Adam Joseph2022-04-201-1/+1
| * submitting-changes.chapter.md: explain that purple arrows are manual•••The documentation for this diagram explains that the blue arrows are automatic processes which happen every six hours. There is no explanation about how the purple arrows happen or how often. As a new contributor to nixpkgs, I incorrectly assumed that the purple arrows were also automatic processes (they aren't), which left me sort of confused about what the whole scheme was accomplishing. Recently I went through the github history to see how often these events happen, and realized that the purple arrows are (a) triggered manually by a nixpkgs project member and (b) happen much, much, much less frequently than every six hours. Now everything makes a lot more sense. I suggest the wording change in this commit, or something similar, to save future contributors the same confusion that I experienced. Adam Joseph2022-03-051-1/+1
* | doc: clarify what a 'mass rebuild' isArnout Engelen2022-05-091-1/+1
* | Replace "rm" call with "git rm"•••`git rm` should always be preferred over "normal" `rm`. Signed-off-by: Matthias Beyer <mail@beyermatthias.de> Matthias Beyer2022-05-031-1/+1
|/
* Move misc/vim-plugins to applications/editors/vim/pluginsAndersonTorres2022-02-241-1/+1
* doc: fix broken link•••The file was renamed/modified in 3f40ca4 but the documentation was not updated. Closes #155049. Nicolas Benes2022-01-151-1/+1
* Merge pull request #149867 from erikarvstedt/docs-stable-release•••docs: improve section `Stable release branches`Jan Tojnar2021-12-301-3/+13
|\
| * docs: improve section `Stable release branches`•••- Explain branch naming scheme for stable release branches - Split into subsections `Automatically backporting ...` and `Manually backporting...`. Erik Arvstedt2021-12-281-3/+13
* | doc: minimize mentions of nix-env -i without -A in nixpkgs manualGuillaume Girol2021-12-181-4/+4
|/
* CONTRIBUTING.md: Move to repo root, where it is more visible.•••We found that many users found it difficult to locate this document. Github supports it in the root, see: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors Niklas Hambüchen2021-06-261-2/+2
* doc/manual: Add backport criteriaJonathan Ringer2021-06-091-0/+11
* doc: prepare for commonmark•••We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly. Notably: - Line breaks in lists behave differently. - Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75 - The auto_identifiers uses a different algorithm – I made the previous ones explicit. - Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist While at it, I also fixed the following issues: - ShellSesssion was used - Removed some pointless docbook tags. Jan Tojnar2021-06-071-1/+3
* backport action: document the workflowDomen Kožar2021-05-251-0/+2
* doc/submitting-changes: should -> must•••To me, as a native English speaker, this doesn't change the meaning of the sentence at all. But to a non-native speaker, this can read like the staging-next rules are only recommendations. Let's make this clearer. Alyssa Ross2021-05-231-1/+1
* doc/submitting-changes: remove incorrect remark•••Tests don't only apply to NixOS modules, see for example tests/vscodium Patrick Hilhorst2021-04-261-1/+1
* Merge pull request #116475 from davidak/doc-remove-packages•••doc: add instructions to remove a packageSamuel Dionne-Riel2021-04-211-0/+46
|\
| * doc: add instructions to remove a package•••Co-authored-by: Sandro <sandro.jaeckel@gmail.com> Co-authored-by: Ben Siraphob <bensiraphob@gmail.com> davidak2021-04-201-0/+46
* | documentation: Add content about Vulnerability roundups•••Signed-off-by: Pamplemousse <xav.maso@gmail.com> Pamplemousse2021-03-171-9/+10
|/
* docs: clarify staging•••Specify that the merges from master to staging-next to staging are performed by GitHub actions. This helps the reader understand the relationship between the branches. Thomas Bereknyei2021-02-191-1/+4
* doc: Add staging workflow diagramJan Tojnar2020-12-091-0/+19
* doc: Clean up submitting changesJan Tojnar2020-12-051-34/+19
* doc: convert Submitting changes to MarkdownJan Tojnar2020-12-051-0/+213