Commit Graph

77 Commits

Author SHA1 Message Date
Thomas Bereknyei
9c4839fe86 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.
2021-02-19 07:56:09 +01:00
Robert Hensing
1d0d9d26c6
Merge pull request #109663 from Pamplemousse/documentation
documention corrections
2021-01-26 15:37:45 +01:00
V
7616206b77
doc: add function argument order convention (#110060)
* doc: add function argument order convention

Ordering by usage is the de facto ordering given to arguments. It's
logical, and makes finding argument usage easier. Putting lib first is
common in NixOS modules, so it's reasonable to mirror this in nixpkgs
proper. Additionally, it's not a package as such, has zero dependencies,
and can be found used anywhere in a derivation.

* doc: clean up usage of lib
2021-01-20 19:07:16 -05:00
Pamplemousse
c803b2333b documentation: correct documentation help
`PANDOC_LUA_FILTERS_DIR` is set in `makeFlags` in `doc/default.nix`,
and needs to be explicitely passed to `make` when called manually.

Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2021-01-19 18:22:18 -07:00
Alyssa Ross
c06b2b3d67 doc: add "prefer lib over stdenv.lib" convention
I think we should have something in the manual people can point to
about this, to avoid rehashing it over and over in PRs.  "stdenv.lib"
makes it look like lib is part of stdenv, which it isn't, and makes it
even more confusing as a newcomer to figure out what stdenv is (and
isn't).
2021-01-10 08:24:52 +01:00
Jan Tojnar
ba11a96653
doc: Add staging workflow diagram 2020-12-09 05:26:55 +01:00
Jan Tojnar
cc3228e0bb
doc: Clean up submitting changes 2020-12-05 13:03:22 +01:00
Jan Tojnar
035960e4f6
doc: convert Submitting changes to Markdown 2020-12-05 12:43:25 +01:00
Jan Tojnar
5ad6509278
doc: Rename submitting-changes to chapter 2020-12-05 12:33:00 +01:00
Domen Kožar
a0e24a6d40
Merge pull request #101806 from unode/docs
docs: Add 'how to request merging rights'
2020-12-01 17:12:20 +01:00
Jonathan Ringer
0e89c426c7 doc/contributing: remove label instructions
ofborg largely does this now
2020-11-14 16:39:43 -08:00
zowoq
3f20417b4c doc/*: fix indentation 2020-11-12 14:24:00 +10:00
Renato Alves
5c931c7299
docs: Add link to the GitHub issue on how to become a committer 2020-10-29 11:32:41 +01:00
AndersonTorres
2bb3a9da24 A directory-category for terminal emulators
This is a mostly cosmetical commit, in the sense it doesn't change the contents
of any package, but reorganizes the overall Nixpkgs expressions.

Terminal emulators are an ubiquitous tool for any Unix user; even the beginners
are routinely familiarized to it. And, manifestly, there are many
implementations of terminal emulators out there, from those traditionally made
in C and C++ to those written in Haskell and Go.

Terminal emulators deserve more highlight. This commit does that by creating a
category for them.
2020-10-28 10:22:39 -03:00
Jan Tojnar
e1af37634b
doc: Improve code listings
By adding prompts and removing unnecessary indentation.
2020-09-23 01:25:25 +02:00
Pavol Rusnak
7b0167204d treewide: use https for nixos.org and hydra.nixos.org
tarballs.nixos.org is omitted from the change because urls from there
are always hashed and checked
2020-05-03 22:14:21 -07:00
davidak
579e56fb9e
Update commit policy for stable release branches (#86026)
only very few people followed the strict policy in the last 5 years. the 
maintainers accept backports without reason when it's obvious, so i 
updated the policy to reflect that
2020-04-26 12:12:55 +00:00
Kyle Sferrazza
2843a7d122 jdiskreport: remove builder.sh link from docs 2020-02-10 20:17:59 +01:00
Ingolf Wagner
9e035c914d
doc/submitting-changes : improved section 15.1 2020-01-03 15:57:52 +13:00
Jörg Thalheim
8a57552c18
nixpkgs-review: 2.1.0 -> 2.1.1
changelog: https://github.com/Mic92/nixpkgs-review/releases/tag/2.1.1
2019-12-22 09:26:57 +00:00
Renaud
c65cbd91f0
doc/contributing: mention icons & themes folders
(#74376)
2019-12-07 16:15:11 +01:00
Profpatsch
85c2bb3781 doc/contributing: mention the word “backporting” for grep-ability
When a contributor wants to know how to do this ominous “backporting”
everybody is talking about, a grep should be enough to find it.
2019-11-15 15:06:54 +01:00
Frederik Rietdijk
ff060579a3 nixpkgs manual: add section on submitting security fixes 2019-11-13 15:00:27 +01:00
Frederik Rietdijk
7805d43e33 nixpkgs manual: fix build
after it was broken by 331f45f7bb
2019-11-13 12:21:47 +01:00
DavHau
331f45f7bb update contributors documentation for nix-review (#73217)
Useful for newcomers who want to do their review after committing and then stumbling across the PR checklist.

* replace nix-shell with nix run
2019-11-12 21:41:30 +01:00
Frederik Rietdijk
62193ec416 nixpkgs manual: document staging-next branch 2019-10-31 19:48:39 +01:00
Frederik Rietdijk
ddbf4c1bac nixpkgs manual: move contributing chapters into one folder 2019-10-30 11:17:14 +01:00