summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2023-02-08 11:08:25 +0100
committerpennae <github@quasiparticle.net>2023-02-10 06:40:15 +0100
commitd041641b1abc901191947cd9d7676cd803ccd00b (patch)
treee13a6f2dca1c98b55bd17d6b2c9ac00a99de9364 /CONTRIBUTING.md
parent652a283e51d57ed294cb07774ebf7b95b1a7e59c (diff)
nixos/manual: remove md-to-db
with manual chapters no longer needing pandoc for their conversion to
xml we can get rid of this source of confusion, and its huge cache of
xml files.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 19108bb5a8fb6..7ebff3d332dd3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -128,14 +128,17 @@ Anything that does not cause user or downstream dependency regressions can be ba
 - Security critical applications (E.g. `firefox`)
 
 ## Generating 23.05 Release Notes
+<!--
+note: title unchanged even though we don't need regeneration because extant
+PRs will link here. definitely change the title for 23.11 though.
+-->
 
-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.
+Documentation in nixpkgs is transitioning to a markdown-centric workflow. In the past release notes required a translation step to convert from markdown to a compatible docbook document, but this is no longer necessary.
 
 Steps for updating 23.05 Release notes:
 
 1. Edit `nixos/doc/manual/release-notes/rl-2305.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-2305.section.xml`
-3. Include changes to `rl-2305.section.md` and `rl-2305.section.xml` in the same commit.
+2. Commit changes to `rl-2305.section.md`.
 
 ## Reviewing contributions