Fedora 35 release notes are now open!
by Petr Bokoc
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_pat...
[3] https://docs.fedoraproject.org/en-US/fedora-docs/#find-docs
[4] https://docs.fedoraproject.org/en-US/fedora-docs/
2 years, 1 month
How to write release notes
by afolabi oluyosola
Hi, I am AFOLABI, Oluyosola Elizabeth, a first time contributor and would
like to start by writing release note for Fedora 35, I have taken two
issues I am interested in and would like to be put through on how to go
about writing a release note.
Thanks
2 years, 1 month
Global macros -- entitites, I guess -- across Fedora Docs?
by Matthew Miller
I see that the install guide has
./modules/install-guide/pages/_partials/entities.adoc
with things like
:PREVVER: 33
:PRODUCT: Fedora
:PRODVER: Rawhide
:YEAR: 2021
which is pulled in by
include::{partialsdir}/entities.adoc[]
On the wiki, we have macros that can be used ... anywhere on the whole
thing. It'd be nice to have that, for example for refering to our new chat
server by URL.
Is there a way we can do that?
Also: is there a way we can make parameterized macros? Like, something where
we can say {CHATROOM:council}[Fedora Council] and it'll automatically link
that to
https://matrix.to/#/#matrix-meta-chat:fedoraproject.org?web-instance%5Bel...
?
--
Matthew Miller
<mattdm(a)fedoraproject.org>
Fedora Project Leader
2 years, 1 month