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/
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/
_______________________________________________ docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx To unsubscribe send an email to docs-leave@xxxxxxxxxxxxxxxxxxxxxxx Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/docs@xxxxxxxxxxxxxxxxxxxxxxx Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure
