Re: testing documentation

[Joachim Noreiko <jnoreiko yahoo com>]

--- karderio <karderio gmail com> wrote:

> Hi :o)
> 
> On Mon, 2006-07-24 at 11:50 -0700, Ryan Paul wrote:
> > I actually didn't bother to check the
> documentation on either of those
> > features. I just looked at the Yelp doc, and it
> doesn't look like the
> > dragging thing is documented. The command line
> stuff and ctrl+r are both
> > documented.
> 
> I have submitted a patch to add this to the Yelp
> documentation.
> 
> http://bugzilla.gnome.org/show_bug.cgi?id=349011
> 
> 
> > On Mon, 2006-07-24 at 17:41 +0100, Joachim Noreiko
> wrote:
> > > --- Don Scorgie <DonScorgie Blueyonder co uk>
> wrote:
> > > 
> > > > Basically:
> > > > <ctrl>-r will refresh the document.
> > > 
> > > 
> > > I think this (and dragging documents to Yelp) is
> > > documented on the wiki... though perhaps not in
> a
> > > place that is easy to find.
> > > 
> > > Did you have a look, Ryan, and if so, where? 
> > > We can move the information there or add a link
> to it.
> 
> As far as I can see, "<ctrl>-r" and only this is
> mentioned in
> SubmittingDocumentation [1] on the wiki.
> 
> I have added a resume of previewing docs in Yelp to
> FirstPatch [2].
> 
> I think the SubmittingDocumentation and FirstPatch
> pages should be
> merged, what do you all think ?
> 

FirstPatch is somewhat too big and scary (sorry Don, I
know you put a lot of work into it :(
It makes a few assumptions that go too far, such as
getting yourself a *whole* gnome system out of CVS and
building it. eeek! I'd advise doc writers to check out
only one module, and probably only the /help folder.

There are pages on the wiki that cover CVS checkout
and making patches from a general perspective, so I'd
move some of the FirstPatch material there.

Other sections of FirstPatch are specific to the docs
team, but I wouldn't want to weigh down
SubmittingDocumentation with technical stuff about
validating xml -- that'll have potential contributors
running for the hills.

So... I think we should clean up FirstPatch a bit, but
keep it separate as a more advanced guide to working
on docs (maybe rename it too)

Joachim



	
	
		
___________________________________________________________ 
Win tickets to the 2006 FIFA World Cup Germany with Yahoo! Messenger. http://advision.webevents.yahoo.com/fifaworldcup_uk/