Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 114897 - Make documentation listing more obvious
Summary: Make documentation listing more obvious
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Other (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Xavier Neys (RETIRED)
URL: http://forums.gentoo.org/viewtopic-p-...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-12-08 11:11 UTC by Daniel Drake (RETIRED)
Modified: 2005-12-16 05:58 UTC (History)
1 user (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 Daniel Drake (RETIRED) gentoo-dev 2005-12-08 11:11:45 UTC
I've seen a fair few users asking why Gentoo does not have a page listing all of
the available documentation, when infact, we do, and it's quite easy to find,
but apparently people don't see it.

I asked on the forums for suggestions how to improve this situation and "tgh"
provided some insight:

==================================================================
On the [doc/en/]index.xml page, "2. Gentoo Linux Documentation" maybe should be
changed to "2. Gentoo Linux Documentation Categories". There's also a link in
the last paragraph in section 1 that simply takes you back to the same page
(which I find confusing, look for the link on the word "categorized").

In the left-hand menu, I suggest an entry under "Main Index" that links directly
to the document listing (list.xml) in addition to the "Main Index" link that
points at index.xml. Maybe call the "Main Index" -> "Home" and have a new entry
called "Index" pointing at list.xml. 
==================================================================

I agree with this feedback and it would be great to see it put into place,
hopefully it would help the users find the documentation. One addition from me:
the "categorized" link definately should go, and instead, we should add a note
saying "The documentation categories are listed below" just to be crystal clear
on what we are talking about.
Comment 1 Xavier Neys (RETIRED) gentoo-dev 2005-12-09 04:44:59 UTC
Partially fixed:
 .Links in left menu of main pages changed as suggested.
 .Chapter title on index.xml changed to ...Categories

FYI, the "confusing" link must stay because it's the only way to get back to the
list of categories from an open category page.
For instance, try to go back to the category list from
http://www.gentoo.org/doc/fr/index.xml?catid=gentoodev

Feel free to suggest a way to rephrase it in a less confusing way. FYI, that
text is static and will be displayed whether a category has been selected or not.
Comment 2 Daniel Drake (RETIRED) gentoo-dev 2005-12-10 05:55:28 UTC
Can it be made non-static? i.e. two different pieces of text, one which appears
on the category list page, and one which appears on the pages for every category?
Comment 3 Xavier Neys (RETIRED) gentoo-dev 2005-12-12 03:42:01 UTC
(In reply to comment #2)
> Can it be made non-static? i.e. two different pieces of text, one which appears
> on the category list page, and one which appears on the pages for every category?

Not without changing structure and code.
Comment 4 Curtis Napier (RETIRED) gentoo-dev 2005-12-12 05:48:05 UTC
Having the list.xml page listed on the front page is done in the re-design. It's
right up at the top and very prominent. The content that xavier fixed is within
the xml content pages and will carry over to the redesign automatically.
Comment 5 Daniel Drake (RETIRED) gentoo-dev 2005-12-16 05:58:03 UTC
Ok, closing this for now. I'll try and monitor the effect of the changes which
have been made. Thanks.