Documenting Plone 3.3 PLIPs -- assignments and further work (moved from plone-docs)

8 messages Options
Embed this post
Permalink
Israel Saeta Pérez () Documenting Plone 3.3 PLIPs -- assignments and further work (moved from plone-docs)
Reply Threaded More More options
Print post
Permalink
I've already assigned all the tickets to current editors using my own criteria. Please check the list and reassign them if needed. To work on them I suggest following this process:
  1. Make a list of documents affected. This list may include only documents which are selected to go to the official documentation area.
  2. Make a copy of them and find someone to document the changes.
  3. Ask the implementer of each PLIP to review the introduced documentation changes.
  4. After the 3.3 release, copy the contents of the copied articles back to the live ones, and delete the copies.
I wouldn't like us to fail at this point because I feel that, if we fail documenting 3.3 PLIPs, we will disappoint the whole framework team and they won't trust us going to do this anymore.

Go, editors, go!

-- israel


On Thu, Jan 22, 2009 at 3:33 PM, Israel Saeta Pérez <[hidden email]> wrote:
On Thu, Jan 22, 2009 at 1:36 PM, Wichert Akkerman <[hidden email]> wrote:
Previously Israel Saeta Pérez wrote:
> On Thu, Dec 25, 2008 at 5:29 PM, Israel Saeta Pérez <[hidden email]>wrote:
>
> > I've filed some bugs in Trac on the documentation component regarding
> > Plone 3.3 accepted PLIPs documentation<https://dev.plone.org/plone/query?status=new&status=assigned&status=reopened&component=Documentation&milestone=3.3&order=priority>
> > .
> >
>
> I've already seen some 3.3 PLIPs implementation announcements in the
> framework-team mailing list describing what documentation changes would be
> needed. Should we assign the related documentation tickets to avoid leaving
> this task undone?

Is this making any progress?

I've added some documentation info from the framework-team list messages to each ticket.
 

I'ld suggest to just go ahead and assign tickets to people.


I've already assigned some of them, but I'd prefer our editors to have a look at the tickets and accept the ones belonging to their sections.


-- israel



------------------------------------------------------------------------------
This SF.net email is sponsored by:
SourcForge Community
SourceForge wants to tell your story.
http://p.sf.net/sfu/sf-spreadtheword
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Israel Saeta Pérez
JoAnna Springsteen () Re: Documenting Plone 3.3 PLIPs -- assignments and further work (moved from plone-docs)
Reply Threaded More More options
Print post
Permalink
Thanks for taking the initiative on this Israel. I'm moving on Friday
so for about the next week I'll be missing. Will pick up on hounding
everyone about deadlines once I'm settled. (including these)

J.

On Sun, Jan 25, 2009 at 3:15 PM, Israel Saeta Pérez <[hidden email]> wrote:

