Fedora 32 release notes are waiting for your contributions!
by Petr Bokoc
Hi everyone!
Today's F32 Beta Go/No-Go meeting earlier today resulted in a no-go
status, but nevertheless, it's about time we started working on F32
release notes. As usual, we aim to cover notable Changes[0]. Ben Cotton
has been tracking those in the relnotes repo's issues for us, which
allows us to grab a list of everything that needs to be documented[1].
Some of you are already familiar with the process, so go ahead and grab
some issues; branch f32 is waiting for you. For those of you who are new
or need a refresher, here's how it works:
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 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 if you
wrote up the release note and sent a pull request[2] against the main
repo, branch "f32". 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 or
through e-mail; I'll mark it up for you and make sure your contribution
appears in the final document.
If anyone has any questions, go ahead and ask either here on the list or
on IRC/Telegram, I'm happy to help. The current schedule[3] gives us
until April 14 (see line 9), after that we'll be handing the release
notes to the localization team. This gives us a month, which should be
enough to cover the 55 open issues.
Happy writing!
Petr
[0] https://fedoraproject.org/wiki/Releases/32/ChangeSet
[1]
https://pagure.io/fedora-docs/release-notes/issues?status=Open&search_pat...
[2] https://docs.pagure.org/pagure/usage/pull_requests.html
[3] https://fedorapeople.org/groups/schedule/f-32/f-32-docs-tasks.html
4 years
[Fedocal] Reminder meeting : Docs Writing Hour
by pbokoc＠fedoraproject.org
Dear all,
You are kindly invited to the meeting:
Docs Writing Hour on 2020-04-01 from 10:00:00 to 11:00:00 US/Eastern
The meeting will be about:
Join members of the docs team in #fedora-docs for writing time. This is a great time to focus on writing and talk about challenges and blockers related to producing content.
There is no formal schedule for this meeting. Attendees should show up and use this as a way to block writing time into their week.
Source: https://apps.fedoraproject.org/calendar/meeting/9681/
4 years
Directing old docs to new docs
by Ben Cotton
Hi Docs team,
I had a chat this morning with Brian Proffitt (cc'ed), community
wizard and all-around great guy at Red Hat. One thing we discussed is
the apparent lack of release notes beyond F26. I say "apparent"
because I know they're produced, and I know how to find them, but if
you just search "Fedora release notes", you end up in the old
Publican-based site.
I'm sure this has been discussed before, but I'd like to bring it up
again: how can we easily direct people from the old docs to the new?
I don't think we want to remove them, because it's good for historical
reference to have them around, but it would be nice if we could easily
put a banner or something across the top saying "these are historical,
click here for the latest docs".
I know Publican generated the whole of the site, so I'm not sure how
easy it would be to go shoehorn that in. Another approach would be to
run all of the old content through pandoc and rebuild in the new
system. That sounds terrible.
To a large degree, this is an SEO problem, not a docs problem, but
"solving" it as a docs problem seems a lot easier. What do y'all
think?
One thing I'm going to do is add a link to the top of the ChangeSet
wiki pages post-release that links to the Release Notes.
--
Ben Cotton
He / Him / His
Senior Program Manager, Fedora & CentOS Stream
Red Hat
TZ=America/Indiana/Indianapolis
4 years, 1 month
[Fedocal] Reminder meeting : Docs Writing Hour
by pbokoc＠fedoraproject.org
Dear all,
You are kindly invited to the meeting:
Docs Writing Hour on 2020-03-25 from 10:00:00 to 11:00:00 US/Eastern
The meeting will be about:
Join members of the docs team in #fedora-docs for writing time. This is a great time to focus on writing and talk about challenges and blockers related to producing content.
There is no formal schedule for this meeting. Attendees should show up and use this as a way to block writing time into their week.
Source: https://apps.fedoraproject.org/calendar/meeting/9681/
4 years, 1 month
[Fedocal] Reminder meeting : Docs Writing Hour
by pbokoc＠fedoraproject.org
Dear all,
You are kindly invited to the meeting:
Docs Writing Hour on 2020-03-18 from 10:00:00 to 11:00:00 US/Eastern
The meeting will be about:
Join members of the docs team in #fedora-docs for writing time. This is a great time to focus on writing and talk about challenges and blockers related to producing content.
There is no formal schedule for this meeting. Attendees should show up and use this as a way to block writing time into their week.
Source: https://apps.fedoraproject.org/calendar/meeting/9681/
4 years, 1 month
