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.

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

23.11 release notes: editing updates #270967

Merged
merged 6 commits into from
Nov 29, 2023

Conversation

alejandrosame
Copy link
Member

This PR implements the editorial changes to the release notes for release 23.11.

Co-authored by: Lennart Mühlenmeier [email protected]

Closes #270257

Co-authored-by: Lennart Mühlenmeier <[email protected]>
Copy link
Member

@figsoda figsoda left a comment

Choose a reason for hiding this comment

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

found a few typos with typos

nixos/doc/manual/release-notes/rl-2311.section.md Outdated Show resolved Hide resolved
nixos/doc/manual/release-notes/rl-2311.section.md Outdated Show resolved Hide resolved
nixos/doc/manual/release-notes/rl-2311.section.md Outdated Show resolved Hide resolved
network interface is irrelevant.

- `services.outline` can be configured to use local filesystem storage now.
Previously ony S3 storage was possible. This may be set using
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Previously ony S3 storage was possible. This may be set using
Previously only S3 storage was possible. This may be set using

@@ -1,262 +1,258 @@
# Release 23.11 (“Tapir”, 2023.11/??) {#sec-release-23.11}
Copy link
Member

Choose a reason for hiding this comment

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

The ?? need to be changed to the actual release date at some point. Though I do not know when?

Comment on lines 1377 to 1381
### Nixpkgs Internals {#sec-release-23.11-nixpkgs-internals}

- The use of `sourceRoot = "source";`, `sourceRoot = "source/subdir";`, and
similar lines in package derivations using the default `unpackPhase` is
deprecated as it requires `unpackPhase` to always produce a directory named
Copy link
Member

Choose a reason for hiding this comment

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

As mention before, all of these items aren't internal, I don't think it makes sense to have this section.

Copy link
Member

Choose a reason for hiding this comment

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

Could you propose a better fitting title?

Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't move those because I wasn't too sure where to put them. I think the reason they have been marked "internal" it's because they refer to package or service making, instead of the packages and options themselves. Where would they fit?

Copy link
Member

Choose a reason for hiding this comment

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

I'll make a PR!

Copy link
Member Author

Choose a reason for hiding this comment

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

After all the cleanup, I see them either as breaking changes or other notable changes, so I'll move them and update outline and the TOC. I think we can still do better on how to better segment the release notes, but I'll put those efforts going into the future into the autogeneration and then the discussion can move into proper tagging of the documentation of changes.

Copy link
Member

Choose a reason for hiding this comment

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

Actually yeah I see what you mean. I feel like we'd need a much clearer separation to make it work nicely. I guess let's just leave it the way it is for now :)

@Kranzes
Copy link
Member

Kranzes commented Nov 29, 2023

found a few typos with typos

On markdown I like nodePackages.gramma

@figsoda figsoda marked this pull request as ready for review November 29, 2023 17:09
@figsoda figsoda merged commit b460856 into NixOS:master Nov 29, 2023
5 of 6 checks passed
Copy link
Contributor

Backport failed for release-23.11, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin release-23.11
git worktree add -d .worktree/backport-270967-to-release-23.11 origin/release-23.11
cd .worktree/backport-270967-to-release-23.11
git switch --create backport-270967-to-release-23.11
git cherry-pick -x 45f3f29207f930a3072a52dd9323cebedff8a067 ff2ee568db84efb3746c48b0aff955e40d211249 2bae6aae50dd83047cff98cc84a96b0ce2516bd4 cac88ff0f1468986f4c2f127855cf2a58463a83b 0ec4898213268a6fd8693547c2127ba4286ad802 0fc9c809bfa6f04c9f7d953afa0c7325870da5b9

@SuperSandro2000
Copy link
Member

SuperSandro2000 commented Dec 4, 2023

It was not very smart to trim the line lengths of the changelog because now we have a shit ton of merge conflict for no reason.

Also this should have been done in a separate commit. Now no one knows if not a mistake in some line was done or something was deleted by accident. The release before this, that happened and some lines were just forgotten in the merge conflicts.

In addition to that line length does not matter for the final output of markdown and there are certain ppeople (like me) which have a pretty hard time to understand what is written in a sentence when it is split over 5 lines. So I usually need to undo the short line formatting otherwise I have a pretty hard time to understand what is actually written.

Comment on lines +496 to +499
v0.11.0](https://github.com/ory/kratos/releases/tag/v0.11.0), [v0.11.0 to
v0.11.1](https://github.com/ory/kratos/releases/tag/v0.11.1), [v0.11.1 to
v0.13.0](https://github.com/ory/kratos/releases/tag/v0.13.0) and [v0.13.0 to
v1.0.0](https://github.com/ory/kratos/releases/tag/v1.0.0) upgrade guides.
Copy link
Member

Choose a reason for hiding this comment

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

The link text is now also no longer searchable and a simple grep for the link text shown in the final document does not reveal this location. This just creates churn and frustration.

@alejandrosame
Copy link
Member Author

alejandrosame commented May 2, 2024

For future reference: the actual changes are more easy to follow by checking the commits that affect the folder nixos/doc/manual/release-notes/rl-2311/ in the original working branch: https://github.com/alejandrosame/nixpkgs/commits/rl-2311-editorial-changes/.

The workflow followed wasn't supported in #262296, but @riotbib and I continued using from our side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rl-23.11: New outline proposal
6 participants