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

docs: Add v2022.1 release notes #2609

Merged

Conversation

blocktrron
Copy link
Member

@blocktrron blocktrron commented Aug 11, 2022

This is still unfinished and will most likely not render correctly in ReadTheDocs.

But let's have a first cycle so we can push this through very soon.

Contains changes up to b851354

@github-actions github-actions bot added the 3. topic: docs Topic: Documentation label Aug 11, 2022
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
@rotanid
Copy link
Member

rotanid commented Aug 15, 2022

there are some mentions of Github Issues/PRs in those release notes, but only as numbers, i guess we should hyperlink them

Copy link
Contributor

@herbetom herbetom left a comment

Choose a reason for hiding this comment

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

once #2611 and #2584 are merged the release notes probably should reference those sections

@T-X
Copy link
Contributor

T-X commented Aug 19, 2022

Should the removal of the bridge multicast wakeup call feature and potential downsides for Android users be mentioned?

@T-X
Copy link
Contributor

T-X commented Aug 19, 2022

There should be a mention that this Gluon release now uses OpenWrt 22.03.0-rc6+.

@blocktrron
Copy link
Member Author

@T-X I've included the Bridge-Wakeup regression as "Known Bug", can you have a look?

@AiyionPrime
Copy link
Member

We talked about how we'd warn in the docs about the lacking WG key migration in the last meetup in case we didn't merge #2601 in time.

@blocktrron Do you want that in the known bugs section too? Or somewhere else?

@blocktrron
Copy link
Member Author

@AiyionPrime key migration is a feature, neither a bug nor a regression

@AiyionPrime
Copy link
Member

AiyionPrime commented Aug 27, 2022

Copy link
Member

@AiyionPrime AiyionPrime left a comment

Choose a reason for hiding this comment

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

Looks really nice by now. Only minor stuff from my side;
I have now opinion on whether or not to use points at the end of sentences in listings, but maybe let's make it consistent.

The rocket should be marked in the right category and that doubling of currently being developed should be gone in some way.

docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
@rotanid
Copy link
Member

rotanid commented Aug 28, 2022

i worked through the open remarks.
i also added R6020 which was added to master branch in the meantime.

one thing i'm wondering though:
have you removed the old known issues from this RN on purpose? @blocktrron

docs/releases/v2022.1.rst Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
@blocktrron
Copy link
Member Author

Added release notes and incorporated suggestions.

docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
@herbetom
Copy link
Contributor

The changes from b851354 onward shouldn't be forgotten.

b851354...master

docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
@rotanid rotanid force-pushed the v2022.1.x-release-notes branch 3 times, most recently from 25de28d to e7b20d8 Compare August 31, 2022 00:00
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
@blocktrron blocktrron force-pushed the v2022.1.x-release-notes branch 2 times, most recently from e6869f1 to 97f2f87 Compare August 31, 2022 12:01
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
Copy link
Member

@AiyionPrime AiyionPrime left a comment

Choose a reason for hiding this comment

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

Minor fixes, reads good overall.
Have not looked into whether something is missing though.

docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
docs/releases/v2022.1.rst Outdated Show resolved Hide resolved
@T-X
Copy link
Contributor

T-X commented Sep 1, 2022

Just noticed one more thing for the release, https://gluon.readthedocs.io/en/master/user/getting_started.html#building-the-images, there the "Replace RELEASE with the version you’d like to checkout, e.g. v2021.1." might need an update, too?

@herbetom
Copy link
Contributor

herbetom commented Sep 1, 2022

@T-X it's part of the relase proccess to change that https://github.com/freifunk-gluon/gluon/wiki/Release-Process

blocktrron and others added 4 commits September 5, 2022 17:19
Signed-off-by: David Bauer <mail@david-bauer.net>
Signed-off-by: David Bauer <mail@david-bauer.net>
Signed-off-by: David Bauer <mail@david-bauer.net>
@blocktrron blocktrron merged commit 52883f5 into freifunk-gluon:master Sep 5, 2022
@blocktrron blocktrron deleted the v2022.1.x-release-notes branch September 5, 2022 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3. topic: docs Topic: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants