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_pa... [3] https://docs.fedoraproject.org/en-US/fedora-docs/#find-docs [4] https://docs.fedoraproject.org/en-US/fedora-docs/
Great stuff Petr!
On Thu, 7 Oct 2021 at 21:26, Petr Bokoc pbokoc@redhat.com wrote:
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
Pick one or more issues in the list linked above.
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!)
- 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.
- 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.
- 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 youwrote 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 acomment 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_pa... [3] https://docs.fedoraproject.org/en-US/fedora-docs/#find-docs [4] https://docs.fedoraproject.org/en-US/fedora-docs/ _______________________________________________ docs mailing list -- docs@lists.fedoraproject.org To unsubscribe send an email to docs-leave@lists.fedoraproject.org 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@lists.fedoraproject.org Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure
Sarah and others. Not having all access, I was able to download and edit/validate the following from (Rawhide version) install-guide/modules/install-guide/pages/install I have walked through, validated and edited the following rw-rw-r-- 1 leslie leslie 7602 Oct 10 16:31 After_Installation.adoc -rw-rw-r-- 1 leslie leslie 6231 Oct 10 16:52 Booting_the_Installation.adoc -rw-rw-r-- 1 leslie leslie 11774 Oct 11 21:42 Installing_Using_Anaconda.adoc -rw-rw-r-- 1 leslie leslie 16164 Oct 11 22:40 Preparing_for_Installation.adoc -rw-rw-r-- 1 leslie leslie 25895 Oct 12 12:37 Troubleshooting.adoc
I cannot update the git repository, which because I do not have update access,
I need some help with Andora or other tools to print my updates, so I can share what I have done Again, there were many hours contributed to correcting grammar and phrasiology Is anyone, willing to accept an email with my updates as an attachment
I prefer to make these 5 adoc files available for someone to print out I can create a tar file, and put that tar file onto a google drive, onto dropbox, so that someone more familar with Fedora's *adoc
Regards Leslie Leslie Satenstein Montréal Québec, Canada
On Tuesday, October 12, 2021, 12:25:30 p.m. GMT-4, Sarah Finn sfinn@redhat.com wrote:
Great stuff Petr! On Thu, 7 Oct 2021 at 21:26, Petr Bokoc pbokoc@redhat.com wrote:
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_pa... [3] https://docs.fedoraproject.org/en-US/fedora-docs/#find-docs [4] https://docs.fedoraproject.org/en-US/fedora-docs/___________________________... docs mailing list -- docs@lists.fedoraproject.org To unsubscribe send an email to docs-leave@lists.fedoraproject.org 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@lists.fedoraproject.org Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure
Leslie S Satenstein kirjoitti 12.10.2021 klo 23.57:
Sarah and others. Not having all access, I was able to download and edit/validate the following from (Rawhide version) install-guide/modules/install-guide/pages/install I have walked through, validated and edited the following rw-rw-r-- 1 leslie leslie 7602 Oct 10 16:31 After_Installation.adoc -rw-rw-r-- 1 leslie leslie 6231 Oct 10 16:52 Booting_the_Installation.adoc -rw-rw-r-- 1 leslie leslie 11774 Oct 11 21:42 Installing_Using_Anaconda.adoc -rw-rw-r-- 1 leslie leslie 16164 Oct 11 22:40 Preparing_for_Installation.adoc -rw-rw-r-- 1 leslie leslie 25895 Oct 12 12:37 Troubleshooting.adoc
I cannot update the git repository, which because I do not have update access,
For repositories where you do not have commit access, you can use the fork workflow.
The forking workflow would go as follows:
1. Open the repository web page https://pagure.io/fedora-docs/release-notes 2. Click "Clone", copy the "SSH" url on clipboard 3. Open terminal, run: $ git clone SSH_URL_FROM_CLIPBOARD. This creates folder "release-notes" in the current working directory, with the repository contents checked out. 4. Enter the folder: $ cd release-notes 5. Go back to the repository web page, click "Fork" 6. Page staying "Waiting" opens, so wait 7. Page for your freshly created fork opens, the heading should be YOUR_USERNAME/fedora-docs/release-notes 8. Click on the "Clone" button, copy the "SSH" url on clipboard 9. Open terminal, run: $ git remote add fork FORK_SSH_URL_FROM_CLIPBOARD 10. This connect your local copy of the repository to your fork as remote named "fork". 11. Create a Git branch for your fixes: $ git checkout -b my-branch 12. Apply your changes 13. Check your work: $ git diff 14. Fix errors as needed 15. When the diff looks good, create a commit from your work: $ git add . && git commit -m "Description of your changes" 16. Push your changes to your fork: $ git push -u fork my-branch 17. In terminal, a url is printed for creating a pull request. Open it, fill any details as needed, then click "Create Pull Request". 18. Now your work should be visible for the repository maintainers to review at https://pagure.io/fedora-docs/release-notes/pull-requests
Eighteen steps to submit an update! I know this may seem arcane and unnecessarily complicated before you get a hold of it. However, this workflow brings great benefits in allowing multiple people to work in parallel, merging those changes in safe manner, allowing review of all contributions and keeping logs of who did what, when and why. And, once you get familiar with Git, all of this becomes second nature.
Note that there are many variations of this, so somebody else may suggest somewhat different steps, which would still produce the correct result.
I need some help with Andora or other tools to print my updates, so I can share what I have done Again, there were many hours contributed to correcting grammar and phrasiology Is anyone, willing to accept an email with my updates as an attachment
This should be as easy as running the following command in your local repository checkout:
$./build.sh && ./preview.sh
That command should print a url where you can locally inspect the end result.
Otto
On Wed, Oct 13, 2021 at 08:23:55AM +0300, Otto Urpelainen wrote:
Eighteen steps to submit an update! I know this may seem arcane and unnecessarily complicated before you get a hold of it. However, this
An important note is that many of the steps are one-time setup for a given document repository -- you don't need to do all of them all of the time.
And, if you use a modern IDE, many of the steps are actually built in.
Thanks for reaching out to Leslie. Petr would be the best person to provide an answer. Thanks Sarah
On Tue, 12 Oct 2021 at 21:58, Leslie S Satenstein lsatenstein@yahoo.com wrote:
Sarah and others.
Not having all access, I was able to download and edit/validate the following from (Rawhide version) install-guide/modules/install-guide/pages/install
I have walked through, validated and edited the following
rw-rw-r-- 1 leslie leslie 7602 Oct 10 16:31 After_Installation.adoc -rw-rw-r-- 1 leslie leslie 6231 Oct 10 16:52 Booting_the_Installation.adoc -rw-rw-r-- 1 leslie leslie 11774 Oct 11 21:42 Installing_Using_Anaconda.adoc -rw-rw-r-- 1 leslie leslie 16164 Oct 11 22:40 Preparing_for_Installation.adoc -rw-rw-r-- 1 leslie leslie 25895 Oct 12 12:37 Troubleshooting.adoc
I cannot update the git repository, which because I do not have update access,
I need some help with Andora or other tools to print my updates, so I can share what I have done
Again, there were many hours contributed to correcting grammar and phrasiology
Is anyone, willing to accept an email with my updates as an attachment
I prefer to make these 5 adoc files available for someone to print out I can create a tar file, and put that tar file onto a google drive, onto dropbox, so that someone more familar with Fedora's *adoc
Regards
- Leslie*
*Leslie Satenstein* *Montréal Québec, Canada*
On Tuesday, October 12, 2021, 12:25:30 p.m. GMT-4, Sarah Finn < sfinn@redhat.com> wrote:
Great stuff Petr!
On Thu, 7 Oct 2021 at 21:26, Petr Bokoc pbokoc@redhat.com wrote:
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
Pick one or more issues in the list linked above.
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!)
- 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.
- 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.
- 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 youwrote 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 acomment 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_pa... [3] https://docs.fedoraproject.org/en-US/fedora-docs/#find-docs [4] https://docs.fedoraproject.org/en-US/fedora-docs/ _______________________________________________ docs mailing list -- docs@lists.fedoraproject.org To unsubscribe send an email to docs-leave@lists.fedoraproject.org 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@lists.fedoraproject.org Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure
--
Sarah Finn
She/Her
Senior Agile Practitioner
Agile DevOps CoP Manager
Red Hat https://www.redhat.com/
Waterford, Ireland
sfinn@redhat.com M: 0879830832 @RedHat https://twitter.com/redhat Red Hat https://www.linkedin.com/company/red-hat Red Hat https://www.facebook.com/RedHatInc https://www.redhat.com/
*"If you are not willing to risk the usual, you will have to settle for the ordinary."* _______________________________________________ docs mailing list -- docs@lists.fedoraproject.org To unsubscribe send an email to docs-leave@lists.fedoraproject.org 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@lists.fedoraproject.org Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure _______________________________________________ docs mailing list -- docs@lists.fedoraproject.org To unsubscribe send an email to docs-leave@lists.fedoraproject.org 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@lists.fedoraproject.org Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure
-
Leslie S Satenstein -
Matthew Miller -
Otto Urpelainen -
Petr Bokoc -
Sarah Finn