Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 109113 - [RFC] clearer separation of networkless and network-based Handbooks
Summary: [RFC] clearer separation of networkless and network-based Handbooks
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Handbook (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Docs Team
URL:
Whiteboard:
Keywords:
: 131468 (view as bug list)
Depends on:
Blocks:
 
Reported: 2005-10-13 04:04 UTC by Jan Kundrát (RETIRED)
Modified: 2006-04-27 08:54 UTC (History)
2 users (show)

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


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jan Kundrát (RETIRED) gentoo-dev 2005-10-13 04:04:26 UTC
Hi gang,  
recently I've heard from some Czech users that they feel quite lost when they  
see networkless and network-based Handbooks. It seems that their separation is 
still not visible enough. They've also said that they haven't submitted bugs 
because they have been told that "Gentoo docs are the best". 
 
So, here's a list of the changes I propose: 
 
a) Move network-based handbook to /doc/en/handbook/networked/ (maybe suggest 
better name?), with proper redirects from old location for some time, of 
course. /doc/en/handbook/networked/index.xml will look similar like 
current /doc/en/handbook/2005.1/index.xml, new /doc/en/handbook/index.xml will 
just point to proper versions of our handbooks and include general stuff like 
current one. 
 
b) Add words "network-based"/"networkless" to stuff like <abstract> in 
handbook-$arch.xml files 
 
Please don't just WONTFIX without proper talk :-) 
 
Comments, suggestions?
Comment 1 Xavier Neys (RETIRED) gentoo-dev 2005-10-13 04:20:48 UTC
a) no

b) sure, 2005.1/index.xml has it already

BTW, "Gentoo Linux 2005.1 <brite>without an internet connection</brite>" is
quite obvious.
Sorry, but <flash>without an internet connection</flash> is not supported.
Comment 2 Jan Kundrát (RETIRED) gentoo-dev 2005-10-13 04:29:05 UTC
(In reply to comment #1)  
> a) no  
  
Any reasons, apart from "I don't want to do that?" :-)  
  
> b) sure, 2005.1/index.xml has it already  
  
But neither handbook/2005.1/handbook-$arch.xml nor handbook/handbook-$arch.xml  
has...  
  
> BTW, "Gentoo Linux 2005.1 <brite>without an internet connection</brite>" is  
> quite obvious.  
  
Yeah, it is. But a lot of people still gets confused because they don't see  
this separation in HB content itself - I mean, what if they just get to 
http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=1&chap=10 from some 
link on a third-party site? 
Comment 3 Flammie Pirinen (RETIRED) gentoo-dev 2005-10-13 08:04:05 UTC
I see this confusion way too often in Finnish community too, and it isn't too
rare in Bugzilla nor forums neither. But I don't believe this can be fixed by
any amount of flashing lights and emphasized words anywhere. The problem is in
the separation itself, because it is quite unexpected, and always makes people
reading the docs doubtful, and after that the brite emphasized text is not
enough to clear the confusion. It's not very uncommon to hear newbies to ponder
over it "it does say without networking and I do have networking but it also
says 2005.1 and other one doesn't and install disc does and perhaps I still
should or..."

I think that single entry point page forcing people to make explicit choices
would be easiest way to make the distinction clear. Something like <uri
link="handbook/">I have networking during installation</uri>. <uri
link="handbook/20xy.z/>I don't have networking during installation</uri>. A bit
annoying gateway entrance solution, I know, but best I can come up with.
Comment 4 Xavier Neys (RETIRED) gentoo-dev 2005-10-13 08:11:18 UTC
(In reply to comment #2)
> > a) no  
> Any reasons, apart from "I don't want to do that?" :-)  
No, it will not happen. Get over it.

> > b) sure, 2005.1/index.xml has it already  
> But neither handbook/2005.1/handbook-$arch.xml nor handbook/handbook-$arch.xml  
> has...  
Which part of "sure" did you not understand?
Abstracts have been updated
Comment 5 Xavier Neys (RETIRED) gentoo-dev 2005-11-17 09:20:37 UTC
Abstracts have been updated. Directories will not be reshuffled, it's just not
worth it.
I'm not even convinced we still need separate handbooks, but that has to be
carefully considered.
Comment 6 Łukasz Damentko (RETIRED) gentoo-dev 2006-04-27 08:54:42 UTC
*** Bug 131468 has been marked as a duplicate of this bug. ***