Documentation needed! (about the left side menu)

[Joe Marcus Clarke]

On Tue, 2003-04-08 at 18:03, Mezz bsdforums.org wrote:
> >Calling all documentation volunteers!  I committed the new bsd.gnome.mk
> >last night, and I'd like to get the documentation online as soon as
> >possible.  This way, porters can start using the new infrastructure.  So
> >far, Mezz, Adam, and Piero have volunteered.  Please let me know if you
> >need any help with the content.  I'll rely on your creative juices for
> >the wording and layout.  The format must be consistent with the FreeBSD
> >CSS style, and diffs should be submitted against the SGML code in
> >www/en/gnome.  Thanks.
> 
> I took the look at SGML and it's ok (I dislike SGML ;-)). It's limit when 
> use FreeBSD.org's header and stuff. So, looks like add a simple light grey 
> table with blockquote should look ok and good without any of fancy table 
> with shadow.
> 
> So... What are you (guys/gals) want to work on? Try to avoid work on the 
> same things.
> 
> Current, I am thinking about work on the left side menu. Need to turn 
> sentence into a simple words and smaller. Like this:
> 
> Change from...
> =======================
> GNOME on FreeBSD
> · GNOME on FreeBSD Home
> · Installation Instructions for GNOME 1.4
> · Installation Instructions for GNOME 2.2
> · Available Applications
> · How to Help
> · Reporting a Bug
> · Screenshots
> · Contact Us
> 
> Documentation
> · GNOME 1.4 FAQ
> · GNOME 2.2 FAQ
> · Creating Ports
> · Known Issues with GNOME 2.2 on FreeBSD
> 
> Resources
> · GNOME Project
> · GNOME Office
> · GNOME on GNU/Darwin
> 
> Related Projects
> · KDE Project
> · KDE on FreeBSD
> · CDE (commercial)
> =======================
> 
> to...
> =======================
> GNOME on FreeBSD
> · GNOME on FreeBSD Home
> · Available Applications
> · How to Help
> · Reporting a Bug
> · Screenshots
> · Contact Us
> 
> Gnome 1.4 Documentation [1]
> · Handbook [2]
> · Installtion [3]
> · Creating Ports [4]
> · FAQ
> · Known Issues [5]
> 
> Gnome 2.2 Documentation [1]
> · Handbook [2]
> · Installtion [3]
> · Creating Ports [4]
> · FAQ
> · Known Issues [5]
> 
> Resources
> · GNOME Project
> · GNOME Office
> · GNOME on GNU/Darwin
> 
> Related Projects
> · KDE Project
> · KDE on FreeBSD
> · CDE (commercial)
> =======================

Yes!  This looks great.

> 
> -[1] I think, they need to be seperate to make easier to surf and read.

I agree.

> 
> -[2] How about create a 'small version' handbook of Gnome 1.x and 2.x on 
> FreeBSD? I think, the FAQ need to split and FAQ should be for known stuff, 
> quick/short and etc (feel free to correct me).

One of the items for the project todo (that I signed up for a long time
ago, but never did) was to convert the FAQ to Docbook.  If you want to
pick up the cause, you won't hear any objections from me.

> 
> Which, meaning some of us can write more stuff. Short of walk-throught like 
> FreeBSD's offical handbook. Maybe, later if it can merges in the offical 
> handbook. Perhaps, some better word(s) instead use 'Handbook' to avoid the 
> confuse?

I think keeping it separate is the way to go.  Having a link to it the
handbook is probably good enough.

> 
> -[3] I think, it should be under the 'Documentation' area. :-) This link 
> points to the 'short version' handbook of Gnome 1.x and 2.x on FreeBSD.

Okay.

> 
> -[4] Not sure how it should work. Point to FAQ or 'small version' handbook? 
> methink should be in the 'small version' handbook.

This should be a separate guide much like the porter's handbook is now.

> 
> -[5] If there's none, remove it.

Or "gray" it out.

> 
> Should we add two more links to point at Gnome's 1.x and 2.x doc website? 
> Like, add under 'Known Issue' or 'Resources'.

Sounds like a good idea.

> 
> Any feedback on this? What's your thought?
> 
> Hey Joe, can you add in something like freebsd.org/gnome/test/ or else? So, 
> we can send the diff to you, then you upload stuff there while it will have 
> some broke links and etc.

I have the whole site mirrored at http://www.marcuscom.com/gnome.  Send
me diffs, and I'll post them there.  Not to be an ass, but we need
something for the new infrastructure pretty soon so we can let other
porters know what's up.  Thanks!

Joe

> 
> Cheers,
> Mezz
> 
> >Joe
> >
> >--
> >Joe Marcus Clarke
> >FreeBSD GNOME Team	::	marcus at FreeBSD.org
> >http://www.FreeBSD.org/gnome
> 
> _________________________________________________________________
> MSN 8 with e-mail virus protection service: 2 months FREE*  
> http://join.msn.com/?page=features/virus
> 
> _______________________________________________
> freebsd-gnome at freebsd.org mailing list
> http://lists.freebsd.org/mailman/listinfo/freebsd-gnome
> To unsubscribe, send any mail to "freebsd-gnome-unsubscribe at freebsd.org"
-- 
PGP Key : http://www.marcuscom.com/pgp.asc
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: This is a digitally signed message part
Url : http://lists.freebsd.org/pipermail/freebsd-gnome/attachments/20030408/5b97d8f5/attachment.bin