Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 122289 - [Tracker] 2006.0 Handbook Updates/Status
Summary: [Tracker] 2006.0 Handbook Updates/Status
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs on www.gentoo.org
Classification: Unclassified
Component: Installation Handbook (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Shyam Mani (RETIRED)
URL:
Whiteboard:
Keywords: Tracker
Depends on: 111652 122406 122806
Blocks:
  Show dependency tree
 
Reported: 2006-02-09 11:32 UTC by Shyam Mani (RETIRED)
Modified: 2006-02-26 16:58 UTC (History)
3 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
Handbook patch (handbook.diff,24.98 KB, patch)
2006-02-10 06:44 UTC, Chris Gianelloni (RETIRED)
Details | Diff
hb-install-x86-network.xml (hb-install-x86-network.xml,21.03 KB, application/xml)
2006-02-10 07:58 UTC, Chris Gianelloni (RETIRED)
Details
Handbook patch #2 (handbook.diff,5.50 KB, patch)
2006-02-10 11:14 UTC, Chris Gianelloni (RETIRED)
Details | Diff
Handbook patch #3 (handbook.diff,11.82 KB, patch)
2006-02-13 07:30 UTC, Chris Gianelloni (RETIRED)
Details | Diff
Small changes (hb-install-gtkfe.minor.patch,6.27 KB, patch)
2006-02-14 20:41 UTC, Arun Raghavan (RETIRED)
Details | Diff
handbook-x86.xml.patch (handbook-x86.xml.patch,4.50 KB, patch)
2006-02-15 13:17 UTC, nm (RETIRED)
Details | Diff
hb-install-gtkfe.xml.patch (hb-install-gtkfe.xml.patch,5.58 KB, patch)
2006-02-15 13:35 UTC, nm (RETIRED)
Details | Diff
hb-install-gli-dialog.xml.patch (hb-install-gli-dialog.xml.patch,2.03 KB, patch)
2006-02-15 13:42 UTC, nm (RETIRED)
Details | Diff
hb-install-gtkfe-nonoriginal-content.xml.txt (hb-install-gtkfe-nonoriginal-content.xml.txt,2.14 KB, text/plain)
2006-02-16 09:14 UTC, nm (RETIRED)
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Shyam Mani (RETIRED) gentoo-dev 2006-02-09 11:32:19 UTC
Primarily x86 Handbook stuff plus final tracking of all arch handbooks for 2006.0
Comment 1 Shyam Mani (RETIRED) gentoo-dev 2006-02-09 11:58:42 UTC
***ARCH - x86 ONLY***

Changes:

Both Universal and Package CDs are scrapped. Minimal Install CD remains with the same functionality.

Replacing the Universal + Package CD combo, we have the Gentoo Linux Installer LiveCD which will have options to as follows:

a) Good Old way - Install Stage 1/2/3 (we don't bother about 1/2 in the handbook and this is the old method of install). Here's the catch though - The Stage 3 tarball does NOT come with the CD. If you want to do a Stage 3 you can pick it off the Internet.

Available "Stage 3" options for x86 are :

1) stage3-x86-2006.0.tar.bz2: built against the default-linux/x86/no-nptl profile.

2) stage3-i586-2006.0.tar.bz2: built against the default-linux/x86/2006.0 profile. 

3) stage3-i686-2006.0.tar.bz2: built against the default-linux/x86/2006.0 profile. This stage3 tarball is what Release Engineering considers the "default" stage3 tarball, as it will be what most users will want. Should be used on any i686-compatible or better machine, which includes athlon, athlon-xp, athlon-mp, pentium-pro, pentium2, pentium3, pentium4, and pentium-m.

b) Graphical Installer

c) Console Installer

d) GRP - If someone wants to do a GRP install, the LiveCD automagically, on-the-fly builds a Stage 3. This is a method where the stage3 tarball is built dynamically from the packages actually installed on the LiveCD itself. This method is required to perform a GRP installation. This method will use the  equivalent of the stage3-i686-2006.0.tar.bz2 tarball. Only after selecting this method can a user opt to perform a GRP install. The GRP install works similarly to the dynamic stage3 installation method as it also builds the packages from the CD itself.

*phew*
Comment 2 Chris Gianelloni (RETIRED) gentoo-dev 2006-02-09 12:36:18 UTC
You forgot to mention that the dynamic stage3 is only available from within the installer itself... the CD doesn't generate it, the installer does (either gtk+ or ncurses)...

