Dev Doc Meta-documentation
Chris Davenport
The Dev Doc Team has, over a period of time, accumulated a number of
useful documents/pages that are important to us but not immediately
relevant to visitors. I'm referring primarily to the stuff here:
http://help.joomla.org/content/category/37/150/106/
One of the items has been copied to the wiki here:
http://dev.joomla.org/index.php?option=com_jd-wiki&Itemid=31&id=reference
s:developer.documentation.workflow
However, given that they cannot stay on help.joomla.org, I would argue
that the wiki is not the right place for this material either. I think
that all such meta-docs should be moved to the dev site as Joomla!
content and kept out of the wiki where their presence will confuse and
distract from the real content! Perhaps a "Doc Team Resources" menu
item? Or maybe just a link from the Working Groups page here:
http://dev.joomla.org/content/view/13/53/
Also Shayne has been writing a kind of induction email for new recruits
to the Dev Doc Team. I think that's a good idea but rather than it
become an overly long document I would suggest that much of it could
form the basis of a "Getting Started on the Dev Doc Team" meta-document
which could be made available along with all the other meta-docs.
What do you think?
Regards,
Chris.
--
Chris Davenport
ch...@dcsnet.demon.co.uk
Barrie North
If they are on doc team, does that mean they have a log in to help site so can see things that are set to "registered". On that basis, couldn't they just be left on help site?
Barrie
Hi All,
The Dev Doc Team has, over a period of time, accumulated a number of
useful documents/pages that are important to us but not immediately
relevant to visitors. I'm referring primarily to the stuff here:
http://help.joomla.org/content/category/37/150/106/
One of the items has been copied to the wiki here:
http://dev.joomla.org/index.php?option=com_jd-wiki&Itemid=31&id=reference
s:developer.documentation.workflow
However, given that they cannot stay on help.joomla.org , I would argue
Shayne Bartlett
@ Barry, yes they would need to log onto the dev site, but then we are
moving all Developer documentation to the dev site. The stuff that is on
the help site will disapear once the move is complete. This means that
the documents in question, which are strictly developer documentation
related would be best suited on the dev site as Developer Documentation
team people will not be writing on the help site at all.
@ Chris, all sounds good to me. I'll arrange to get the relevent section
created today. I also like the idea of the "Orientation" (prefer to
induction) page. Once the section is up I'll do a first draft the
everyone can comment/adjust.
Cheers
Shayne
Barrie North wrote:
> Well,
>
> If they are on doc team, does that mean they have a log in to help
> site so can see things that are set to "registered". On that basis,
> couldn't they just be left on help site?
>
> Barrie
>
> On 4/21/06, *Chris Davenport* <ch...@dcsnet.demon.co.uk
> <mailto:ch...@dcsnet.demon.co.uk>> wrote:
>
>
> Hi All,
>
> The Dev Doc Team has, over a period of time, accumulated a number of
> useful documents/pages that are important to us but not immediately
> relevant to visitors. I'm referring primarily to the stuff here:
> http://help.joomla.org/content/category/37/150/106/
>
> One of the items has been copied to the wiki here:
> http://dev.joomla.org/index.php?option=com_jd-wiki&Itemid=31&id=reference
> <http://dev.joomla.org/index.php?option=com_jd-wiki&Itemid=31&id=reference>
> s:developer.documentation.workflow
>
> However, given that they cannot stay on help.joomla.org
> <http://help.joomla.org> , I would argue
> that the wiki is not the right place for this material either. I
> think
> that all such meta-docs should be moved to the dev site as Joomla!
> content and kept out of the wiki where their presence will confuse
> and
> distract from the real content! Perhaps a "Doc Team Resources" menu
> item? Or maybe just a link from the Working Groups page here:
> http://dev.joomla.org/content/view/13/53/
> <http://dev.joomla.org/content/view/13/53/>
>
> Also Shayne has been writing a kind of induction email for new
> recruits
> to the Dev Doc Team. I think that's a good idea but rather than it
> become an overly long document I would suggest that much of it could
> form the basis of a "Getting Started on the Dev Doc Team"
> meta-document
> which could be made available along with all the other meta-docs.
>
> What do you think?
>
> Regards,
> Chris.
>
> --
> Chris Davenport
> ch...@dcsnet.demon.co.uk <mailto:ch...@dcsnet.demon.co.uk>
>
>
>
>
>
>
> >
Johan Janssens
Feel free to add extra content items in the documentation menu on the
dev site and make it for registered users only. The dev site is all
yours ;)
Johan