summary refs log tree commit diff
path: root/.github
diff options
context:
space:
mode:
authorJonathan Ringer <jonringer117@gmail.com>2021-06-02 13:33:46 -0700
committerJonathan Ringer <jonringer117@gmail.com>2021-06-02 13:35:43 -0700
commit428d44b2fd272603f875e57daafc088e0bd98d4e (patch)
tree0cb93c3ada942a3d08071ac53ed9672f4000bf44 /.github
parent0520141db0c60b7ac42f21b401c79b87b78f0c9c (diff)
downloadnixpkgs-428d44b2fd272603f875e57daafc088e0bd98d4e.tar
nixpkgs-428d44b2fd272603f875e57daafc088e0bd98d4e.tar.gz
nixpkgs-428d44b2fd272603f875e57daafc088e0bd98d4e.tar.bz2
nixpkgs-428d44b2fd272603f875e57daafc088e0bd98d4e.tar.lz
nixpkgs-428d44b2fd272603f875e57daafc088e0bd98d4e.tar.xz
nixpkgs-428d44b2fd272603f875e57daafc088e0bd98d4e.tar.zst
nixpkgs-428d44b2fd272603f875e57daafc088e0bd98d4e.zip
.github/CONTRIBUTING.md: Add 21.11 release-notes steps
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index bc43f80a060..76bf94785f2 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -59,6 +59,16 @@ Follow these steps to backport a change into a release branch in compliance with
 5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-20.09`) as the target branch of the pull request, and link to the pull request in which the original change was comitted to `master`. The pull request title should be the commit title with the release version as prefix, e.g. `[20.09]`.
 6. When the backport pull request is merged and you have the necessary privileges you can also replace the label `9.needs: port to stable` with `8.has: port to stable` on the original pull request. This way maintainers can keep track of missing backports easier.
 
+## Generating 21.11 Release Notes
+
+Documentation in nixpkgs is transitioning to a markdown-centric workflow. Release notes now require a translation step to convert from markdown to a compatible docbook document.
+
+Steps for updating 21.11 Release notes:
+
+1. Edit `nixos/doc/manual/release-notes/rl-2111.section.md` with the desired changes
+2. Run `./nixos/doc/manual/md-to-db.sh` to render `nixos/doc/manual/from_md/release-notes/rl-2111.section.xml`
+3. Include changes to `rl-2111.section.md` and `rl-2111.section.xml` in the same commit.
+
 ## Reviewing contributions
 
 See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions).