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 v2019.1 release notes #1815

Closed
wants to merge 1 commit into from
Closed

Conversation

mweinelt
Copy link
Contributor

@mweinelt mweinelt commented Sep 14, 2019

Here we are. Review me!

Thanks to @blocktrron for the help writing some parts of this piece.

Preview: https://shells.darmstadt.ccc.de/~hexa/gluon/1815/

@mweinelt mweinelt added the 3. topic: docs Topic: Documentation label Sep 14, 2019
@mweinelt mweinelt added this to the 2019.1 milestone Sep 14, 2019
@mweinelt mweinelt mentioned this pull request Sep 14, 2019
6 tasks
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 1b2d0f1 to 7758b19 Compare September 14, 2019 12:10
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 7758b19 to b0ce738 Compare September 14, 2019 12:16
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch 6 times, most recently from 9ad4768 to 980f10f Compare September 14, 2019 13:36
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 980f10f to 966d34d Compare September 14, 2019 18:04
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch 4 times, most recently from 5fb1433 to 57be513 Compare September 16, 2019 08:28
@blocktrron
Copy link
Member

AFAIR Gluon 2019.1 is the last release set to be released with batadv-legacy. Maybe this should be noted in the release notes? Same goes for IBSS.

@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 57be513 to 89c724e Compare September 16, 2019 11:49
@mweinelt
Copy link
Contributor Author

mweinelt commented Sep 16, 2019

AFAIR Gluon 2019.1 is the last release set to be released with batadv-legacy. Maybe this should be noted in the release notes? Same goes for IBSS.

Added to important notes, sorted important notes by estimated attention span of the average reader. 😄

@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch 2 times, most recently from 6f49151 to 802b996 Compare September 16, 2019 12:19
@rotanid
Copy link
Member

rotanid commented Sep 16, 2019

Does README.md and docs/user/getting_started.rst could use some new numbers, too?

sure, but are they part of "Add v2019.1 release notes" ?

@mweinelt
Copy link
Contributor Author

Does README.md and docs/user/getting_started.rst could use some new numbers, too?

Sure, was going to add them as soon as the release notes were ready, might as well do it now.

@christf
Copy link
Member

christf commented Sep 16, 2019

Does README.md and docs/user/getting_started.rst could use some new numbers, too?

sure, but are they part of "Add v2019.1 release notes" ?

no they are not. I also disagree that new numbers are required. instead the document should be reworded such that it doesn't age as much. Maybe instead show how to obtain a list of releases and then use placeholders? BUT this is not a discussion that must happen before tagging the next release nor does it have to be in this very issue.

@mweinelt
Copy link
Contributor Author

It's usually this commit that gets the updated version numbers and gets tagged as the release. If someone comes up with a scheme on how to do less version number updates on every release that's fine by me.

@ghost
Copy link

ghost commented Sep 16, 2019

@mweinelt could you also remove unnecessary whitespaces e.g. at the end of lines?

@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 8db9063 to 0ab245a Compare September 16, 2019 22:48
@mweinelt
Copy link
Contributor Author

mweinelt commented Sep 16, 2019 via email

@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 0ab245a to 4588776 Compare September 16, 2019 22:50
@mweinelt
Copy link
Contributor Author

mweinelt commented Sep 16, 2019 via email

docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
@rubo77
Copy link
Contributor

rubo77 commented Sep 17, 2019

the value batman_adv.routing_algo must be set in site.conf now. It is not alowed to leave it empty any more

@mweinelt
Copy link
Contributor Author

the value batman_adv.routing_algo must be set in site.conf now. It is not alowed to leave it empty any more

https://github.com/freifunk-gluon/gluon/pull/1815/files#diff-85f9925dc36f69c841c17388fc2ebb96R160

docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 4588776 to 3d37144 Compare September 18, 2019 19:48
@rotanid rotanid mentioned this pull request Sep 19, 2019
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 3d37144 to fab7589 Compare September 19, 2019 23:16
Copy link
Member

@neocturne neocturne left a comment

Choose a reason for hiding this comment

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

Looking good. Besides the marked style issues, there is one more change that should be mentioned: We now include gluon-radvd by default.

docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from fab7589 to 02442c8 Compare September 21, 2019 12:50
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 02442c8 to c0be946 Compare September 21, 2019 20:25
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from c0be946 to 90528f3 Compare September 21, 2019 21:09
Copy link
Contributor

@T-X T-X left a comment

Choose a reason for hiding this comment

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

Some batman-adv and multicast related comments.

docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
docs/releases/v2019.1.rst Outdated Show resolved Hide resolved
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 90528f3 to 2d09e28 Compare September 22, 2019 10:15
@mweinelt mweinelt force-pushed the release-notes/v2019.1 branch from 2d09e28 to ca36317 Compare September 22, 2019 16:58
@mweinelt
Copy link
Contributor Author

I'm thankful for so many insightful remarks this time round.

The v2019.1 release is out, I've just branched v2019.1.x, the final release notes are up on readthedocs:

https://gluon.readthedocs.io/en/v2019.1/releases/v2019.1.html.

@mweinelt mweinelt closed this Sep 22, 2019
@rotanid rotanid deleted the release-notes/v2019.1 branch September 23, 2019 07:45
@rotanid
Copy link
Member

rotanid commented May 6, 2020

@mweinelt it seems we missed adding #1696 to the new supported hardware section back then?
should we maybe do this for the branch, although it's almost 8 months?

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.

10 participants