DocBook: http://www.se.clara.net/fedora/fedora-install-guide-0.2.tar.gz
HTML output: http://www.se.clara.net/fedora/fedora-install-guide-en/index.html
Various minor edits, but no new pieces. -- Stuart Ellis s.ellis@fastmail.co.uk
Hi
You should probably add the instructions to download and burn a ISO or link to appropriate documentation.Many users are unsure of which ISO's are needed. Specifically make sure you explain to them that the images containing srpms are NOT required and how many images and required for the basic installation. It would very useful to include instructions for burning a image from Windows also
http://linuxiso.org/viewdoc.php/isofaq.html
The above seems to fit the needs well.
" Fedora Core does not support installation with diskettes."
I suppose you mean floppy disks here. Make sure the language is more explicit throughout the guide
"No changes are made to your computer until package installation commences."
" The Fedora installation system has three elements"
Non native speakers would probably appreciate a more basic form. replace commences with starts and elements with parts of something similar. This applies for the whole documentation
"Insert CD 1 into the CD or DVD drive."
The user has an option to download and use the DVD so it should be something like "Insert the first CD/DVD into the CD/DVD drive"
SELinux is likely to be transparent to the end users but administrators who are new to the concept would certainly want to learn better about it and it is NOT transparent to them in all occasions. This is one of the reasons why I wanted you to link to the selinux faq
http://fedora.redhat.com/docs/selinux-faq-fc2/ http://fedora.redhat.com/docs/selinux-faq-fc3test2/
"You can also launch the system administration tools included in Fedora Core from any user account using the root password."
This would be a more precise version. "It is recommended that you use user system as a normal(non root)user. Any system administration tools in the graphical user interface would prompt for a root password if its required"
Make sure you mention that the configuration stuff that is setup using the "setup agent" is OPTIONAL. This is one of the reasons why firstboot has been split up from anaconda
"If you have to reconfigure the sound card later, you can use the system-config-soundcard utility. This is the menu item System Settings->Soundcard Detection."
make sure you mention the menu item first and follow it by command line equivalents wherever appropriate. we should be targetting end users who are comfortable using the GUI better
I request you put up screenshots wherever applicable atleast temporarily. It would help me associate the content with the appropriate screens better.(just for review purposes)
regards Rahul Sundaram
__________________________________ Do you Yahoo!? Yahoo! Mail Address AutoComplete - You start. We finish. http://promotions.yahoo.com/new_mail
Some additional corrections or re-interpretations below, with a nod to correct style:
On Tue, 2004-10-26 at 16:25, Rahul Sundaram wrote:
" Fedora Core does not support installation with diskettes."
I suppose you mean floppy disks here. Make sure the language is more explicit throughout the guide
Also, it would be better to say "from diskettes."
"Insert CD 1 into the CD or DVD drive."
The user has an option to download and use the DVD so it should be something like "Insert the first CD/DVD into the CD/DVD drive"
No slashes please -- try: "Insert the first disc into the CD or DVD drive." (Notice that "disc" is generic.)
"You can also launch the system administration tools included in Fedora Core from any user account using the root password."
This would be a more precise version. "It is recommended that you use user system as a normal(non root)user. Any system administration tools in the graphical user interface would prompt for a root password if its required"
But please avoid passive voice. Try:
"You should use your &FC; system as a normal, non-root user. System administration tools which require administrator access will prompt you for the password for the root account."
(Note that this works outside the GUI as well, e.g. printconf.)
"If you have to reconfigure the sound card later, you can use the system-config-soundcard utility. This is the menu item System Settings->Soundcard Detection."
"If you have to reconfigure the sound card later, use the system-config-soundcard utility. From the GUI menu, choose System Settings, Soundcard Detection."
make sure you mention the menu item first and follow it by command line equivalents wherever appropriate. we should be targetting end users who are comfortable using the GUI better
I think the above statement takes care of everyone. Non-CLI friendly users will ignore the program name and follow the GUI steps. Saving the program name until second will probably often result in tortured syntax.
Just an editorial $0.02...
Hi
No slashes please -- try: "Insert the first disc into the CD or DVD drive." (Notice that "disc" is generic.)
Well. I just noticed that there is just one DVD and this might possibly lead to confusion as to whether they are several. If we can avoid that, it would be a better version
Author, Please include your email address upfront in the document for public feedback.
regards Rahul Sundaram
__________________________________ Do you Yahoo!? Take Yahoo! Mail with you! Get it on your mobile phone. http://mobile.yahoo.com/maildemo
On Tue, 2004-10-26 at 18:10, Rahul Sundaram wrote:
No slashes please -- try: "Insert the first disc into the CD or DVD drive." (Notice that "disc" is generic.)
Well. I just noticed that there is just one DVD and this might possibly lead to confusion as to whether they are several. If we can avoid that, it would be a better version
I would hate saying "Insert the first CD or DVD into the CD or DVD drive," since it implies, even though we all know it won't work, that you could put a DVD into a CD drive. :-) We should probably take it as axiomatic that the first disc in a series of one is the disc itself and no other. Argh! I sense a metaphysical argument coming on... must... resist... temptation...!
On Tue, 26 Oct 2004 13:25:41 -0700 (PDT), "Rahul Sundaram" rahulsundaram@yahoo.co.in said:
You should probably add the instructions to download and burn a ISO or link to appropriate documentation.Many users are unsure of which ISO's are needed.
I'll write in a clarification of exactly which discs are needed to carry out an installation. I'm not sure that people will look at the Installation Guide until after they have the distribution, so step-by-step instructions might be better as a separate document that download sites can link to.
" Fedora Core does not support installation with diskettes."
I suppose you mean floppy disks here. Make sure the language is more explicit throughout the guide
Yes. "Discs" for CD and DVD, "diskettes" for floppy disks, because "discs" and "disks" would be bad. I think that I got this from GNOME. "CD 1" for the first disc in the set, from Red Hat docs. In 0.3 the term "discs" is now used consistently, and the phrase "the first disc" suggested by Paul is used instead of "CD 1".
Non native speakers would probably appreciate a more basic form. replace commences with starts and elements with parts of something similar. This applies for the whole documentation
This is a very good point. I've amended these to say "starts" and "components", and will go through the text to try to remove any words that may not translate well. This is hard for me to judge as a native English speaker, so please let me know if you see any more problems like this in later versions.
SELinux is likely to be transparent to the end users but administrators who are new to the concept would certainly want to learn better about it and it is NOT transparent to them in all occasions.
I agree. My concern is that putting links in the main text may overemphasise their importance, and give the impression that the user must go away and read these docs before they can carry out an installation. So I'm going to draft some kind of "Further Reading" section to see what could be done, but I haven't worked out the details yet. It may work better in another format than the Installation Guide.
"You can also launch the system administration tools included in Fedora Core from any user account using the root password."
I've revised the text of the section - hopefully the new version is better.
Make sure you mention that the configuration stuff that is setup using the "setup agent" is OPTIONAL. This is one of the reasons why firstboot has been split up from anaconda
I used the phrase "enables you to configure" because you are right that the user can just click "Next" and do nothing else. I don't think that they can avoid going through these screens if they selected a graphical system.
I request you put up screenshots wherever applicable atleast temporarily. It would help me associate the content with the appropriate screens better.(just for review purposes)
Unfortunately, it would probably take me as long to prepare a complete set of bad screenshots as for somebody else with more experience to make the good set. -- Stuart Ellis s.ellis@fastmail.co.uk
On Thu, 2004-10-28 at 00:59 +0100, Stuart Ellis wrote:
On Tue, 26 Oct 2004 13:25:41 -0700 (PDT), "Rahul Sundaram" rahulsundaram@yahoo.co.in said:
I request you put up screenshots wherever applicable atleast temporarily. It would help me associate the content with the appropriate screens better.(just for review purposes)
Unfortunately, it would probably take me as long to prepare a complete set of bad screenshots as for somebody else with more experience to make the good set.
I'll get either myself or one of the installer team to do this for next week sometime. It is fairly straightforward with kickstart and:
autostep --autoscreenshot
Paul
On Fri, 2004-10-29 at 10:32 +0100, Paul Nasrat wrote:
Unfortunately, it would probably take me as long to prepare a complete set of bad screenshots as for somebody else with more experience to make the good set.
I'll get either myself or one of the installer team to do this for next week sometime. It is fairly straightforward with kickstart and:
autostep --autoscreenshot
Didn't do it that way, but I've got lots of screenshots that I took for the book, that would be usable I'm sure:
http://www.bytebot.net/universe/fedora/installation/
Happy usage. First screen needs to be fixed, which I'll presume will be fixed soon. I'll rsync the changes once that happens... sorry about the further subdirectories, because those take things in a little deeper (so am guessing, its better than --autoscreenshot :P)
On Sat, 30 Oct 2004 17:32:29 +1000, "Colin Charles" byte@aeon.com.my said:
On Fri, 2004-10-29 at 10:32 +0100, Paul Nasrat wrote:
Unfortunately, it would probably take me as long to prepare a complete set of bad screenshots as for somebody else with more experience to make the good set.
I'll get either myself or one of the installer team to do this for next week sometime. It is fairly straightforward with kickstart and:
autostep --autoscreenshot
Didn't do it that way, but I've got lots of screenshots that I took for the book, that would be usable I'm sure:
http://www.bytebot.net/universe/fedora/installation/
Happy usage.
Thanks to you both for the offers. The structure is complete enough for screenshots to be dropped in whenever. I'm working on a couple of bits this weekend and will probably do another build after FC3 comes out.
-- Stuart Ellis s.ellis@fastmail.co.uk
Hi
You should probably add the instructions to download and burn a ISO or link to appropriate documentation.Many users are unsure of which ISO's are needed. Specifically make sure you explain to them that the images containing srpms are NOT required and how many images and required for the basic installation. It would very useful to include instructions for burning a image from Windows also
http://linuxiso.org/viewdoc.php/isofaq.html
The above seems to fit the needs well.
" Fedora Core does not support installation with diskettes."
I suppose you mean floppy disks here. Make sure the language is more explicit throughout the guide
"No changes are made to your computer until package installation commences."
" The Fedora installation system has three elements"
Non native speakers would probably appreciate a more basic form. replace commences with starts and elements with parts of something similar. This applies for the whole documentation
"Insert CD 1 into the CD or DVD drive."
The user has an option to download and use the DVD so it should be something like "Insert the first CD/DVD into the CD/DVD drive"
SELinux is likely to be transparent to the end users but administrators who are new to the concept would certainly want to learn better about it and it is NOT transparent to them in all occasions. This is one of the reasons why I wanted you to link to the selinux faq
http://fedora.redhat.com/docs/selinux-faq-fc2/ http://fedora.redhat.com/docs/selinux-faq-fc3test2/
"You can also launch the system administration tools included in Fedora Core from any user account using the root password."
This would be a more precise version. "It is recommended that you use user system as a normal(non root)user. Any system administration tools in the graphical user interface would prompt for a root password if its required"
Make sure you mention that the configuration stuff that is setup using the "setup agent" is OPTIONAL. This is one of the reasons why firstboot has been split up from anaconda
"If you have to reconfigure the sound card later, you can use the system-config-soundcard utility. This is the menu item System Settings->Soundcard Detection."
make sure you mention the menu item first and follow it by command line equivalents wherever appropriate. we should be targetting end users who are comfortable using the GUI better
I request you put up screenshots wherever applicable atleast temporarily. It would help me associate the content with the appropriate screens better.(just for review purposes)
regards Rahul Sundaram
__________________________________ Do you Yahoo!? Yahoo! Mail - You care about security. So do we. http://promotions.yahoo.com/new_mail
-
Colin Charles -
Paul Nasrat -
Paul W. Frields -
Rahul Sundaram -
Stuart Ellis