Commit Graph

46 Commits

Author SHA1 Message Date
aleksana
ecbb896800 pkgs/README.md: classify and add rules to the naming convention
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-09-12 08:11:03 +02:00
Silvan Mosberger
aec0d14834 treewide: Fix or remove some markdown links
Found using https://github.com/serokell/xrefcheck, which unfortunately
can't trivially be enforced in CI because we also have the manual markdown
files that need post-processing to be valid
2024-09-03 23:37:05 +02:00
Doron Behar
34445ddb2d pkgs/README: recommend & redirect to pkgs/by-name in versioning section 2024-08-18 16:46:48 +03:00
Gavin John
1d40b45af4 pkgs/README: Add second example of versioning 2024-08-07 18:28:19 +01:00
Anderson Torres
b59dfac3c6 pkgs/README.md: cite adoption as an alternative 2024-06-17 10:00:13 -03:00
Travis A. Everett
9ff9bbdb34
doc: add stdenv passthru chapter (#315909)
* doc: add stdenv passthru chapter

Broad strokes:
- create the chapter
- move existing stdenv passthru coverage into it
- move out-of-place coverage of passthru.tests from the stdenv meta chapter into it
- (try to) apply 1-sentence-per-line to text I've touched
- add legacy anchors for everything moved
- update existing links to the new anchors
- add tentative motivating text
- make nixpkgs-internal links relative/branchless

razor: if it is only ever needed by contributors, which is likely if links
refer to the latest revision of the source code, then it's for
the contributor guide

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-06-11 10:51:03 +02:00
Alexis Hildebrandt
f8c4a98e8e treewide: Remove the definite article from meta.description
nix run nixpkgs#silver-searcher -- -G '\.nix$' -0l 'description.*"([Tt]he)? ' pkgs \
  | xargs -0 nix run nixpkgs#gnused -- -i '' -Ee 's/(description.*")[Tt]he (.)/\1\U\2/'
2024-06-09 23:08:46 +02:00
Alexis Hildebrandt
755b915a15 treewide: Remove indefinite article from meta.description
nix run nixpkgs#silver-searcher -- -G '\.nix$' -0l 'description.*"[Aa]n?' pkgs \
  | xargs -0 nix run nixpkgs#gnused -- -i '' -Ee 's/(description.*")[Aa]n? (.)/\1\U\2/'
2024-06-09 23:07:45 +02:00
Arnout Engelen
cbfd7ee395
CONTRIBUTING.md: patch conventions
As discussed in the NixOS Security Discussion Matrix room at
https://matrix.to/#/!NBBFPbiuttRgTqbrcY:nixos.org/$kRB7R9ksae-78H4GQOO7NjMurKh7hSHimYSGMVE3w8k?via=nixos.org&via=matrix.org&via=nixos.dev and #317169

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
2024-06-05 23:04:42 +02:00
Peder Bergebakken Sundt
51cd84ba57 pkgs/README.md: add meta.mainProgram to new-package checklist template
The document already states that `meta.mainProgram` is mandatory for new packages, this change adds it to the template list of checks during review.
2024-05-03 00:47:59 +02:00
Daniel Sidhion
0decb324b3
doc: improve fetchers overview, deduplicate readme content, follow doc conventions (#297654)
* doc: improve fetchers overview, deduplicate readme content

* Improve caveat explanation and some fetchurl content

* move out consumer docs on source fetching

* move note on mirror URLs to the relevant section

this may be better suited for the `fetchurl` reference, but it's probably better to
just render that information into the manual. for now, because
- contributor documentation encourages mirrors
- we can expect contributors to dig into the source
- linking source files is trivial in in-code documentation
we leave it there.

* move instructions for updating hashes to the manual

* Add more clarity on text, reorganise source hash methods

---------

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Dominic Mills-Howell <dominic.millz27@gmail.com>
Co-authored-by: lolbinarycat <dogedoge61+github@gmail.com>
2024-04-03 08:18:11 +02:00
Janne Heß
fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
Janne Heß
bc77c7a973 treewide: Mark Nix blocks in markdown as Nix
This should help us with highlighting and future formatting.
2024-03-28 09:28:12 +01:00
binarycat
3caacb17e5 doc: add link to the language frameworks from the pkgs quickstart 2024-03-14 16:15:31 -04:00
Ben Price
f72b809df5 rnix-lsp: remove package
Upstream has been archived. The current package is not installable by
default, since it depends on nix 2.15 which is marked as insecure.
2024-03-09 11:46:52 +00:00
itslychee
ee4140e38c
doc: remove extraneous url in pkgs/README.md
I don't believe there is supposed to be two urls in the fetchers example
2024-03-03 18:36:36 -06:00
benaryorg
38a6a35c33
pkgs/README.md: fix markup
Signed-off-by: benaryorg <binary@benary.org>
2024-02-23 17:20:34 +00:00
Silvan Mosberger
12d7391dac
Merge pull request #281490 from eclairevoyant/docs-mainprogram
pkgs/README.md: clarify guidelines for `meta.mainProgram`
2024-02-10 03:01:04 +01:00
éclairevoyant
6e5e339680
pkgs/README.md: clarify guidelines for meta.mainProgram 2024-02-06 21:10:02 -05:00
Fabian Affolter
c01d3cb418
pkgs/README.md: Fix formatting (#284244) 2024-01-27 14:20:42 +01:00
OPNA2608
cb89165fb9 pkgs/README.md: Clarify versioning on projects lacking proper releases 2024-01-11 17:40:24 +01:00
Silvan Mosberger
4769458228 CONTRIBUTING.md: Update markdown emphasising syntax
GitHub supported special markdown syntax for emphasising blocks for some
time. This was however a beta feature, and still is, so it's subject to
changes.

Recently such a change happened: The syntax is different now.

See https://github.com/orgs/community/discussions/16925 for more
information
2023-12-06 03:51:39 +01:00
Silvan Mosberger
e89ad83555
Merge pull request #263059 from DanielSidhion/add-doc-convention
doc: commit header convention for documentation changes
2023-11-14 08:11:41 +01:00
DS
e93a3d7b58 doc: separate commit header conventions for each area, info on docs changes. 2023-11-13 20:41:08 -08:00
Silvan Mosberger
fdee770336
Merge pull request #263575 from pbsds/contributing-link-naming-conventino
CONTRIBUTING: Add hotlinks to package and module reviewing guides, minor touchups
2023-11-13 14:01:33 +01:00
Peder Bergebakken Sundt
8feb68f965 {pkgs,nixos}/README.md: Hotlink package and module reviewing guidelines, fix references 2023-11-13 13:46:14 +01:00
Paul Meyer
7d7744f15f pkgs: fix nixosTests command in docs
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
2023-11-01 11:55:29 +01:00
Jussi Kuokkanen
64db4d240e pkgs/README.md: clarify when meta.maintainers should be set 2023-10-20 00:14:08 +03:00
Valentin Gagarin
61fa1255f8 link to documentation on IFD in the Nix manual 2023-10-09 23:57:03 +02:00
Peder Bergebakken Sundt
470614b671 treewide: Fix typos 2023-09-28 19:06:13 +02:00
Silvan Mosberger
ad61076624
Merge pull request #237439 from tweag/spp-1
[RFC 140] Simple package paths, part 1b: Enabling the directory structure
2023-09-05 16:25:27 +02:00
Silvan Mosberger
77d50b03e4 hello: Move to pkgs/by-name 2023-09-05 16:11:04 +02:00
Silvan Mosberger
87f7f1641c pkgs/README.md: Update to mention pkgs/by-name 2023-09-05 16:11:03 +02:00
Valentin Gagarin
48da6eb9c1
pkgs/README.md: slight rewording (#252820) 2023-09-01 20:04:48 +02:00
Jonas Chevalier
c330720b48
pkgs: add consideration for new packages (#250352)
Nixpkgs is not your personal depot. Add a light decision-making
framework to help decide what fits in the project or not.

Co-authored-by: Anderson Torres <torres.anderson.85@protonmail.com>
Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
Co-authored-by: Ryan Lahfa <masterancpp@gmail.com>
2023-08-24 02:38:25 +02:00
Silvan Mosberger
aafc9aee38 pkgs/README.md: Remove some mediocre duplicated sentences
Also mainly covered in the section below
2023-08-14 04:51:20 +02:00
Silvan Mosberger
e6307807a8 pkgs/README.md: Minor header and link fixes 2023-08-14 04:27:12 +02:00
Silvan Mosberger
5789cc3754 CONTRIBUTING.md: Clean up "Making patches" section
Moving and collecting bits into the appropriate places, also writing
some new sentences
2023-08-13 22:04:57 +02:00
Silvan Mosberger
44293fb032 pkgs/README.md: Add overview 2023-08-13 22:04:57 +02:00
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
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
b7c525806e CONTRIBUTING.md: 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.
2023-08-13 22:01:23 +02:00
Silvan Mosberger
d70091c3ad Create unified markdown files for contributing docs 2023-08-13 21:54:50 +02:00