Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc/release-notes: initial cleanup for 24.11 #346059

Merged
merged 9 commits into from
Nov 7, 2024
Merged

doc/release-notes: initial cleanup for 24.11 #346059

merged 9 commits into from
Nov 7, 2024

Conversation

getchoo
Copy link
Member

@getchoo getchoo commented Oct 3, 2024

Most of this is meant to improve grammar and word flow, correct errors, and be more consistent in how certain points are described. It should help serve as a basis for the rest of our work up until 24.11's final release

CC @GetPsyched as the other editor for this release

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.11 Release Notes (or backporting 23.11 and 24.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 8.has: changelog labels Oct 3, 2024
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Oct 3, 2024
GetPsyched
GetPsyched approved these changes Oct 3, 2024
View reviewed changes
Copy link
Member

@GetPsyched GetPsyched left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was a really thorough cleanup, thanks! Just one minor non-blocking nit

nixos/doc/manual/release-notes/rl-2411.section.md Outdated Show resolved Hide resolved
@getchoo getchoo force-pushed the doc/release-notes/cleanup branch 2 times, most recently from b7c6e2d to 6d0ed7f Compare October 3, 2024 14:39
@getchoo getchoo requested a review from GetPsyched October 3, 2024 14:39
GetPsyched
GetPsyched reviewed Oct 4, 2024
View reviewed changes
Copy link
Member

@GetPsyched GetPsyched left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nits + conflicts now

nixos/doc/manual/release-notes/rl-2411.section.md Outdated Show resolved Hide resolved
nixos/doc/manual/release-notes/rl-2411.section.md Outdated Show resolved Hide resolved
emilazy
emilazy reviewed Oct 5, 2024
View reviewed changes
nixos/doc/manual/release-notes/rl-2411.section.md Outdated Show resolved Hide resolved
nixos/doc/manual/release-notes/rl-2411.section.md Outdated Show resolved Hide resolved
nixos/doc/manual/release-notes/rl-2411.section.md Outdated Show resolved Hide resolved
nixos/doc/manual/release-notes/rl-2411.section.md Outdated Show resolved Hide resolved
nixos/doc/manual/release-notes/rl-2411.section.md Outdated Show resolved Hide resolved
nixos/doc/manual/release-notes/rl-2411.section.md Outdated Show resolved Hide resolved
@getchoo getchoo force-pushed the doc/release-notes/cleanup branch from 6d0ed7f to a4975e4 Compare October 5, 2024 02:09
@GetPsyched
Copy link
Member

What's the status of this PR? Let's get this merged soon.

@getchoo getchoo force-pushed the doc/release-notes/cleanup branch from a4975e4 to 93c90fb Compare October 22, 2024 01:54
@getchoo
Copy link
Member Author

getchoo commented Oct 22, 2024

Resolved merge conflicts

@wegank wegank added the 2.status: merge conflict This PR has merge conflicts with the target branch label Nov 1, 2024
@getchoo getchoo force-pushed the doc/release-notes/cleanup branch from 93c90fb to 2780eaa Compare November 1, 2024 17:30
@getchoo getchoo removed the 2.status: merge conflict This PR has merge conflicts with the target branch label Nov 1, 2024
@GetPsyched GetPsyched requested a review from wegank November 1, 2024 21:53
@getchoo getchoo added the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Nov 1, 2024
@getchoo getchoo force-pushed the doc/release-notes/cleanup branch from 2780eaa to 3cfbb43 Compare November 5, 2024 21:06
@getchoo getchoo requested a review from GetPsyched November 5, 2024 21:06
@getchoo
Copy link
Member Author

getchoo commented Nov 5, 2024

Rebased to get rid of merge conflicts.

GetPsyched
GetPsyched approved these changes Nov 5, 2024
View reviewed changes
Copy link
Member

@GetPsyched GetPsyched left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

nixos/doc/manual/release-notes/rl-2411.section.md Show resolved Hide resolved
@ofborg ofborg bot added the 2.status: merge conflict This PR has merge conflicts with the target branch label Nov 6, 2024
@getchoo
doc/release-notes: remove MenhirLib from new modules section
cd546eb 
This is not a module
@getchoo
doc/release-notes: cleanup highlights
abb9985 
The main goal is to make these highlights a bit more concise,
consistently link to newly introduced option definitions, and (somewhat
subjectively) improve word choice to avoid repetition and have a better
flow
@getchoo
doc/release-notes: cleanup backward incompatibilities section
3440341 
The main goal is to make these points a bit more concise, have better
consistency in how removals and deprecations are described, and improve
grammar/flow
@getchoo
doc/release-notes: cleanup notable changes section
4c803ff 
The main goal is to make these points a bit more concise, fix errors,
and (somewhat subjectively) improve word choice to avoid repetition and
have a better flow
@getchoo
doc/release-notes: correctly place backwards incompatible changes
97e382e 
These changes seemed to have been placed in the wrong section
@getchoo
doc/release-notes: use title case for migrations section
b0811ec
@getchoo
doc/release-notes: RFC 42 -> freeform options
29f2478 
"Freeform options" is a term that's a bit more meaningful to regular
users who don't follow development, and thus does a better job at
describing the changes
@getchoo getchoo force-pushed the doc/release-notes/cleanup branch from 3cfbb43 to 29f2478 Compare November 6, 2024 22:20
@getchoo getchoo removed the 2.status: merge conflict This PR has merge conflicts with the target branch label Nov 6, 2024
@getchoo getchoo requested a review from GetPsyched November 6, 2024 22:20
@getchoo
Copy link
Member Author

getchoo commented Nov 6, 2024

Rebased to get rid of merge conflicts.

@getchoo getchoo removed the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Nov 6, 2024
GetPsyched
GetPsyched approved these changes Nov 7, 2024
View reviewed changes
Copy link
Member

@GetPsyched GetPsyched left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looked through rebase diff, all good

@getchoo getchoo added needs_merger (old Marvin label, do not use) 12.approvals: 1 This PR was reviewed and approved by one reputable person labels Nov 7, 2024
@RossComputerGuy RossComputerGuy merged commit 7aaa361 into NixOS:master Nov 7, 2024
27 checks passed
infinisil added a commit to tweag/nixpkgs that referenced this pull request Nov 29, 2024
@infinisil
rl-2411: Match to release branch
b4fd89b 
This specific change was already done before the branch-off in
NixOS#346059, but
NixOS#335832 reverted it accidentally
on master after the branch-off.
@infinisil infinisil mentioned this pull request Nov 29, 2024
Merged
GaetanLepage pushed a commit to GaetanLepage/nixpkgs that referenced this pull request Nov 29, 2024
@infinisil @GaetanLepage
rl-2411: Match to release branch
4058bdd 
This specific change was already done before the branch-off in
NixOS#346059, but
NixOS#335832 reverted it accidentally
on master after the branch-off.
@getchoo getchoo deleted the doc/release-notes/cleanup branch December 5, 2024 01:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jopejoe1 jopejoe1 jopejoe1 left review comments

@emilazy emilazy emilazy left review comments

@GetPsyched GetPsyched GetPsyched approved these changes

@wegank wegank Awaiting requested review from wegank

Assignees
No one assigned
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: changelog 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 12.approvals: 1 This PR was reviewed and approved by one reputable person needs_merger (old Marvin label, do not use)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@getchoo @GetPsyched @emilazy @jopejoe1 @wegank @RossComputerGuy