Commit graph

137 commits

Author SHA1 Message Date
Silvan Mosberger
129da60f57 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.
2023-08-13 22:04:56 +02:00
Silvan Mosberger
86f14e461e 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.
2023-08-13 22:04:56 +02:00
Silvan Mosberger
f3a050a191 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.
2023-08-13 22:04:56 +02:00
Silvan Mosberger
90bf25d037 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.
2023-08-13 22:04:56 +02:00
Silvan Mosberger
74b17a515f 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.
2023-08-13 22:04:55 +02:00
Silvan Mosberger
1e1cd398d4 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.
2023-08-13 22:02:34 +02:00
Silvan Mosberger
be26d79f46 doc/contributing: Remove unreferenced legacy diagram
Not used anymore after b3fa79bb89
2023-08-13 21:54:50 +02:00
Silvan Mosberger
bfe04ea76c
Merge pull request from mobusoperandi/update-doc-contributing
fix outdated contributing to documentation
2023-08-10 17:15:05 +02:00
Silvan Mosberger
731c21db95
Update doc/contributing/contributing-to-documentation.chapter.md
Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-08-10 16:12:07 +02:00
Silvan Mosberger
37ba768fb4
Merge pull request from mobusoperandi/doc-doc-syntax-chapter
doc syntax section into chapter, link from nixos manual
2023-08-10 16:11:25 +02:00
Alejandro Sanchez Medina
b751910048 fix outdated contributing to documentation
Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>
2023-08-03 13:21:48 +02:00
pennae
dcd55915ad
Merge pull request from asymmetric/nixpkgs-doc-build-instructions
doc/contributing: update build instructions after nrd
2023-07-29 23:22:43 +02:00
Lorenzo Manacorda
35471bd134 doc/contributing: update build instructions
We have moved away from Make since nixos-render-docs was introduced to
build the nixpkgs manual in .
2023-07-25 15:26:18 +02:00
Shahar "Dawn" Or
a064709342 nixpkgs/NixOS manuals: devmode feature
Co-authored-by: Alejandro Sanchez Medina <alejandrosanchzmedina@gmail.com>
2023-07-25 17:03:15 +07:00
Theodore Ni
9d55df7a37
docs/contributing: fix "ha256" -> "sha256" typo 2023-07-18 16:55:32 -07:00
Robert Hensing
12d2f0da28
Merge pull request from NixOS/doc-review-patches
doc/reviewing-contributions: Add points about patches
2023-07-16 14:21:17 +02:00
Alejandro Sanchez Medina
ad224d61d0 nixos manual contributing link to nixpkgs syntax
Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>
2023-07-10 15:56:42 +07:00
pennae
be4d19ff1a 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.
2023-07-01 20:59:29 +02:00
Adam Joseph
910d4f761a Revert "Revert "submitting-changes.chapter.md: explain *why* we have three branches""
This reverts commit 7e6c518ce4.

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.
2023-06-29 03:08:41 -07:00
Adam Joseph
7e6c518ce4
Revert "submitting-changes.chapter.md: explain *why* we have three branches" 2023-07-12 19:59:46 +00:00
Adam Joseph
b3fa79bb89 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>
2023-06-29 02:38:06 -07:00
Robert Hensing
a0a4354a13
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>
2023-06-27 18:35:15 +02:00
Robert Hensing
4920af40fc
doc/reviewing-contributions: Add points about patches
A weaker version of https://github.com/NixOS/nixpkgs/pull/186484#issuecomment-1608960696
2023-06-27 15:56:54 +02:00
Lucas Eduardo
9401a0c780
doc/contributing/review-contributions: fix small typo ()
Signed-off-by: lucasew <lucas59356@gmail.com>
2023-06-11 14:54:35 +02:00
Andrew
1b6f640687
doc: correct typos and spelling () 2023-06-11 02:15:43 +02:00
Michael Raskin
5b90f7a6a9 coding-conventions: include the preceding upstream version when packaging a commit without a version attached 2023-06-02 13:27:25 +02:00
geri1701
8cbf65ece9
Fix typo in coding-conventions.chapter.md 2023-04-11 21:05:56 +02:00
pennae
052bb41410 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).
2023-03-27 22:39:11 +02:00
Sandro Jäckel
fcfa4dd73b
doc/contributing: remove last references to name
pname+version should be used everywhere, so lets clean this up
2023-02-07 20:40:26 +01:00
pennae
0a6e6cf7e6 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).
2023-01-27 20:07:34 +01:00
Naïm Favier
bff4bb5540
Merge pull request from ncfavier/link-manpages-options-doc 2023-01-09 11:57:01 +01:00
Martin Weinelt
8b79bf0432
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.
2023-01-03 14:18:41 +01:00
Naïm Favier
a8d4cf149c
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.
2023-01-02 14:11:22 +01:00
Naïm Favier
3f6fed2e59
doc,nixos/doc: unescape ellipses
Leftovers from the CommonMark conversion.
2022-12-27 17:13:49 +01:00
Anderson Torres
593381845f doc/contributing/coding-conventions: add subsection for language servers 2022-12-25 10:57:29 -03:00
figsoda
403e25e3e3 doc: fix typos 2022-12-17 18:21:48 -05:00
Valentin Gagarin
d9f9ead58a
Update doc/contributing/coding-conventions.chapter.md
Co-authored-by: Mostly Void <dit7ya@users.noreply.github.com>
2022-12-10 11:46:53 +01:00
Valentin Gagarin
db1a83aaa4 docs: fixup wording and formatting on JavaScript 2022-12-07 16:47:31 +01:00
Valentin Gagarin
53b5a47c12 document Import From Derivation (IFD) policy 2022-12-07 16:47:30 +01:00
Colin Arnott
bac379f30a
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 ,
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.
2022-12-04 06:12:18 +00:00
Ryan Mulligan
f3d0e1d5c3 nixpkgs/doc: fix admonition syntax
Match admonition syntax in

https://nixos.org/manual/nixpkgs/unstable/#chap-contributing
2022-11-08 07:30:20 -08:00
Stanisław Pitucha
713369c44b 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
2022-10-23 15:23:02 +11:00
Janne Heß
1b768f41e9
Merge pull request from helsinki-systems/feat/document-no-breaking-commits
doc: Document that the staging branches may be restricted
2022-10-21 22:58:33 +02:00
Adam Joseph
0d0c03fb0b
coding-conventions.chapter.md: update to account for ()
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>
2022-10-12 11:08:50 +02:00
Sandro
1bb33d6dbe
doc/contributing: fix whitespace 2022-09-07 01:01:48 +02:00
Anderson Torres
6be0f0e057
Merge pull request from SuperSandro2000/git-full-hash
doc/contributing: enforce full commit hashes on github
2022-09-05 21:26:05 -03:00
Sandro Jäckel
be09c1638d
doc/contributing: enforce full commit hashes on github 2022-09-04 00:50:35 +02:00
pennae
9c3c13b50d nixos/make-options-doc: add inline roles for varname/envar
both of these render distinctly from plain literals in the manpage, and
manpages even semantically distinguish between the two.
2022-08-31 16:21:10 +02:00
Matthias Bartelmeß
0ff5e21ea2
Correct instructions to obtain a hash for git repos 2022-08-04 00:31:31 +02:00
Johannes Maier
f0100c6fa7 doc/contributing: replace outdated 'nix run' commands
Use `nix-shell` instead, but also give an example of the correct
flakes version of the commands.
2022-07-03 21:30:01 +02:00