One other thing that might be worth mentioning is the executables.  There are icons for both executables for the Installer on the default desktop, but users using "nox" or users with a video setup that isn't detected (or people using ssh) can run "installer" from the command line (or installer-dialog) to get the console-based installer.  Running "installer" when in X (or installer-gtk) will run the gtk+ installer.
Comment 3 Chris Gianelloni (RETIRED) gentoo-dev 2006-02-10 06:44:54 UTC
Created attachment 79431 [details, diff]
Handbook patch

This is my first patch that only affects the first two chapters... I am currently working on the networking section...
Comment 4 Chris Gianelloni (RETIRED) gentoo-dev 2006-02-10 07:58:06 UTC
Created attachment 79437 [details]
hb-install-x86-network.xml

This is a new file.  It has some minor changes for the LiveCD.
Comment 5 Shyam Mani (RETIRED) gentoo-dev 2006-02-10 09:49:00 UTC
Comment on attachment 79431 [details, diff]
Handbook patch

Patch added to draft
Comment 6 Shyam Mani (RETIRED) gentoo-dev 2006-02-10 09:50:08 UTC
Comment on attachment 79437 [details]
hb-install-x86-network.xml

File added to draft
Comment 7 Chris Gianelloni (RETIRED) gentoo-dev 2006-02-10 11:14:04 UTC
Created attachment 79449 [details, diff]
Handbook patch #2

With this patch, we can remove hb-install-x86-about.xml and hb-install-x86-network.xml, removing any arch-specific files that we had previously added for x86.
Comment 8 Gustavo Zacarias (RETIRED) gentoo-dev 2006-02-10 11:39:00 UTC
***ARCH - sparc ONLY***

Change:
s/gentoo-2.4/gentoo/ -> Kernel name changed for the CD.

Add in chapter 2.a (Hardware Requirements):
Please check the Gentoo Linux/SPARC64 compatibility list or Ultralinux FAQ.
Gentoo Linux/SPARC64 compatibility list = http://www.gentoo.org/proj/en/base/sparc/sunhw.xml
Ultralinux FAQ link remains the same.

***Every ARCH***
In section 9.d Filesystem tools, wouldn't it be good to highlight/note that not all filesystems are available on all ARCHs?

Comment 9 Shyam Mani (RETIRED) gentoo-dev 2006-02-10 12:23:57 UTC
Comment on attachment 79449 [details, diff]
Handbook patch #2

Fixed in CVS
Comment 10 Shyam Mani (RETIRED) gentoo-dev 2006-02-10 12:37:12 UTC
(In reply to comment #8)

> ***ARCH - sparc ONLY***
> 
> Change:
> s/gentoo-2.4/gentoo/ -> Kernel name changed for the CD.
> 
> Add in chapter 2.a (Hardware Requirements):
> Please check the Gentoo Linux/SPARC64 compatibility list or Ultralinux FAQ.
> Gentoo Linux/SPARC64 compatibility list =
> http://www.gentoo.org/proj/en/base/sparc/sunhw.xml
> Ultralinux FAQ link remains the same.

Fixed in CVS, thanks!
Comment 11 Chris Gianelloni (RETIRED) gentoo-dev 2006-02-13 07:30:10 UTC
Created attachment 79698 [details, diff]
Handbook patch #3

Unfortunately, I have not quite had the time that I would have desired to look into this.  I will try to get as much of this done as possible, but any assistance would be appreciated.  ;]
Comment 12 nm (RETIRED) gentoo-dev 2006-02-13 07:52:04 UTC
MIPS stuff is done per bug #111652. I asked Redhatter if he foresaw any further changes to the handbooks, and he said no; they're in their final state for the release.

Also, I've been doing a lot of preliminary work on the GTKfe x86 handbook; see my devspace for its progress (below). Keep in mind these are just my ideas; I'm doing one page per page of the installer (basically grouped in the same way as the updated screenshots on /proj/en/releng/installer/screenshots).

Of course, the individual chapters are short enough that they could all conceivably fit on one page, guide-style. For the time being, I've gone ahead and started writing them in the separate handbook/chapter style (though they're all on one page for simplicity's sake atm).

