summaryrefslogtreecommitdiff
path: root/doc/contributing (follow)
Commit message (Expand)AuthorAgeFilesLines
* doc: collapse old contributing sections to one redirect•••also link from nixos/doc to the in-tree README directly Valentin Gagarin2025-12-151-8/+0
* doc/reviewing-contributions: Refine the New modules linkRobert Hensing2025-08-061-1/+1
* doc/vulnerability-roundup: 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-38/+4
* 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
* doc/reviewing-contributions: 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-296/+9
* doc/quick-start: Rough move to new contribution doc files•••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-75/+1
* doc/contributing-to-documentation: Rough move to new contribution doc files•••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-107/+3
* doc/coding-conventions: 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-647/+17
* doc/contributing: Remove unreferenced legacy diagram•••Not used anymore after b3fa79bb8965f7d3353daf99b137170314899a53 Silvan Mosberger2023-08-132-118/+0
* Merge pull request #241656 from mobusoperandi/update-doc-contributing•••fix outdated contributing to documentationSilvan Mosberger2023-08-101-0/+3
|\
| * Update doc/contributing/contributing-to-documentation.chapter.md•••Co-authored-by: Jan Tojnar <jtojnar@gmail.com>Silvan Mosberger2023-08-101-1/+1
| * fix outdated contributing to documentation•••Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com> Alejandro Sanchez Medina2023-08-031-0/+3
* | Merge pull request #241871 from mobusoperandi/doc-doc-syntax-chapter•••doc syntax section into chapter, link from nixos manualSilvan Mosberger2023-08-101-1/+1
|\ \ | |/ |/|
| * nixos manual contributing link to nixpkgs syntax•••Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com> Alejandro Sanchez Medina2023-07-101-1/+1
* | Merge pull request #245358 from asymmetric/nixpkgs-doc-build-instructions•••doc/contributing: update build instructions after nrdpennae2023-07-291-18/+4
|\ \
| * | doc/contributing: update build instructions•••We have moved away from Make since nixos-render-docs was introduced to build the nixpkgs manual in #239636. Lorenzo Manacorda2023-07-251-18/+4
* | | nixpkgs/NixOS manuals: devmode feature•••Co-authored-by: Alejandro Sanchez Medina <alejandrosanchzmedina@gmail.com> Shahar "Dawn" Or2023-07-251-0/+8
|/ /
* | docs/contributing: fix "ha256" -> "sha256" typoTheodore Ni2023-07-181-1/+1
* | Merge pull request #240136 from NixOS/doc-review-patches•••doc/reviewing-contributions: Add points about patchesRobert Hensing2023-07-161-1/+4
|\ \
| * | doc/reviewing-contributions: Remove wrong fetchpatch detail ••• It may have to be fetchpatch, fetchpatch2, or fetchurl. We should link somewhere, but we don't have a link target yet, so until then, remove the inaccurate info. Co-authored-by: Alyssa Ross <hi@alyssa.is>origin/doc-review-patchesRobert Hensing2023-06-271-2/+2
| * | doc/reviewing-contributions: Add points about patches•••A weaker version of https://github.com/NixOS/nixpkgs/pull/186484#issuecomment-1608960696Robert Hensing2023-06-271-0/+3
* | | 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-013-18/+123
|/
* doc/contributing/review-contributions: fix small typo (#237186)•••Signed-off-by: lucasew <lucas59356@gmail.com>Lucas Eduardo2023-06-111-1/+1
* doc: correct typos and spelling (#237098)Andrew2023-06-111-1/+1
* coding-conventions: include the preceding upstream version when packaging a c...Michael Raskin2023-06-021-1/+3
* Fix typo in coding-conventions.chapter.mdgeri17012023-04-111-1/+1
* 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/contributing: remove last references to name•••pname+version should be used everywhere, so lets clean this up Sandro Jäckel2023-02-071-2/+2
* nixos/manual: render module chapters with nixos-render-docs•••this converts meta.doc into an md pointer, not an xml pointer. since we no longer need xml for manual chapters we can also remove support for manual chapters from md-to-db.sh since pandoc converts smart quotes to docbook quote elements and our nixos-render-docs does not we lose this distinction in the rendered output. that's probably not that bad, our stylesheet didn't make use of this anyway (and pre-23.05 versions of the chapters didn't use quote elements either). also updates the nixpkgs manual to clarify that option docs support all extensions (although it doesn't support headings at all, so heading anchors don't work by extension). pennae2023-01-271-9/+5
* Merge pull request #208762 from ncfavier/link-manpages-options-docNaïm Favier2023-01-091-1/+1
|\
| * doc: separate manpage URLs from the Pandoc filter•••Move the manpage-to-URL mapping to `doc/manpage-urls.json` so that we can reuse that file elsewhere, and generate the `link-manpages.lua` filter from that file. Also modify the Pandoc filter so that it doesn't wrap manpages that are already inside a link. Keeping a Lua filter is essential for speed: a Python filter would increase the runtime `md-to-db.sh` from ~20s to ~30s (but Python is not to blame; marshalling Pandoc types to and from JSON is a costly operation). Parsing in Lua seems tedious, so I went with the Nix way. Naïm Favier2023-01-021-1/+1
* | doc/contributing/quick-start: Replace dead thunderbird link•••The thunderbird derivation is using `buildMozillaMach` these days, shared with Firefox and Librefox, so it is probably the correct , although more complicated, successor. Martin Weinelt2023-01-031-1/+1
|/
* doc,nixos/doc: unescape ellipses•••Leftovers from the CommonMark conversion. Naïm Favier2022-12-271-1/+1
* doc/contributing/coding-conventions: add subsection for language serversAnderson Torres2022-12-251-0/+4
* doc: fix typosfigsoda2022-12-171-1/+1
* Update doc/contributing/coding-conventions.chapter.md•••Co-authored-by: Mostly Void <dit7ya@users.noreply.github.com>Valentin Gagarin2022-12-101-1/+1
* docs: fixup wording and formatting on JavaScriptValentin Gagarin2022-12-071-2/+2
* document Import From Derivation (IFD) policyValentin Gagarin2022-12-071-0/+15
* 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-042-6/+7
* nixpkgs/doc: fix admonition syntax•••Match admonition syntax in https://nixos.org/manual/nixpkgs/unstable/#chap-contributing Ryan Mulligan2022-11-081-1/+1
* doc/contributing: Explicitly allow trivial changes by non-authors•••Discussed and proposed at https://discourse.nixos.org/t/rules-around-adding-to-someones-pr/22671/3 Stanisław Pitucha2022-10-231-0/+6
* 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
* | coding-conventions.chapter.md: update to account for #89885 (#191378)•••https://github.com/NixOS/nixpkgs/pull/89885 ensures that fetches are done securely (i.e. without `--insecure`) when the `hash` parameter is one of the four special "fake" hashes. However the manual was not updated in that PR. This commit updates the manual to account for the already-merged changes from that PR. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>Adam Joseph2022-10-121-6/+14
* | doc/contributing: fix whitespaceSandro2022-09-071-1/+1
* | Merge pull request #189241 from SuperSandro2000/git-full-hash•••doc/contributing: enforce full commit hashes on githubAnderson Torres2022-09-051-0/+3
|\ \
| * | doc/contributing: enforce full commit hashes on githubSandro Jäckel2022-09-041-0/+3