Re: Developers manual genesis

On Fri, Dec 11, 2009 at 6:55 PM, Martin Aspeli
<[email protected]<optilude%[email protected]>
> wrote:

> On 12/12/09 7:05, Israel Saeta Pérez wrote:
>
> > I thought that the URL for the manual Mikko created time ago
> > <http://plone.org/documentation/manual/developer-manual> is ideal so we
> > started to move stuff to that manual.
>
> Just curious - how are we planning to reconcile this with
> http://plonemanual.twinapex.fi? That resource is already very good, and
> Mikko deserves a lot of credit for getting that going.
>

Yup, I think we are all very excited that Mikko has started this, and the
content is certainly well-written.


> I'm no longer going to try to suggest solutions, but I think we'd do
> well to harness the effort and energy that's gone (and is still going)
> into that manual. Otherwise, there'd be a lot of duplication.
>

I think the idea is to update every now and then (ie. manual copy/paste) and
let developers maintain their documentation in SVN since that's closer to
their workflow — until we have a better solution using something like
Reflecto or other tools that let us just view filesystem content inside PHC.

I don't see it as a huge issue if we have to do this for a little while now
that we have very centralized ownership and editorship of the manuals.
Telling the people that will help out with docs to update the SVN version
instead if they want to work on the Developer Manual should work fine — the
issue earlier was that there was a much greater chance of content getting
lost, since anyone with edit rights in PHC had access to edit those manuals
too.

Now we have an open area for recipes and standalone articles about doing
something specific, while the core editors of the manuals are a smaller
group that can say things like "don't edit the manual directly, use SVN
instead".


> http://plonemanual.twinapex.fi is also not hugely "discoverable". I can
> never remember the URL, for example. :p Getting it into plone.org
> officially would be good.
>

Yes, that's what we're hoping we can make happen, with Mikko's permission.
:)


> Finally - if you look back at the archives, I published a mind map that
> shows some things I'd put into a Plone manual.
>

This is definitely something we should dig back up.


> I also had a thought about how people may learn, step-by-step. This is
> aimed at a "new" (read: Plone 5ish) world. It's not very detailed, but
> may be helpful.
>
> http://grab.by/iYS
>

Yeah, deciding on a good learning strategy as part of the Plone 5 landscape
is a good thing.

-- 
Alexander Limi · http://limi.net

------------------------------------------------------------------------------
Return on Information:
Google Enterprise Search pays you back
Get the facts.
http://p.sf.net/sfu/google-dev2dev

_______________________________________________
Plone-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-docs