Fedora 35 release notes are now open!
Petr Bokoc <[email protected]> Thu, 7 Oct 2021 20:17:57 +0000
| Newsgroups | gmane.linux.redhat.fedora.documentation |
|---|---|
| Message-ID | <CAAObbstiRQBC3ZBfDwaAkcMCo7=995UaXJ3+j3ny03jzkTQUSQ@mail.gmail.com> |
--===============7195516856437089760==
Content-Type: multipart/alternative; boundary="0000000000007fdc0905cdc8f720"
--0000000000007fdc0905cdc8f720
Content-Type: text/plain; charset="UTF-8"
Hi everyone,
Fedora 35 Beta is out now[0], so it's time to start writing release notes
once again!
As usual, we aim to cover notable Changes[1]. Ben Cotton has been tracking
those in our release-notes issues for us, which allows us to grab a list of
everything that needs to be documented[2]. Branch *f35* is ready for your
pull requests.
= What to do
1. Pick one or more issues in the list linked above.
2. Open each issue you picked, and click the Take button on the right to
claim it. (If you claim an issue but later find out you don't have time to
write about it, remove yourself from the issue ASAP so others can see it's
free and take it!)
3. Find some information about the issue. A lot of them have plenty of info
in them already; if not, find out who's responsible for the change, and
talk to them on IRC or via mail. Of course it's always better if you try to
do research before you ask questions. Note that you might not always be
able to reach the owner in a reasonable timeframe; in that case just do
your best, I'll be reviewing PRs, so if we publish something wrong, it's on
me.
4. Write a release note about the issue. If you're not sure how exactly a
release note looks, check out some of the previous releases for
inspiration. We don't want any long, overly technical texts, the release
notes are generally meant to highlight changes, not to tell people how to
use something.
5. Now the workflow diverges based on your permissions and technical
skills:
5a. If you know how to use git and asciidoc, we'd appreciate it if you
wrote up the release note and sent a pull request against the main repo,
branch "f35". Your contributions should go into one of the files in
"modules/release-notes/pages/", which one exactly depends on the contents
of the change you're documenting. Use the "build.sh" and "preview.sh"
scripts in the repository root to preview your changes locally; see the
repository README for specific instructions. If you can't see the section
where you added your contributions at all, make sure it's included in
"modules/release-notes/nav.adoc".
5b. If the above sounds like gibberish to you, it's fine: just add a
comment with your text into the issue, and ping me on IRC/Telegram/Matrix
or through e-mail[3]; I'll mark it up for you and make sure your
contribution appears in the final document.
See also our contributor docs[4] for some additional info and tips;
especially the "Git for docs writers" section if you're not familiar with
the system.
If anyone has any questions, go ahead and ask either here on the list or on
IRC, I'm happy to help. The current schedule shows the preferred final
release target on *October 19*, which gives us about 2 weeks to work with,
which really isn't much. The release date may slip, but don't count on it.
Happy writing!
Petr
[0] https://fedoramagazine.org/announcing-fedora-35-beta/
[1] https://fedoraproject.org/wiki/Releases/35/ChangeSet
[2]
https://pagure.io/fedora-docs/release-notes/issues?status=Open&search_pattern=F35&close_status=
[3] https://docs.fedoraproject.org/en-US/fedora-docs/#find-docs
[4] https://docs.fedoraproject.org/en-US/fedora-docs/
--0000000000007fdc0905cdc8f720
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
<div dir=3D"ltr">Hi everyone,<br>
<br>
Fedora 35 Beta is out now[0], so it's time to start writing release not=
es once again!<br>
<br>
As usual, we aim to cover notable Changes[1]. Ben Cotton has been=20
tracking those in our release-notes issues for us, which allows us to=20
grab a list of everything that needs to be documented[2]. Branch *f35*=20
is ready for your pull requests.<br>
<br>
=3D What to do<br>
<br>
1. Pick one or more issues in the list linked above.<br>
<br>
2. Open each issue you picked, and click the Take button on the right to
claim it. (If you claim an issue but later find out you don't have tim=
e
to write about it, remove yourself from the issue ASAP so others can=20
see it's free and take it!)<br>
<br>
3. Find some information about the issue. A lot of them have plenty of=20
info in them already; if not, find out who's responsible for the change=
,
and talk to them on IRC or via mail. Of course it's always better if=
=20
you try to do research before you ask questions. Note that you might not
always be able to reach the owner in a reasonable timeframe; in that=20
case just do your best, I'll be reviewing PRs, so if we publish=20
something wrong, it's on me.<br>
<br>
4. Write a release note about the issue. If you're not sure how exactly=
a
release note looks, check out some of the previous releases for=20
inspiration. We don't want any long, overly technical texts, the releas=
e
notes are generally meant to highlight changes, not to tell people how=20
to use something.<br>
<br>
5. Now the workflow diverges based on your permissions and technical skills=
:=C2=A0=C2=A0<br>
<br>
=C2=A0=C2=A0=C2=A0 5a. If you know how to use git and asciidoc, we'd ap=
preciate it if you=20
wrote up the release note and sent a pull request against the main repo,
branch "f35". Your contributions should go into one of the files=
in=20
"modules/release-notes/pages/", which one exactly depends on the=
=20
contents of the change you're documenting. Use the "build.sh"=
and=20
"preview.sh" scripts in the repository root to preview your chang=
es=20
locally; see the repository README for specific instructions. If you=20
can't see the section where you added your contributions at all, make=
=20
sure it's included in "modules/release-notes/nav.adoc".<br>
<br>
=C2=A0=C2=A0=C2=A0 5b. If the above sounds like gibberish to you, it's =
fine: just add a
comment with your text into the issue, and ping me on IRC/Telegram/Matrix =
or=20
through e-mail[3]; I'll mark it up for you and make sure your=20
contribution appears in the final document.<br>
<br>
See also our contributor docs[4] for some additional info and tips;=20
especially the "Git for docs writers" section if you're not f=
amiliar=20
with the system.<br>
<br>
If anyone has any questions, go ahead and ask either here on the list or
on IRC, I'm happy to help. The current schedule shows the preferred=20
final release target on *October 19*, which gives us about 2 weeks to work =
with, which really isn't much. The release date may slip, but don't=
count on it.<br>
<br>
Happy writing!<br>
<br>
Petr<br>
<br>
[0] <a href=3D"https://fedoramagazine.org/announcing-fedora-35-beta/" targe=
t=3D"_blank">https://fedoramagazine.org/announcing-fedora-35-beta/</a><br>
[1] <a href=3D"https://fedoraproject.org/wiki/Releases/35/ChangeSet" target=
=3D"_blank">https://fedoraproject.org/wiki/Releases/35/ChangeSet</a><br>
[2] <a href=3D"https://pagure.io/fedora-docs/release-notes/issues?status=3D=
Open&search_pattern=3DF35&close_status=3D" target=3D"_blank">https:=
//pagure.io/fedora-docs/release-notes/issues?status=3DOpen&search_patte=
rn=3DF35&close_status=3D</a><br>
[3] <a href=3D"https://docs.fedoraproject.org/en-US/fedora-docs/#find-docs"=
rel=3D"noreferrer" target=3D"_blank">https://docs.fedoraproject.org/en-US/=
fedora-docs/#find-docs</a> <br>[4] <a href=3D"https://docs.fedoraproject.or=
g/en-US/fedora-docs/" rel=3D"noreferrer" target=3D"_blank">https://docs.fed=
oraproject.org/en-US/fedora-docs/</a></div>
--0000000000007fdc0905cdc8f720--
--===============7195516856437089760==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: base64
Content-Disposition: inline
X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KZG9jcyBtYWls
aW5nIGxpc3QgLS0gZG9jc0BsaXN0cy5mZWRvcmFwcm9qZWN0Lm9yZwpUbyB1bnN1YnNjcmliZSBz
ZW5kIGFuIGVtYWlsIHRvIGRvY3MtbGVhdmVAbGlzdHMuZmVkb3JhcHJvamVjdC5vcmcKRmVkb3Jh
IENvZGUgb2YgQ29uZHVjdDogaHR0cHM6Ly9kb2NzLmZlZG9yYXByb2plY3Qub3JnL2VuLVVTL3By
b2plY3QvY29kZS1vZi1jb25kdWN0LwpMaXN0IEd1aWRlbGluZXM6IGh0dHBzOi8vZmVkb3JhcHJv
amVjdC5vcmcvd2lraS9NYWlsaW5nX2xpc3RfZ3VpZGVsaW5lcwpMaXN0IEFyY2hpdmVzOiBodHRw
czovL2xpc3RzLmZlZG9yYXByb2plY3Qub3JnL2FyY2hpdmVzL2xpc3QvZG9jc0BsaXN0cy5mZWRv
cmFwcm9qZWN0Lm9yZwpEbyBub3QgcmVwbHkgdG8gc3BhbSBvbiB0aGUgbGlzdCwgcmVwb3J0IGl0
OiBodHRwczovL3BhZ3VyZS5pby9mZWRvcmEtaW5mcmFzdHJ1Y3R1cmUK
--===============7195516856437089760==--