Re: state of plone.org/kb and sprint

Israel Saeta PĂ©rez <[email protected]> Tue, 3 Sep 2013 10:55:46 +0200
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <CAAV5UowyR0qmR0ZuFodBWP+oN8X+LUEVM3p0K44AGQvdcrXOWQ@mail.gmail.com>
--===============2438564649784138382==
Content-Type: multipart/alternative; boundary=047d7bd76928fe052b04e576db54

--047d7bd76928fe052b04e576db54
Content-Type: text/plain; charset=ISO-8859-1

Helloes! Back to work! :)

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

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
product, and that is already a book, isn't it?

Regarding the documentation sprint, I would be available starting from
October (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
> manual.
> 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=48897511&iu=/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=58040911&iu=/4140/ostg.clktrk
> _______________________________________________
> Plone-docs mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/plone-docs
>

--047d7bd76928fe052b04e576db54
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">Helloes! Back to work! :)<div><br></div><div>I&#39;m for d=
ropping the documentation grouping by &quot;user role&quot;, i.e. Integrato=
r, Developer, Admins, etc. I think it is better to group them by topic, or =
organically as in=A0<a href=3D"http://developer.plone.org/#table-of-content=
s">http://developer.plone.org/#table-of-contents</a>.=A0</div>

<div><br></div><div>The only &quot;role&quot; I can think of that makes rea=
l sense is &quot;end user&quot;, that is the user who doesn&#39;t have to c=
ode or install anything but just use the product, and that is already a boo=
k, isn&#39;t it?</div>

<div><br></div><div>Regarding the documentation sprint, I would be availabl=
e starting from October (remotely).</div><div><br></div><div>-- israel</div=
><div><br></div></div><div class=3D"gmail_extra"><br><br><div class=3D"gmai=
l_quote">

2013/8/28 Dylan Jay <span dir=3D"ltr">&lt;<a href=3D"mailto:dylan@dylanjay.=
com" target=3D"_blank">dylan-Q+/Sk2sTzaxWk0Htik3J/[email protected]</a>&gt;</span><br><blockquote cla=
ss=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;border-left:1px #ccc solid;pa=
dding-left:1ex">

<div class=3D"im">On 28/08/2013, at 12:47 AM, sven &lt;<a href=3D"mailto:sv=
[email protected]">[email protected]</a>&gt; wrote:<br>
<br>
&gt; Hi,<br>
&gt;<br>
&gt; I saw it today again on irc, new people are often confused about how w=
e<br>
&gt; handle documentation, with the result that ppl. not able to find<br>
&gt; something or give up looking further because the link for example is<b=
r>
&gt; pointing to <a href=3D"http://developer.plone.org" target=3D"_blank">d=
eveloper.plone.org</a> and then they assume it is for<br>
&gt; developers not for admins [happened today].<br>
&gt; The other point is we do have some documentation under <a href=3D"http=
://plone.org/kb" target=3D"_blank">plone.org/kb</a> and<br>
&gt; some under <a href=3D"http://developer.plone.org" target=3D"_blank">de=
veloper.plone.org</a>, for example if I take documentation<br>
&gt; about apache, this could be/is confusing ....<br>
&gt; How we want to solve this ?<br>
&gt; - do we still want to use /kb or we want to integrate kb content to<br=
>
&gt; <a href=3D"http://developer.plone.org" target=3D"_blank">developer.plo=
ne.org</a><br>
&gt; - if we want to use kb and developer.p.o what goes where ?<br>
&gt; - do we want to have <a href=3D"http://developer.plone.org" target=3D"=
_blank">developer.plone.org</a> and for example<br>
&gt; <a href=3D"http://documentation.plone.org" target=3D"_blank">documenta=
tion.plone.org</a> ?<br>
<br>
</div>I agree the developer manual is now increasingly misnamed. I think<br=
>
because its successful it now includes everything but the end user<br>
manual.<br>
I think a sprint to review the kb to remove info already covered in the man=
ual.<br>
I think we should move the manual under the same domain. Eg<br>
<a href=3D"http://plone.org/docs/manual/4.3" target=3D"_blank">plone.org/do=
cs/manual/4.3</a><br>
Perhaps call it the integrator manual or just include the user manual<br>
in one bundle and call it the plone manual.<br>
<div class=3D"im"><br>
<br>
&gt;<br>
&gt; Any ideas on this ? Anyone ? :)<br>
&gt;<br>
&gt; Oh and what do you think about a &#39;github issues squashing party&#3=
9; aka a<br>
&gt; documentation sprint ?<br>
&gt;<br>
&gt; cheers<br>
&gt;<br>
&gt; Sven<br>
&gt;<br>
&gt; ----------------------------------------------------------------------=
--------<br>
&gt; Introducing Performance Central, a new site from SourceForge and<br>
&gt; AppDynamics. Performance Central is your source for news, insights,<br=
>
&gt; analysis and resources for efficient Application Performance Managemen=
t.<br>
&gt; Visit us today!<br>
&gt; <a href=3D"http://pubads.g.doubleclick.net/gampad/clk?id=3D48897511&am=
p;iu=3D/4140/ostg.clktrk" target=3D"_blank">http://pubads.g.doubleclick.net=
/gampad/clk?id=3D48897511&amp;iu=3D/4140/ostg.clktrk</a><br>
&gt; _______________________________________________<br>
&gt; Plone-docs mailing list<br>
&gt; <a href=3D"mailto:[email protected]">[email protected]=
ourceforge.net</a><br>
&gt; <a href=3D"https://lists.sourceforge.net/lists/listinfo/plone-docs" ta=
rget=3D"_blank">https://lists.sourceforge.net/lists/listinfo/plone-docs</a>=
<br>
<br>
</div>---------------------------------------------------------------------=
---------<br>
Learn the latest--Visual Studio 2012, SharePoint 2013, SQL 2012, more!<br>
Discover the easy way to master current and previous Microsoft technologies=
<br>
and advance your career. Get an incredible 1,500+ hours of step-by-step<br>
tutorial videos with LearnDevNow. Subscribe today and save!<br>
<a href=3D"http://pubads.g.doubleclick.net/gampad/clk?id=3D58040911&amp;iu=
=3D/4140/ostg.clktrk" target=3D"_blank">http://pubads.g.doubleclick.net/gam=
pad/clk?id=3D58040911&amp;iu=3D/4140/ostg.clktrk</a><br>
<div class=3D"HOEnZb"><div class=3D"h5">___________________________________=
____________<br>
Plone-docs mailing list<br>
<a href=3D"mailto:[email protected]">[email protected]=
forge.net</a><br>
<a href=3D"https://lists.sourceforge.net/lists/listinfo/plone-docs" target=
=3D"_blank">https://lists.sourceforge.net/lists/listinfo/plone-docs</a><br>
</div></div></blockquote></div><br></div>

--047d7bd76928fe052b04e576db54--


--===============2438564649784138382==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

------------------------------------------------------------------------------
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=58040911&iu=/4140/ostg.clktrk
--===============2438564649784138382==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

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

--===============2438564649784138382==--