Re: state of plone.org/kb and sprint

Dylan Jay <dylan-Q+/Sk2sTzaxWk0Htik3J/[email protected]> Tue, 3 Sep 2013 20:58:39 +1000
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
On 03/09/2013, at 6:55 PM, Israel Saeta P=E9rez <[email protected]> wrote:

> Helloes! Back to work! :)
> =

> I'm for dropping the documentation grouping by "user role", i.e. Integrat=
or, Developer, Admins, etc. I think it is better to group them by topic, or=
 organically as in http://developer.plone.org/#table-of-contents. =


I think by topic like this  - http://developer.plone.org/#programming-plone
makes sense. =

but sorting by manuals, tutorials, old manuals doesn't make any sense IMO


> =

> The only "role" I can think of that makes real sense is "end user", that =
is the user who doesn't have to code or install anything but just use the p=
roduct, and that is already a book, isn't it?

yes. http://plone.org/documentation/manual/plone-4-user-manual
The questions are:
- do we move into sphinx and maintain it there? Possibly with the help of t=
he new robotframework driven screenshots.
- do we move everything in developer.plone.org and put it in http://plone.o=
rg/documentation and have it searchable from inside plone.org
- do we get rid of http://plone.org/documentation/kb?

I think I'm yes to all three.

> =

> Regarding the documentation sprint, I would be available starting from Oc=
tober (remotely).
> =

> -- israel
> =

> =

> =

> 2013/8/28 Dylan Jay <dylan-Q+/Sk2sTzaxWk0Htik3J/[email protected]>
> On 28/08/2013, at 12:47 AM, sven <[email protected]> wrote:
> =

> > Hi,
> >
> > I saw it today again on irc, new people are often confused about how we
> > handle documentation, with the result that ppl. not able to find
> > something or give up looking further because the link for example is
> > pointing to developer.plone.org and then they assume it is for
> > developers not for admins [happened today].
> > The other point is we do have some documentation under plone.org/kb and
> > some under developer.plone.org, for example if I take documentation
> > about apache, this could be/is confusing ....
> > How we want to solve this ?
> > - do we still want to use /kb or we want to integrate kb content to
> > developer.plone.org
> > - if we want to use kb and developer.p.o what goes where ?
> > - do we want to have developer.plone.org and for example
> > documentation.plone.org ?
> =

> I agree the developer manual is now increasingly misnamed. I think
> because its successful it now includes everything but the end user
> manual.
> I think a sprint to review the kb to remove info already covered in the m=
anual.
> I think we should move the manual under the same domain. Eg
> plone.org/docs/manual/4.3
> Perhaps call it the integrator manual or just include the user manual
> in one bundle and call it the plone manual.
> =

> =

> >
> > Any ideas on this ? Anyone ? :)
> >
> > Oh and what do you think about a 'github issues squashing party' aka a
> > documentation sprint ?
> >
> > cheers
> >
> > Sven
> >
> > -----------------------------------------------------------------------=
-------
> > Introducing Performance Central, a new site from SourceForge and
> > AppDynamics. Performance Central is your source for news, insights,
> > analysis and resources for efficient Application Performance Management.
> > Visit us today!
> > http://pubads.g.doubleclick.net/gampad/clk?id=3D48897511&iu=3D/4140/ost=
g.clktrk
> > _______________________________________________
> > Plone-docs mailing list
> > [email protected]
> > https://lists.sourceforge.net/lists/listinfo/plone-docs
> =

> -------------------------------------------------------------------------=
-----
> Learn the latest--Visual Studio 2012, SharePoint 2013, SQL 2012, more!
> Discover the easy way to master current and previous Microsoft technologi=
es
> and advance your career. Get an incredible 1,500+ hours of step-by-step
> tutorial videos with LearnDevNow. Subscribe today and save!
> http://pubads.g.doubleclick.net/gampad/clk?id=3D58040911&iu=3D/4140/ostg.=
clktrk
> _______________________________________________
> Plone-docs mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/plone-docs
> =



---------------------------------------------------------------------------=
---
Learn the latest--Visual Studio 2012, SharePoint 2013, SQL 2012, more!
Discover the easy way to master current and previous Microsoft technologies
and advance your career. Get an incredible 1,500+ hours of step-by-step
tutorial videos with LearnDevNow. Subscribe today and save!
http://pubads.g.doubleclick.net/gampad/clk?id=3D58040911&iu=3D/4140/ostg.cl=
ktrk