> I've already assigned all the tickets to current editors using my own
> criteria. Please check the list and reassign them if needed. To work on them
> I suggest following this process:
>
> Make a list of documents affected. This list may include only documents
> which are selected to go to the official documentation area.
> Make a copy of them and find someone to document the changes.
> Ask the implementer of each PLIP to review the introduced documentation
> changes.
> After the 3.3 release, copy the contents of the copied articles back to the
> live ones, and delete the copies.
>
> I wouldn't like us to fail at this point because I feel that, if we fail
> documenting 3.3 PLIPs, we will disappoint the whole framework team and they
> won't trust us going to do this anymore.
>
> Go, editors, go!
>
> -- israel
>
>
> On Thu, Jan 22, 2009 at 3:33 PM, Israel Saeta Pérez <[hidden email]>
> wrote:
>>
>> On Thu, Jan 22, 2009 at 1:36 PM, Wichert Akkerman <[hidden email]>
>> wrote:
>>>
>>> Previously Israel Saeta Pérez wrote:
>>> > On Thu, Dec 25, 2008 at 5:29 PM, Israel Saeta Pérez
>>> > <[hidden email]>wrote:
>>> >
>>> > > I've filed some bugs in Trac on the documentation component regarding
>>> > > Plone 3.3 accepted PLIPs
>>> > > documentation<https://dev.plone.org/plone/query?status=new&status=assigned&status=reopened&component=Documentation&milestone=3.3&order=priority>
>>> > > .
>>> > >
>>> >
>>> > I've already seen some 3.3 PLIPs implementation announcements in the
>>> > framework-team mailing list describing what documentation changes would
>>> > be
>>> > needed. Should we assign the related documentation tickets to avoid
>>> > leaving
>>> > this task undone?
>>>
>>> Is this making any progress?
>>
>> I've added some documentation info from the framework-team list messages
>> to each ticket.
>>
>>>
>>> I'ld suggest to just go ahead and assign tickets to people.
>>
>>
>> I've already assigned some of them, but I'd prefer our editors to have a
>> look at the tickets and accept the ones belonging to their sections.
>>
>>
>> -- israel
>>
>
>
> ------------------------------------------------------------------------------
> This SF.net email is sponsored by:
> SourcForge Community
> SourceForge wants to tell your story.
> http://p.sf.net/sfu/sf-spreadtheword
> _______________________________________________
> Plone-docs mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/plone-docs
>
>

------------------------------------------------------------------------------
This SF.net email is sponsored by:
SourcForge Community
SourceForge wants to tell your story.
http://p.sf.net/sfu/sf-spreadtheword
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
JoAnna Springsteen () Re: Documenting Plone 3.3 PLIPs -- assignments and further work (moved from plone-docs)
Reply Threaded More More options
Print post
Permalink
In reply to this post by Israel Saeta Pérez
Would those who have tickets assigned for documenting PLIPs
(http://tinyurl.com/b4kj4a) Please put an update in the comments of
the ticket so we know what your progress has been?
The Framework team has graciously included us very early on in the
development process. We absolutely can not let them down with this
work. These need to be documented by the time 3.3 comes out or very
shortly after (read: a week after is shortly after).

If you need help, don't have the time, don't have the knowledge, etc,
please let me know asap. I will help you find the resources to figure
out the ticket.
Updating documents in a timely matter according to releases is a part
of our doc team roadmap. This is a bit of a new process to us. If you
have any questions at all, please let me know. This is something we
need to work into our routine of being doc team members. If you'd like
to volunteer for any of these items (or others) email me or the list
in general.

I know we can do this! There are only a handful of PLIPs that need documenting!
go team docs!!
J.


On Sun, Jan 25, 2009 at 3:15 PM, Israel Saeta Pérez <[hidden email]> wrote:

> I've already assigned all the tickets to current editors using my own
> criteria. Please check the list and reassign them if needed. To work on them
> I suggest following this process:
>
> Make a list of documents affected. This list may include only documents
> which are selected to go to the official documentation area.
> Make a copy of them and find someone to document the changes.
> Ask the implementer of each PLIP to review the introduced documentation
> changes.
> After the 3.3 release, copy the contents of the copied articles back to the
> live ones, and delete the copies.
>
> I wouldn't like us to fail at this point because I feel that, if we fail
> documenting 3.3 PLIPs, we will disappoint the whole framework team and they
> won't trust us going to do this anymore.
>
> Go, editors, go!
>
> -- israel
>
>
> On Thu, Jan 22, 2009 at 3:33 PM, Israel Saeta Pérez <[hidden email]>
> wrote:
>>
>> On Thu, Jan 22, 2009 at 1:36 PM, Wichert Akkerman <[hidden email]>
>> wrote:
>>>
>>> Previously Israel Saeta Pérez wrote:
>>> > On Thu, Dec 25, 2008 at 5:29 PM, Israel Saeta Pérez
>>> > <[hidden email]>wrote:
>>> >
>>> > > I've filed some bugs in Trac on the documentation component regarding
>>> > > Plone 3.3 accepted PLIPs
>>> > > documentation<https://dev.plone.org/plone/query?status=new&status=assigned&status=reopened&component=Documentation&milestone=3.3&order=priority>
>>> > > .
>>> > >
>>> >
>>> > I've already seen some 3.3 PLIPs implementation announcements in the
>>> > framework-team mailing list describing what documentation changes would
>>> > be
>>> > needed. Should we assign the related documentation tickets to avoid
>>> > leaving
>>> > this task undone?
>>>
>>> Is this making any progress?
>>
>> I've added some documentation info from the framework-team list messages
>> to each ticket.
>>
>>>
>>> I'ld suggest to just go ahead and assign tickets to people.
>>
>>
>> I've already assigned some of them, but I'd prefer our editors to have a
>> look at the tickets and accept the ones belonging to their sections.
>>
>>
>> -- israel
>>
>
>
> ------------------------------------------------------------------------------
> This SF.net email is sponsored by:
> SourcForge Community
> SourceForge wants to tell your story.
> http://p.sf.net/sfu/sf-spreadtheword
> _______________________________________________
> Plone-docs mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/plone-docs
>
>

------------------------------------------------------------------------------
Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM)
software. With Adobe AIR, Ajax developers can use existing skills and code to
build responsive, highly engaging applications that combine the power of local
resources and data with the reach of the web. Download the Adobe AIR SDK and
Ajax docs to start building applications today-http://p.sf.net/sfu/adobe-com
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Donna M Snow () Re: Documenting Plone 3.3 PLIPs -- assignments and further work (moved from plone-docs)
Reply Threaded More More options
Print post
Permalink
JoAnna (or somebody),

How do you "document" a plip? This is a new idea for me, can someone
elaborate?

Donna

------------------------------------------------------------------------------
Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM)
software. With Adobe AIR, Ajax developers can use existing skills and code to
build responsive, highly engaging applications that combine the power of local
resources and data with the reach of the web. Download the Adobe AIR SDK and
Ajax docs to start building applications today-http://p.sf.net/sfu/adobe-com
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Israel Saeta Pérez () Re: Documenting Plone 3.3 PLIPs -- assignments and further work (moved from plone-docs)
Reply Threaded More More options
Print post
Permalink
On Wed, Feb 4, 2009 at 11:41 PM, Donna M Snow wrote:
JoAnna (or somebody),

How do you "document" a plip? This is a new idea for me, can someone
elaborate?

Heh. You don't really document the plip but the changes introduced in Plone by the plip. For example, if one PLIP comprises setting inline editing disabled by default and displaying an option in a configlet to turn it on/off, our existing authorative manuals should be updated to reflect that. And so on.

Hope it helps, and thanks for your consideration! :-)

-- israel


------------------------------------------------------------------------------
Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM)
software. With Adobe AIR, Ajax developers can use existing skills and code to
build responsive, highly engaging applications that combine the power of local
resources and data with the reach of the web. Download the Adobe AIR SDK and
Ajax docs to start building applications today-http://p.sf.net/sfu/adobe-com
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Israel Saeta Pérez
Israel Saeta Pérez () Re: [Doc-Editors] Re: Documenting Plone 3.3 PLIPs -- assignments and further work (moved from plone-docs)
Reply Threaded More More options
Print post
Permalink
In reply to this post by JoAnna Springsteen
On Wed, Feb 4, 2009 at 11:28 PM, JoAnna Springsteen wrote:
Would those who have tickets assigned for documenting PLIPs
(http://tinyurl.com/b4kj4a) Please put an update in the comments of
the ticket so we know what your progress has been?

Dear subscribers:

Even if you've not been assigned any PLIP ticket, you can contribute too! Most of them are fairly easy to tackle, so please take a look at the list and see if you'd like to help with any of them.

If you have any doubts or need any permission to work on a ticket, please post to this list, comment the ticket, or mail me personally.

The Plone community thank you in advance!

-- israel


------------------------------------------------------------------------------
Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM)
software. With Adobe AIR, Ajax developers can use existing skills and code to
build responsive, highly engaging applications that combine the power of local
resources and data with the reach of the web. Download the Adobe AIR SDK and
Ajax docs to start building applications today-http://p.sf.net/sfu/adobe-com
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Israel Saeta Pérez
Raphael Ritz () Re: [Doc-Editors] Re: Documenting Plone 3.3 PLIPs -- assignments and further work (moved from plone-docs)
Reply Threaded More More options
Print post
Permalink
Israel Saeta Pérez wrote:

> On Wed, Feb 4, 2009 at 11:28 PM, JoAnna Springsteen wrote:
>
>     Would those who have tickets assigned for documenting PLIPs
>     (http://tinyurl.com/b4kj4a) Please put an update in the comments of
>     the ticket so we know what your progress has been?
>
>
> Dear subscribers:
>
> Even if you've not been assigned any PLIP ticket, you can contribute
> too! Most of them are fairly easy to tackle, so please take a look at
> the list <http://tinyurl.com/b4kj4a> and see if you'd like to help with
> any of them.

To complement the info provided by the link Israel posted above you
might want to look here as well:

   http://dev.plone.org/plone/wiki/PLIPTallies33

Raphael

>
> If you have any doubts or need any permission to work on a ticket,
> please post to this list, comment the ticket, or mail me personally.
>
> The Plone community thank you in advance!
>
> -- israel
>
>
> ------------------------------------------------------------------------
>
> ------------------------------------------------------------------------------
> Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM)
> software. With Adobe AIR, Ajax developers can use existing skills and code to
> build responsive, highly engaging applications that combine the power of local
> resources and data with the reach of the web. Download the Adobe AIR SDK and
> Ajax docs to start building applications today-http://p.sf.net/sfu/adobe-com
>
>
> ------------------------------------------------------------------------
>
> _______________________________________________
> Plone-docs mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/plone-docs


------------------------------------------------------------------------------
Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM)
software. With Adobe AIR, Ajax developers can use existing skills and code to
build responsive, highly engaging applications that combine the power of local
resources and data with the reach of the web. Download the Adobe AIR SDK and
Ajax docs to start building applications today-http://p.sf.net/sfu/adobe-com
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Israel Saeta Pérez () Re: [Doc-Editors] Re: Documenting Plone 3.3 PLIPs -- assignments and further work (moved from plone-docs)
Reply Threaded More More options
Print post
Permalink
On Tue, Feb 10, 2009 at 9:42 AM, Raphael Ritz wrote:
To complement the info provided by the link Israel posted above you
might want to look here as well:

  http://dev.plone.org/plone/wiki/PLIPTallies33

Raphael

Raphael's announced recently in the framework-team mailing list that all submitted PLIPs are ready for merging (see the link above).

Could asignees of the associated bugs put an update of the progress where they've not done it yet, please?

From my side, Document PLIP #239: Adapterise the Extensible Indexable Object Wrapper is already documented (needs review), but I personally need some help with Document PLIP #247: Automate ZCML Loading for Plone Plug-ins to understand how it works and decide what docs should we extend to reflect the changes. Kamon?

Anne Botwell has tackled Document PLIP #232: Resource Registries Improvements and Document PLIP #243: Replace workflow history viewlet with content history viewlet (thanks!), which also need review. Veda?

-- israel


------------------------------------------------------------------------------
Open Source Business Conference (OSBC), March 24-25, 2009, San Francisco, CA
-OSBC tackles the biggest issue in open source: Open Sourcing the Enterprise
-Strategies to boost innovation and cut costs with open source participation
-Receive a $600 discount off the registration fee with the source code: SFAD
http://p.sf.net/sfu/XcvMzF8H
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Israel Saeta Pérez