See http://dev.gentoo.oorg/~nightmorph/draft/handbook-gtkfe-x86.xml . The corresponding docs will be up in my /draft/ before too long, or at least stubs. Read handbook-gtkfe-draft.xml.txt to see my ideas and some progress so far. (I didn't want to commit this straight to draft/2006.0).

**Remember, this is just _one_idea_ on how to proceed with the handbooks.**

Critiques, additions, comments, better ideas, etc. welcomed.
Comment 13 nm (RETIRED) gentoo-dev 2006-02-13 16:37:24 UTC
(In reply to comment #12)
Okay, the first rough draft of the completely revised networkless x86 handbook is up on my devspace: dev.gentoo.org/~nightmorph/draft/hb-install-gtkfe.xml

Note that things still need fleshing out, but I found it quicker to write this from scratch than go back through the 2005.1 handbook trying to cut out/piece together large chunks. I did reuse some existing explanations, and made use of some great inclusions from wolf31o2's patches. Also, agaffney spent quite a bit of time fielding questions on the operation of the installer. Thanks to everyone so far for feedback.

Please comment/flame/**improve** as necessary. I wrote this in chapter format, but the guidexml can easily be switched to the full handbook format if need be. It was just quicker to do it as an add-on chapter. Choose whichever works best, and it can be redone. :)
Comment 14 nm (RETIRED) gentoo-dev 2006-02-14 17:02:03 UTC
(In reply to comment #13)
I now have a full draft of the gli-dialog installer available on my dev space. gli-dialog replaces dialogfe, just so you know:

http://dev.gentoo.org/~nightmorph/

The draft of the gtkfe installer has also been updated.

Furthermore, I created a patch for the Alpha docs as requested and approved by kloeri; they now block this bug. We want another set of eyes to review the change before committing, though. :). These changes can also be applied to the *networked* Alpha handbook.

RFC on everything so far, thanks.

It's coming together; let's keep at it. :)
Comment 15 Arun Raghavan (RETIRED) gentoo-dev 2006-02-14 20:41:45 UTC
Created attachment 79818 [details, diff]
Small changes

Looks good so far, though eventually there will have to be more details. Including some minor changes in phrasing, capitalisation, and spelling.
Comment 16 Shyam Mani (RETIRED) gentoo-dev 2006-02-14 21:49:20 UTC
(In reply to comment #12)

> Also, I've been doing a lot of preliminary work on the GTKfe x86 handbook; see
> my devspace for its progress (below). Keep in mind these are just my ideas; 

Ideally, let's think about this one post 2006.0. Right now, I think the best way is to get in hb-install-gtkfe in the handbook.
Comment 17 nm (RETIRED) gentoo-dev 2006-02-15 05:26:25 UTC
(In reply to comment #15)
> Created an attachment (id=79818) [edit]
> Small changes
> 
> Looks good so far, though eventually there will have to be more details.
> Including some minor changes in phrasing, capitalisation, and spelling.
> 

Most of your suggestions/fixes were good, though it appears you used an older version than what I had been working on. :)

Fixes selectively applied, and much thanks for the help. :)
Comment 18 Shyam Mani (RETIRED) gentoo-dev 2006-02-15 11:46:47 UTC
***ARCH x86 ONLY***

The changes affect only x86 for now. Two new files added -

hb-install-gtkfe.xml - For the GTK+ based Installer instructions.
hb-install-gli-dialog.xml - For the Dialog based Installer instructions.
Comment 19 Shyam Mani (RETIRED) gentoo-dev 2006-02-15 11:48:21 UTC
Comment on attachment 79818 [details, diff]
Small changes

Thanks, nightmorph pushed in a modded version of these.
Comment 20 nm (RETIRED) gentoo-dev 2006-02-15 13:17:35 UTC
Created attachment 79869 [details, diff]
handbook-x86.xml.patch

Patch for handbook-x86.xml. Specifically, the authors/editors/contributors section.

This may rankle some, but it needs to be done. Removed everyone who did not have a hand in making this new handbook (the old author list is for handbooks of days of yore). Added in all contributors, editors, and authors to this point. Shyam gets the nod as handbook lead. :) If I've forgotten anyone let me know, and of course he/she/they can be added. :)
Comment 21 nm (RETIRED) gentoo-dev 2006-02-15 13:35:13 UTC
Created attachment 79872 [details, diff]
hb-install-gtkfe.xml.patch

Minor code and subsection consistency for hb-install-gtkfe.xml. <c> is used because each option is a configuration choice, just like we would use <c> if these had been program commands to type and execute. :)
Comment 22 nm (RETIRED) gentoo-dev 2006-02-15 13:42:38 UTC
Created attachment 79873 [details, diff]
hb-install-gli-dialog.xml.patch

Some tiny code consistency fixes to hb-install-gli-dialog.xml.

Also, I removed the section about "Enable bootsplash", because this option is not present in the installer; it takes care of that for you.
Comment 23 Shyam Mani (RETIRED) gentoo-dev 2006-02-15 17:32:41 UTC
(In reply to comment #20)

> This may rankle some, but it needs to be done. Removed everyone who did not
> have a hand in making this new handbook (the old author list is for handbooks
> of days of yore). Added in all contributors, editors, and authors to this
> point. Shyam gets the nod as handbook lead. :) If I've forgotten anyone let me
> know, and of course he/she/they can be added. :)

Maybe they didn't do much here...but remember that we're still using large portions of the earlier handbook. 2 chapters from part 1 and all of part 2, 3 and 4. I'm not really thiinking about putting this patch in.
 
Comment 24 nm (RETIRED) gentoo-dev 2006-02-16 09:14:03 UTC
Created attachment 79946 [details]
hb-install-gtkfe-nonoriginal-content.xml.txt

hb-install-gtkfe-nonoriginal-content.xml.txt:
This document shows exactly what content I pulled in from existing, written sources. Not to be an @$$, but the fact of the matter is that not very many people have contributed to these docs. I cited the sources used. The fact remains that nearly all of these handbooks are entirely original; I wrote them from scratch and *then* turned to some outside resources. hb-install-gli-dialog has even fewer outside additions simply because it is so unique; read the comments in the file for more info.

fox2mike, I can understand if you want to leave all those names in for tradition's sake. but, as we've retired the old handbooks, it's also time to retire the people listed in them unless they've been involved in creating these handbooks. I do think that whoever wrote the stuff on block devices and grub kernel parameter lines in the old x86 hb should get credit; a little of that has made it into the current doc.

But give credit where credit is due. Whoever hasn't written, edited, contributed to, or reviewed these works, deserves none.
Comment 25 nm (RETIRED) gentoo-dev 2006-02-16 09:29:10 UTC
(In reply to comment #24)
Erm, I sorta forgot that all those folks were listed because of the rest of the handbook that we're *keeping*, like Portage, networking, working w/Gentoo... yeah, I'd forgotten about that. Apologies. I'll think more once I'm less sick.
Comment 26 nm (RETIRED) gentoo-dev 2006-02-16 10:05:42 UTC
Comment on attachment 79946 [details]
hb-install-gtkfe-nonoriginal-content.xml.txt

This file might be useful in the future, but not as much right now. Erm, moving on . . .
Comment 27 nm (RETIRED) gentoo-dev 2006-02-17 12:14:07 UTC
Comment on attachment 79873 [details, diff]
hb-install-gli-dialog.xml.patch

In CVS, with some good attention to correct detail by fox2mike.
Comment 28 nm (RETIRED) gentoo-dev 2006-02-17 12:27:30 UTC
Comment on attachment 79869 [details, diff]
handbook-x86.xml.patch

As per some earlier comments, this doesn't seem to be necessary anymore, given that the hb-install* docs != entire handbook.
Comment 29 nm (RETIRED) gentoo-dev 2006-02-17 12:30:08 UTC
Comment on attachment 79872 [details, diff]
hb-install-gtkfe.xml.patch

Some of these guidexml consistency fixes are already in cvs. a new patch would be needed for the rest.
Comment 30 Shyam Mani (RETIRED) gentoo-dev 2006-02-22 09:55:20 UTC
Just an addendum --

Networkless stuff is complete and the tarballs are up at [1]
PDFs are complete for the same and are up at [2]

[1] http://dev.gentoo.org/~fox2mike/doc/en/releng/2006.0/
[2] http://dev.gentoo.org/~plasmaroo/stuff/2006.0/
Comment 31 Shyam Mani (RETIRED) gentoo-dev 2006-02-26 16:58:44 UTC
Done. 2006.0 is out, handbook(s) are in CVS. Thanks guys!