helping organize x.org documentation

Tiago Vignatti vignatti at freedesktop.org
Thu May 27 16:55:19 PDT 2010


Matt,

On 05/26/2010 04:12 PM, Matt Dew wrote:
> Ok here's a summary of current changes:
>
> 1) I used kernelnewbies.org as the template, so this page doesn't look
> like the xorg wiki.  (probably least important diff),

I guess you can remove "XOrg" from the top and let only the logo there.

Another issue to worry about is regarding the wiki engine. Is MoinMoin 
good enough for us? I'm totally dumb regarding these technologies but we 
should choose one easily to upgrade, maintain, customize, etc.


> 2) Architectural overview  -There was a detailed drawing over on the
> ubuntu forums a while back. The front page has a link to that.  While
> it seems overly complicated, it's nice to have a diagram that shows
> all the parts.

This is nice indeed. But we have to go carefully here because I see some 
out dated info there for instance. Should be nice to get the source of 
this diagram so we could upgrade accordingly the current architecture.


> 3)  Front page now contains links to GSoC and EVoC.

(see below)


> 4) Front page now contains a link to more contact info than just the
> IRC and mailing list.  Also has a link to the maintainers file so
> people can quickly find out who's in charge of what so they can direct
> questions.

(see below)


> 5)  More links for development stuff:  How to Download, How to Build,
> Bug Reporting,  Submitting Patches, ...

As I already said this for you, for some reason I'm adept of simplistic 
interface. I think an attractive page is a simple page. I don't like to 
spend more than one minute reading a page before click in something that 
I'm really interested, searching for.

For instance, I come to Mozilla wiki page just to download and use it, 
I'm not interested at all what in hell is Tinderbox. It just pollutes 
what I'm looking for.

Therefore I'd prefer to shrink a lot the options the left tab, where 
each option would expand those suboptions there. For instance, instead 
have GSOC and EVoC, you could put both inside one single link like 
"Studying at X.Org" maybe.

But you and other guys may have different options though.


> 6) A components page that has more information on the modules,
> drivers, protocols.   There are links to more detailed information on
> the protocols as well as drivers and modules.  I'm trying to round up
> detailed info on all pieces and how they fit together as well as their
> function in the overall design.

when you click in "components" on the left tab, then it disappears the 
same link there after opening it in the main tab. Is it a bug?


> 7) Links to external dependencies like mesa, xkeyboard-config and XCB.

again: inside one single link.


> 8) Link to tinderbox.

nice.


> I'm trying to collect existing information and put it in one place in
> a consistent manner so things are easy to find.    Right now I'm
> focused on rounding up links to the development documentation.
> However, I don't plan to stop there. The goal is to have documentation
> for development, use/configuration, demos/presentations, ...
>
> Please give me feedback, links, requests, suggestions, etc.
> thanks,

indeed! :) Let's wait a bit other guys suggestions to see if they come 
with more ideas.


Thank you,

		Tiago


More information about the xorg-devel mailing list