mirror of
https://github.com/NixOS/nixpkgs.git
synced 2026-10-03 21:40:12 +00:00
doc/contributing: collapse tombstoned empty sections
This commit is contained in:
Johannes Kirschbauer
@@ -97,8 +97,7 @@ nixos/modules/installer/tools/nix-fallback-paths.nix @Artturin @Ericson2314 @lo
|
||||
# Contributor documentation
|
||||
/CONTRIBUTING.md
|
||||
/.github/PULL_REQUEST_TEMPLATE.md
|
||||
/doc/contributing/
|
||||
/doc/contributing/contributing-to-documentation.chapter.md @jtojnar
|
||||
/doc/contributing.md @infinisil
|
||||
/lib/README.md
|
||||
/doc/README.md
|
||||
/nixos/README.md
|
||||
@@ -106,10 +105,6 @@ nixos/modules/installer/tools/nix-fallback-paths.nix @Artturin @Ericson2314 @lo
|
||||
/pkgs/by-name/README.md
|
||||
/maintainers/README.md
|
||||
|
||||
# User-facing development documentation
|
||||
/doc/development.md @infinisil
|
||||
/doc/development @infinisil
|
||||
|
||||
# NixOS Internals
|
||||
/nixos/default.nix @infinisil
|
||||
/nixos/lib/from-env.nix @infinisil
|
||||
|
||||
@@ -1 +1,84 @@
|
||||
# Contributing to Nixpkgs {#part-contributing}
|
||||
# Contributing {#part-contributing}
|
||||
|
||||
<!--
|
||||
Legacy anchors. The sections behind these ids used to live in this manual and are
|
||||
now maintained elsewhere. We keep these invisible anchor ids so external URIs would link to this page.
|
||||
-->
|
||||
<!-- moved to CONTRIBUTING.md -->
|
||||
[]{#chap-conventions}
|
||||
[]{#sec-syntax}
|
||||
[]{#sec-organisation}
|
||||
[]{#chap-submitting-changes}
|
||||
[]{#submitting-changes-submitting-changes}
|
||||
[]{#submitting-changes-pull-request-template}
|
||||
[]{#submitting-changes-tested-with-sandbox}
|
||||
[]{#submitting-changes-platform-diversity}
|
||||
[]{#submitting-changes-nixos-tests}
|
||||
[]{#submitting-changes-tested-compilation}
|
||||
[]{#submitting-changes-tested-execution}
|
||||
[]{#submitting-changes-contribution-standards}
|
||||
[]{#submitting-changes-hotfixing-pull-requests}
|
||||
[]{#submitting-changes-commit-policy}
|
||||
[]{#submitting-changes-branches}
|
||||
[]{#submitting-changes-master-branch}
|
||||
[]{#submitting-changes-staging-branch}
|
||||
[]{#submitting-changes-staging-next-branch}
|
||||
[]{#submitting-changes-stable-release-branches}
|
||||
[]{#submitting-changes-stable-release-branches-automatic-backports}
|
||||
[]{#submitting-changes-stable-release-branches-manual-backports}
|
||||
[]{#acceptable-backport-criteria}
|
||||
[]{#chap-reviewing-contributions}
|
||||
[]{#reviewing-contributions-other-submissions}
|
||||
[]{#reviewing-contributions--merging-pull-requests}
|
||||
[]{#part-development}
|
||||
|
||||
<!-- moved to pkgs/README.md -->
|
||||
[]{#chap-quick-start}
|
||||
[]{#sec-package-naming}
|
||||
[]{#sec-versioning}
|
||||
[]{#sec-sources}
|
||||
[]{#sec-source-hashes}
|
||||
[]{#sec-source-hashes-security}
|
||||
[]{#sec-patches}
|
||||
[]{#sec-package-tests}
|
||||
[]{#ssec-inline-package-tests-writing}
|
||||
[]{#ssec-package-tests-writing}
|
||||
[]{#ssec-package-tests-running}
|
||||
[]{#ssec-package-tests-examples}
|
||||
[]{#ssec-nixos-tests-linking}
|
||||
[]{#ssec-import-from-derivation}
|
||||
[]{#submitting-changes-submitting-security-fixes}
|
||||
[]{#submitting-changes-deprecating-packages}
|
||||
[]{#steps-to-remove-a-package-from-nixpkgs}
|
||||
[]{#chap-vulnerability-roundup}
|
||||
[]{#vulnerability-roundup-issues}
|
||||
[]{#vulnerability-roundup-triaging-and-fixing}
|
||||
[]{#reviewing-contributions-package-updates}
|
||||
[]{#reviewing-contributions-new-packages}
|
||||
|
||||
<!-- moved to nixos/README.md -->
|
||||
[]{#reviewing-contributions-module-updates}
|
||||
[]{#reviewing-contributions-new-modules}
|
||||
|
||||
<!-- moved to maintainers/README.md -->
|
||||
[]{#reviewing-contributions-individual-maintainer-list}
|
||||
[]{#reviewing-contributions-maintainer-teams}
|
||||
|
||||
<!-- moved to doc/README.md -->
|
||||
[]{#chap-contributing}
|
||||
|
||||
Contribution documentation lives along the repository scope it applies to:
|
||||
|
||||
- [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md): coding conventions, file organisation, submitting changes, commit policy, branches and backports, reviewing contributions.
|
||||
- [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md): adding and updating packages, package naming and versioning, source fetching and hashes, patches, package tests, deprecating packages, security fixes.
|
||||
- [nixos/README.md](https://github.com/NixOS/nixpkgs/blob/master/nixos/README.md): NixOS modules and reviewing module changes.
|
||||
- [maintainers/README.md](https://github.com/NixOS/nixpkgs/blob/master/maintainers/README.md): maintainer entries and maintainer teams.
|
||||
- [doc/README.md](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md): writing and building this manual.
|
||||
|
||||
## Opening issues {#sec-opening-issues}
|
||||
|
||||
- Make sure you have a [GitHub account](https://github.com/signup/free)
|
||||
- Make sure there is no open issue on the topic
|
||||
- [Submit a new issue](https://github.com/NixOS/nixpkgs/issues/new/choose) by choosing the kind of topic and filling out the template
|
||||
|
||||
<!-- In the future this section could also include more detailed information on the issue templates -->
|
||||
|
||||
@@ -1,63 +0,0 @@
|
||||
# Coding conventions {#chap-conventions}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Syntax {#sec-syntax}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Package naming {#sec-package-naming}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## File naming and organisation {#sec-organisation}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
### Versioning {#sec-versioning}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## Fetching Sources {#sec-sources}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## Obtaining source hash {#sec-source-hashes}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
### Obtaining hashes securely {#sec-source-hashes-security}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## Patches {#sec-patches}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## Package tests {#sec-package-tests}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
### Writing inline package tests {#ssec-inline-package-tests-writing}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
### Writing larger package tests {#ssec-package-tests-writing}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
### Running package tests {#ssec-package-tests-running}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
### Examples of package tests {#ssec-package-tests-examples}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
### Linking NixOS module tests to a package {#ssec-nixos-tests-linking}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
### Import From Derivation {#ssec-import-from-derivation}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
@@ -1,3 +0,0 @@
|
||||
# Contributing to Nixpkgs documentation {#chap-contributing}
|
||||
|
||||
This section has been moved to [doc/README.md](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md).
|
||||
@@ -1,3 +0,0 @@
|
||||
# Quick Start to Adding a Package {#chap-quick-start}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
@@ -1,35 +0,0 @@
|
||||
# Reviewing contributions {#chap-reviewing-contributions}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Package updates {#reviewing-contributions-package-updates}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## New packages {#reviewing-contributions-new-packages}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## Module updates {#reviewing-contributions-module-updates}
|
||||
|
||||
This section has been moved to [nixos/README.md](https://github.com/NixOS/nixpkgs/blob/master/nixos/README.md).
|
||||
|
||||
## New modules {#reviewing-contributions-new-modules}
|
||||
|
||||
This section has been moved to [nixos/README.md](https://github.com/NixOS/nixpkgs/blob/master/nixos/README.md#new-modules).
|
||||
|
||||
## Individual maintainer list {#reviewing-contributions-individual-maintainer-list}
|
||||
|
||||
This section has been moved to [maintainers/README.md](https://github.com/NixOS/nixpkgs/blob/master/maintainers/README.md).
|
||||
|
||||
## Maintainer teams {#reviewing-contributions-maintainer-teams}
|
||||
|
||||
This section has been moved to [maintainers/README.md](https://github.com/NixOS/nixpkgs/blob/master/maintainers/README.md).
|
||||
|
||||
## Other submissions {#reviewing-contributions-other-submissions}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Merging pull requests {#reviewing-contributions--merging-pull-requests}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
@@ -1,88 +0,0 @@
|
||||
# Submitting changes {#chap-submitting-changes}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Submitting changes {#submitting-changes-submitting-changes}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Submitting security fixes {#submitting-changes-submitting-security-fixes}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## Deprecating/removing packages {#submitting-changes-deprecating-packages}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
### Steps to remove a package from Nixpkgs {#steps-to-remove-a-package-from-nixpkgs}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## Pull Request Template {#submitting-changes-pull-request-template}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
### Tested using sandboxing {#submitting-changes-tested-with-sandbox}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
### Built on platform(s) {#submitting-changes-platform-diversity}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
### Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests) {#submitting-changes-nixos-tests}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
### Tested compilation of all pkgs that depend on this change using `nixpkgs-review` {#submitting-changes-tested-compilation}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
### Tested execution of all binary files (usually in `./result/bin/`) {#submitting-changes-tested-execution}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
### Meets Nixpkgs contribution standards {#submitting-changes-contribution-standards}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Hotfixing pull requests {#submitting-changes-hotfixing-pull-requests}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Commit policy {#submitting-changes-commit-policy}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
### Branches {#submitting-changes-branches}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
#### Master branch {#submitting-changes-master-branch}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
#### Staging branch {#submitting-changes-staging-branch}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
#### Staging-next branch {#submitting-changes-staging-next-branch}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
#### Stable release branches {#submitting-changes-stable-release-branches}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
#### Automatically backporting a Pull Request {#submitting-changes-stable-release-branches-automatic-backports}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
#### Manually backporting changes {#submitting-changes-stable-release-branches-manual-backports}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
#### Acceptable backport criteria {#acceptable-backport-criteria}
|
||||
|
||||
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
# Vulnerability Roundup {#chap-vulnerability-roundup}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## Issues {#vulnerability-roundup-issues}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
|
||||
## Triaging and Fixing {#vulnerability-roundup-triaging-and-fixing}
|
||||
|
||||
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
|
||||
@@ -1,6 +0,0 @@
|
||||
# Development of Nixpkgs {#part-development}
|
||||
|
||||
This section shows you how Nixpkgs is developed and how you can interact with the contributors and the latest updates.
|
||||
If you are interested in contributing yourself, see [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
<!-- In the future this section should also include: How to test pull requests, how to know if pull requests are available in channels, etc. -->
|
||||
@@ -1,7 +0,0 @@
|
||||
# Opening issues {#sec-opening-issues}
|
||||
|
||||
* Make sure you have a [GitHub account](https://github.com/signup/free)
|
||||
* Make sure there is no open issue on the topic
|
||||
* [Submit a new issue](https://github.com/NixOS/nixpkgs/issues/new/choose) by choosing the kind of topic and filling out the template
|
||||
|
||||
<!-- In the future this section could also include more detailed information on the issue templates -->
|
||||
42
doc/nav.json
42
doc/nav.json
@@ -645,45 +645,6 @@
|
||||
},
|
||||
{
|
||||
"file": "module-system/module-system.chapter.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Contributing to Nixpkgs",
|
||||
"id": "part-contributing",
|
||||
"children": [
|
||||
{
|
||||
"file": "contributing.md"
|
||||
},
|
||||
{
|
||||
"file": "contributing/quick-start.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "Development of Nixpkgs",
|
||||
"id": "part-development",
|
||||
"children": [
|
||||
{
|
||||
"file": "development.md"
|
||||
},
|
||||
{
|
||||
"file": "development/opening-issues.chapter.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "contributing/coding-conventions.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "contributing/submitting-changes.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "contributing/vulnerability-roundup.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "contributing/reviewing-contributions.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "contributing/contributing-to-documentation.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "Interoperability Standards",
|
||||
@@ -698,6 +659,9 @@
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "contributing.md"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user