The ‘’ We Want Feedback ‘’ section provides a link to submit comments.
I followed the link and logged in.
However, I could not figure out how to add document review comments.
How ?
There’s a bug filed here
If you’re logged in viewing the document you can select the bug icon that is on the far right.
Thanks
Joe :
When viewing the document, I don’t see any ‘’ Login ‘’ button.
I assumed logging in to Ask-Fedora and then going back to the Fedora Documentation and clicking the bug and that navigates to the GitLab login page.
After entering my Username and Password, GitLab navigates back to the GitLab Login page and so, I assume GitLab is not accepting my Username and Password.
I assumed I needed to click the GitLab ‘’ Register Now ‘’ link and Register Now says ‘’ Username is already taken ‘’.
What should I be logging in to ?
Michael Amanti
MW users are now realizing MW11 requires 64 GB.
All of those users are now potential Fedora users.
How many of those potential Fedora users will get lost at step # 1,
the Installation Guide ?
Users appreciate extremely usable documents.
Installation is a chronological series of steps.
That is what an installation document should be.
This is a once in a lifetime opportunity for Fedora and IBM.
The Fedora Installation Guide contains paragraph levels
that nested 5 and 6 levels deep, maybe more.
The deeply nested paragraphs make the chronological order of the steps hidden, minimal and extremely vague.
So, this is a once in a lifetime opportunity for improvement.
One time only.
( I doubt there will be second chances. That’s not the kind of world we live in anymore ).
While the login issues are getting resolved,
I am posting my document review comments here . . .
DOCUMENT URL: ( Ask Fedora prohibit links. )
SECTION NAME : Upgrade or Install?
ERROR OR SUGGESTION : DELETE this [ duplicate ] section.
ADDITIONAL INFORMATION :
Upgrading is done after Installing and section ‘’ Upgrading Your Current System ‘’ contains this upgrading information.
DOCUMENT URL: ( Ask Fedora prohibit links. )
SECTION NAME : Preparing Boot Media
ERROR OR SUGGESTION :
‘’ Preparing Boot Media ‘’ must [ always ] be done after ‘’ Downloading Fedora ‘’ [ and before ‘’ Installing Fedora ‘’ ] .
MOVE ‘’ Preparing Boot Media ‘’ [ and all subSections ] to a level 1 heading after ‘’ Downloading Fedora ‘’.
ADDITIONAL INFORMATION : The subSections are [ and to be Level 2 Headings ] . . .
Fedora Media Writer,
Installing and running Fedora Media Writer,
Writing the ISO image to the USB Media,
Other methods to create a live USB, Writing the images to USB media, Creating a Boot CD or DVD }.
Writing the images to USB media,
Creating a Boot CD or DVD .
DOCUMENT URL : ( Ask Fedora prohibit links. )
SECTION NAME : Other methods to create a live USB
ERROR OR SUGGESTION :
The content of ‘’ Other methods to create a live USB ‘’ is [ actually ] about Downloading.
RENAME as ‘’ Other Downloading Methods ‘’.
ADDITIONAL INFORMATION :
In addition to the above MOVE, also include the subsection ‘’ Downloading Boot and Installation Images ‘’.
DOCUMENT URL : ( Ask Fedora prohibit links. )
SECTION NAME : Verifying the Downloaded Image
ERROR OR SUGGESTION :
The ERROR is the ‘’ Verifying the Downloaded Image ‘’ is at the WRONG heading level.
DECREMENT the heading level to unindent.
ADDTIONAL INFORMATION :
DOCUMENT URL : ( Ask Fedora prohibit links. )
SECTION NAME : Booting the Installation
ERROR or SUGGESTION :
This section has only one ( very unecessary ) sentence.
DELETE the sentence.
DELETE the section.
ADDITIONAL INFORMATION :
The remaining two subections are, ‘’ Preparing To Boot ‘’ and ‘’ The Boot Menu ‘’.
DECREMENT their heading levels to unindent.
DOCUMENT URL : ( Ask Fedora prohibit links. )
SECTION NAME : ‘’ After the Installation ‘’
ERROR or SUGGESTION : DECREMENT heading level until this is a Level 1 Heading.
ADDITIONAL INFORMATION : The subsections are [ and to be ] at heading level 2 . . .
Initial Setup
GNOME Initial Setup
Common Post-installation Tasks
DOCUMENT URL : ( Ask Fedora prohibit links. )
SECTION NAME : ‘’ Troubleshooting ‘’
ERROR or SUGGESTION :
DECREMENT heading level until ‘’ Troubleshooting ‘’ is at Level 1 ( i.e. no indentation. )
MOVE this section to after ‘’ Installing Fedora ‘’ [ and before ‘’ After The Installation ].
ADDITIONAL INFORMATION : Adjust / decrement the subsection heading levels.
DOCUMENT URL : ( Ask Fedora prohibit links. )
SECTION NAME : ‘’ Setting Up an Installation Server ‘’
ERROR or SUGGESTION :
DECREMENT the ‘’ Setting Up an Installation Server ‘’ heading level to Level 1 Heading. ( i.e. no indentation. )
ADDITIONAL INFORMATION : Adjust / decrement subsection heading levels accordingly.
DOCUMENT URL : ( Ask Fedora prohibit links. )
SECTION NAME : ‘’ Installing Using VNC ‘’
ERROR or SUGGESTION :
DECREMENT heading level until it becomes a Level 1 heading. ( i.e. no indentation. )
ADDITIONAL INFORMATION : Adjust / decrement subsection heading levels accordingly.
DOCUMENT URL : ( Ask Fedora prohibit links. )
SECTION NAME : ‘’ Upgrading Your Current System ‘’
ERROR or SUGGESTION : DECREMENT the heading level until it is a Level 1 heading.
ADDITIONAL INFORMATION : RENAME to ‘’ Updating and Upgrading Fedora’'. ADD updating information.
It looks like you’ll want to sign in with a gitlab account not your FAS Account.
My appologies for not noticing that I was already signed into gitlab.
Joe :
Today I was able to create GitLab account using the same Username and Password as on Ask-Fedora and submit my comments.
[[f36] Doc issue [ Deeply Nested Paragraph Heading Levels ] . . .
Thank You Joe.
Michael
1 Like
Thanks!
If you’re interested you may want to head over to https://discussion.fedoraproject.org and see what else the docs team is up to.
One additional comment I included in the GitLab post is that Red Hat’s Installation Guide may ( or may not ) be used as an example, guideline or concept.
There, I think the paragraph heading levels go to about 3 maximum.
So naturally, the chronological steps get serialized and are easy to see.
Performing a standard RHEL 9 installation
Okay,
I trust the documentation team will do their best for all of the document users.
I am positive the changes will be appreciated.
You can close this Ask-Fedora post [ if it has a status ].
THANK YOU
Here is a [ somewhat ] related and recent Fedora Magazine article . . .
Improvements to Fedora Docs
1 Like
@amanti
Could you point the URL/navigation path of the “We Want Feedback” section, so we can assist you and point you to right content/communication channels for your contributions?
I would navigate to Fedora Documentation :: Fedora Docs
I think there are two different questions you raised.
-
How to submit comments / add document review comments
If you want to edit Docs, please find the contributor guide. -
Fedora installer experience (Anaconda GUI installation): which appears to why you wanted to submit comments as in 1. I presume you’re installing the Workstation edition.
Depending on how you create live USB and which documentation you are referring to,
2-1. Quick Docs
2-2. Docs / User Documentation / Fedora Linux 36 / Fedora 36 User Documentation / Installation Guide
https://docs.fedoraproject.org/en-US/fedora/latest/install-guide/install/Preparing_for_Installation/
2-3. Fedora Magazine: I posted a beginner’s guide for OS switchers.
If you want to discuss more about the installation experience, as @grumpey suggested, please head over to discussion and search with #docs
2 Likes
Hank :
I was only submitting document review comments.
Michael
Vintage 2006 : Fedora 7 Installation Guide
https://docs.fedoraproject.org/en-US/Fedora/7/pdf/Installation_Guide/Fedora-7-Installation_Guide-en-US.pdf
Notice the paragraph heading levels are at level 1 and level 2 only.
There are NO [ i.e zero ] three level headings.
What happened ?
I’ve been looking at the Meta Documents, the documents about the documents.
There is a document there about " Publican ", ye ole book publishing tool, last updated in 2010 and so it does not have any information about what led to it’s demise.
Then I searched Fedora Magazine for articles about Publican and found this,
Fedora’s Documentation Website has been overhauled
It just says ‘’ Our build tool, publican, was no longer supported ‘’.
What happened ?