Plone 4.0 Documentation Updates

15 messages

Eric Steele (esteele) () Plone 4.0 Documentation Updates

Reply Threaded

Hi all,

Final PLIP voting for Plone 4 has begun and merging should start up
within the next week. As such, it's time for me to loosen my despotic
grip on the Framework Team and turn my focus to the Documentation
Team. As it stands now, there are 21 PLIPs awaiting the FWT's vote [http://bit.ly/plips
]. So we'll have a better idea of what's actually in Plone 4.0 in the
next few days. Despite the number of possible changes, they don't cut
nearly as deep, in end-user terms, as the changes made in 3.0. I
believe that the 3.x-4.0 docs update should be much less of an
undertaking than the 2.5-3.0 one was.

I've asked each implementer to list the documentation changes that
would be needed if their PLIP is included, though some have
been....less complete... than others. As PLIPs are accepted, I'll be
reminding the implementers that it's part of their duty in this
process to help out the docs team as needed; I'm happy to nudge them
along when necessary.

So how do we best proceed from here? What can I do to make your lives
easier?

Eric

------------------------------------------------------------------------------
Come build with us! The BlackBerry® Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9-12, 2009. Register now!
http://p.sf.net/sfu/devconf
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Israel Saeta Pérez () Re: Plone 4.0 Documentation Updates

Reply Threaded

Eric Steele wrote:

> Hi all,
>
> Final PLIP voting for Plone 4 has begun and merging should start up
> within the next week. As such, it's time for me to loosen my despotic
> grip on the Framework Team and turn my focus to the Documentation
> Team. As it stands now, there are 21 PLIPs awaiting the FWT's vote
> [http://bit.ly/plips ]. So we'll have a better idea of what's actually in
> Plone 4.0 in the next few days. Despite the number of possible changes,
> they don't cut nearly as deep, in end-user terms, as the changes made in
> 3.0. I believe that the 3.x-4.0 docs update should be much less of an
> undertaking than the 2.5-3.0 one was.
>
> I've asked each implementer to list the documentation changes that
> would be needed if their PLIP is included, though some have
> been....less complete... than others. As PLIPs are accepted, I'll be
> reminding the implementers that it's part of their duty in this
> process to help out the docs team as needed; I'm happy to nudge them
> along when necessary.
>
> So how do we best proceed from here? What can I do to make your lives
> easier?
>
> Eric

Hi Eric!

Thank you very very much for your kind help proposals. :)

The document listing all the PLIPs and their current state
[http://bit.ly/plips ] will be very helpful for sure. We will distribute the
approved PLIPs among the current documentation editors and then each editor
will manage to find out what do we need to update and contact the
implementers to ask for help to write the updates and new documentation.

Should we create separate tickets in trac to track the documentation for
each PLIP or can we reuse the current PLIPs tickets?

--
israel

------------------------------------------------------------------------------
Come build with us! The BlackBerry® Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9-12, 2009. Register now!
http://p.sf.net/sfu/devconf
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Israel Saeta Pérez

JoAnna Springsteen () Re: Plone 4.0 Documentation Updates

Reply Threaded

In reply to this post by Eric Steele (esteele)

> So how do we best proceed from here? What can I do to make your lives
> easier?

I would prefer that the doc team not work on PLIPs until we know for
sure, 100% that these items are going into Plone. Meaning the
implementers are done with the code, it's gone through the review
process and things have been merged. According to your spreadsheet,
that looks like about 3 tickets so far. I know there will be more, I
just don't want people trying to document a still moving target.

If by some miracle you can get the implementers to take a first draft
at documenting their PLIPs, that would be a huge help as well!
Personally, I would prefer we not create separate tickets for
documenting the PLIPs. Let's switch them to the documentation
component when they are ready to be documented. Does that make sense?

JoAnna

------------------------------------------------------------------------------
Come build with us! The BlackBerry® Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9-12, 2009. Register now!
http://p.sf.net/sfu/devconf
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Eric Steele (esteele) () Re: Plone 4.0 Documentation Updates

Reply Threaded

In reply to this post by Israel Saeta Pérez

On Oct 2, 2009, at 8:10 AM, Israel Saeta Pérez wrote:

> Hi Eric!
>
> Thank you very very much for your kind help proposals. :)
>
> The document listing all the PLIPs and their current state
> [http://bit.ly/plips ] will be very helpful for sure. We will
> distribute the
> approved PLIPs among the current documentation editors and then each
> editor
> will manage to find out what do we need to update and contact the
> implementers to ask for help to write the updates and new
> documentation.
>
> Should we create separate tickets in trac to track the documentation
> for
> each PLIP or can we reuse the current PLIPs tickets?

I think I'd rather create new documentation tickets that reference the
original PLIP ticket, purely for roadmap purposes. Though I may change
my mind on that once Alex and I have a chance to finish the PSC
migration. Feel free to talk me out of that.

We should have a full list of inclusions by the end of the day
tomorrow. I'll keep you posted.

Eric
------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Israel Saeta Pérez () Re: Plone 4.0 Documentation Updates

Reply Threaded

2009/10/7 Eric Steele wrote:

On Oct 2, 2009, at 8:10 AM, Israel Saeta Pérez wrote:

Hi Eric!

Thank you very very much for your kind help proposals. :)

The document listing all the PLIPs and their current state
[http://bit.ly/plips ] will be very helpful for sure. We will distribute the
approved PLIPs among the current documentation editors and then each editor
will manage to find out what do we need to update and contact the
implementers to ask for help to write the updates and new documentation.

Should we create separate tickets in trac to track the documentation for
each PLIP or can we reuse the current PLIPs tickets?

I think I'd rather create new documentation tickets that reference the original PLIP ticket, purely for roadmap purposes. Though I may change my mind on that once Alex and I have a chance to finish the PSC migration. Feel free to talk me out of that.

Isn't documentation part of the roadmap for 4.0? ;) Anyhow, I'm open to create new tickets for documentation if this helps with the organization of tasks.

We should have a full list of inclusions by the end of the day tomorrow. I'll keep you posted.

Thanks!

=)

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Israel Saeta Pérez

Eric Steele (esteele) () Re: Plone 4.0 Documentation Updates

Reply Threaded

On Oct 7, 2009, at 2:37 AM, Israel Saeta Pérez wrote:

> Isn't documentation part of the roadmap for 4.0? ;) Anyhow, I'm
> open to create new tickets for documentation if this helps with the
> organization of tasks.
>

Well, sure. It's just not something I want displayed under the "new
features included" section of the roadmap page. ;)

Eric
------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Eric Steele (esteele) () Re: Plone 4.0 Documentation Updates

Reply Threaded

In reply to this post by Israel Saeta Pérez

As the editors have probably noticed, there are now a set of tickets
for the accepted Plone 4.0 PLIPs. Reference links to the original PLIP
ticket are inside (and a reference to the doc ticket is in the
comments of the PLIP ticket).

Hopefully, that's enough to get things rolling. Please let me know if
anyone is not cooperating to the extent that you need and I'll try to
push them to do so.

Eric

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Israel Saeta Pérez () Re: Plone 4.0 Documentation Updates

Reply Threaded

Thanks!

I've gone throught (almost) all the PLIPs documentation tickets,
provided some hints about what do we have to update and asked the
implementers to help us writing migration docs and updating existing
ones.

I've also assigned some of the tickets to an editor where it was clear
which section does the changes belong to. Editors, please don't
hesitate to contact me if you need any help or clarification.

Thank you very much Eric!

-- israel

2009/10/10 Eric Steele <[hidden email]>:

> As the editors have probably noticed, there are now a set of tickets for the
> accepted Plone 4.0 PLIPs. Reference links to the original PLIP ticket are
> inside (and a reference to the doc ticket is in the comments of the PLIP
> ticket).
>
> Hopefully, that's enough to get things rolling. Please let me know if anyone
> is not cooperating to the extent that you need and I'll try to push them to
> do so.
>
> Eric
>

Israel Saeta Pérez

Anne Bowtell-3 () Re: Plone 4.0 Documentation Updates

Reply Threaded

I'm keen to get a version of Plone 4 up and running, so that I can work
out what needs documenting on the new theme. Can you point me to the
buildout please?

Thanks

Anne

Israel Saeta Pérez wrote:

> Thanks!
>
> I've gone throught (almost) all the PLIPs documentation tickets,
> provided some hints about what do we have to update and asked the
> implementers to help us writing migration docs and updating existing
> ones.
>
> I've also assigned some of the tickets to an editor where it was clear
> which section does the changes belong to. Editors, please don't
> hesitate to contact me if you need any help or clarification.
>
> Thank you very much Eric!
>
> -- israel
>
>
> 2009/10/10 Eric Steele <[hidden email]>:
>
>> As the editors have probably noticed, there are now a set of tickets for the
>> accepted Plone 4.0 PLIPs. Reference links to the original PLIP ticket are
>> inside (and a reference to the doc ticket is in the comments of the PLIP
>> ticket).
>>
>> Hopefully, that's enough to get things rolling. Please let me know if anyone
>> is not cooperating to the extent that you need and I'll try to push them to
>> do so.
>>
>> Eric
>>
>>
>
> ------------------------------------------------------------------------------
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart your
> developing skills, take BlackBerry mobile applications to market and stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
> _______________________________________________
> Plone-docs mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/plone-docs
>

Israel Saeta Pérez () Re: Plone 4.0 Documentation Updates

Reply Threaded

I think there's no buildout for Plone 4 yet. The PLIPs are being
merged and I hope we will have a first alpha release in a couple of
weeks. Eric?

-- israel

2009/10/11 Anne Bowtell <[hidden email]>:

> I'm keen to get a version of Plone 4 up and running, so that I can work out
> what needs documenting on the new theme. Can you point me to the buildout
> please?
>
> Thanks
>
> Anne
>
>
> Israel Saeta Pérez wrote:
>>
>> Thanks!
>>
>> I've gone throught (almost) all the PLIPs documentation tickets,
>> provided some hints about what do we have to update and asked the
>> implementers to help us writing migration docs and updating existing
>> ones.
>>
>> I've also assigned some of the tickets to an editor where it was clear
>> which section does the changes belong to. Editors, please don't
>> hesitate to contact me if you need any help or clarification.
>>
>> Thank you very much Eric!
>>
>> -- israel
>>
>>
>> 2009/10/10 Eric Steele <[hidden email]>:
>>
>>>
>>> As the editors have probably noticed, there are now a set of tickets for
>>> the
>>> accepted Plone 4.0 PLIPs. Reference links to the original PLIP ticket are
>>> inside (and a reference to the doc ticket is in the comments of the PLIP
>>> ticket).
>>>
>>> Hopefully, that's enough to get things rolling. Please let me know if
>>> anyone
>>> is not cooperating to the extent that you need and I'll try to push them
>>> to
>>> do so.
>>>
>>> Eric
>>>
>>>
>>
>>
>> ------------------------------------------------------------------------------
>> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
>> is the only developer event you need to attend this year. Jumpstart your
>> developing skills, take BlackBerry mobile applications to market and stay
>> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
>> http://p.sf.net/sfu/devconference
>> _______________________________________________
>> Plone-docs mailing list
>> [hidden email]
>> https://lists.sourceforge.net/lists/listinfo/plone-docs
>>
>
>

Israel Saeta Pérez

Eric Steele (esteele) () Re: Plone 4.0 Documentation Updates

Reply Threaded

Yes, there is a dev buildout.
http://svn.plone.org/svn/plone/buildouts/plone-coredev/branches/4.0

Note that we're targeting Python 2.6 (yay, finally a supported version
of Python!), but I believe 2.4 and 2.5 will still work for now.

So the procedure would basically be:
svn co http://svn.plone.org/svn/plone/buildouts/plone-coredev/branches/4.0
plone4
cd plone4
python2.6 bootstrap.py
bin/buildout

Merges are still ongoing and we're constantly making changes, so
running 'svn up' and 'bin/buildout' occasionally would be needed to
grab the latest and greatest.

I have some basic notes on installation at http://dev.plone.org/plone/wiki/Plone4#PLIPImplementation
, though more geared to the implementers. Changes are welcome.

Eric

On Oct 11, 2009, at 8:03 AM, Israel Saeta Pérez wrote:

> I think there's no buildout for Plone 4 yet. The PLIPs are being
> merged and I hope we will have a first alpha release in a couple of
> weeks. Eric?
>
> -- israel
>
>
> 2009/10/11 Anne Bowtell <[hidden email]>:
>> I'm keen to get a version of Plone 4 up and running, so that I can
>> work out
>> what needs documenting on the new theme. Can you point me to the
>> buildout
>> please?
>>
>> Thanks
>>
>> Anne
>>
>>
>> Israel Saeta Pérez wrote:
>>>
>>> Thanks!
>>>
>>> I've gone throught (almost) all the PLIPs documentation tickets,
>>> provided some hints about what do we have to update and asked the
>>> implementers to help us writing migration docs and updating existing
>>> ones.
>>>
>>> I've also assigned some of the tickets to an editor where it was
>>> clear
>>> which section does the changes belong to. Editors, please don't
>>> hesitate to contact me if you need any help or clarification.
>>>
>>> Thank you very much Eric!
>>>
>>> -- israel
>>>
>>>
>>> 2009/10/10 Eric Steele <[hidden email]>:
>>>
>>>>
>>>> As the editors have probably noticed, there are now a set of
>>>> tickets for
>>>> the
>>>> accepted Plone 4.0 PLIPs. Reference links to the original PLIP
>>>> ticket are
>>>> inside (and a reference to the doc ticket is in the comments of
>>>> the PLIP
>>>> ticket).
>>>>
>>>> Hopefully, that's enough to get things rolling. Please let me
>>>> know if
>>>> anyone
>>>> is not cooperating to the extent that you need and I'll try to
>>>> push them
>>>> to
>>>> do so.
>>>>
>>>> Eric
>>>>
>>>>
>>>
>>>
>>> ------------------------------------------------------------------------------
>>> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
>>> is the only developer event you need to attend this year.
>>> Jumpstart your
>>> developing skills, take BlackBerry mobile applications to market
>>> and stay
>>> ahead of the curve. Join us from November 9 - 12, 2009. Register
>>> now!
>>> http://p.sf.net/sfu/devconference
>>> _______________________________________________
>>> Plone-docs mailing list
>>> [hidden email]
>>> https://lists.sourceforge.net/lists/listinfo/plone-docs
>>>
>>
>>

David Glick-2 () Re: Plone 4.0 Documentation Updates

Reply Threaded

Eric Steele wrote:
> Yes, there is a dev buildout.
> http://svn.plone.org/svn/plone/buildouts/plone-coredev/branches/4.0
>
> Note that we're targeting Python 2.6 (yay, finally a supported version
> of Python!), but I believe 2.4 and 2.5 will still work for now.
>
No, I'm pretty sure Hanno made a few changes that removed support for
2.4 at least, and possibly 2.5 as well.
> Merges are still ongoing and we're constantly making changes, so
> running 'svn up' and 'bin/buildout' occasionally would be needed to
> grab the latest and greatest.
>
This isn't adequate to update all the component packages. You must do:
svn up
bin/develop up
bin/buildout

David

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Anne Bowtell-3 () Re: Plone 4.0 Documentation Updates

Reply Threaded

Thanks very much. I finally got this to work - but it took a while :)

Tips for anyone (brave) in the documentation team who needs Plone 4
right now (and has Mac OS X.5):

Python version - I tried Python 2.5 and it didn't work, so you it looks
as if you need Python 2.6. I couldn't get the most recent version
(2.6.3) to work with setuptools, until I installed it (and setuptools
and PIL) via MacPorts.

You might need to checkout one or two of the components under
development manually into src. Delete any less up-to-date versions of
the components from the eggs directory (where buildout has tried to
compensate for their absence by downloading a release).

Anne

David Glick wrote:

> Eric Steele wrote:
>
>> Yes, there is a dev buildout.
>> http://svn.plone.org/svn/plone/buildouts/plone-coredev/branches/4.0
>>
>> Note that we're targeting Python 2.6 (yay, finally a supported version
>> of Python!), but I believe 2.4 and 2.5 will still work for now.
>>
>>
> No, I'm pretty sure Hanno made a few changes that removed support for
> 2.4 at least, and possibly 2.5 as well.
>
>> Merges are still ongoing and we're constantly making changes, so
>> running 'svn up' and 'bin/buildout' occasionally would be needed to
>> grab the latest and greatest.
>>
>>
> This isn't adequate to update all the component packages. You must do:
> svn up
> bin/develop up
> bin/buildout
>
> David
>
> ------------------------------------------------------------------------------
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart your
> developing skills, take BlackBerry mobile applications to market and stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
> _______________________________________________
> Plone-docs mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/plone-docs
>

Maurits van Rees-3 () Re: Plone 4.0 Documentation Updates

Reply Threaded

Sometime last year I started an upgrade guide from Plone 3.x to 4.0:

http://plone.org/documentation/manual/upgrade-guide/version/upgrading-plone-3-x-to-4.0

Only one page in there for now, about fixes needed as there are no
more global definitions in the main template.

Please add and improve. :-)

--
Maurits van Rees | http://maurits.vanrees.org/
Work | http://zestsoftware.nl/
"This is your day, don't let them take it away." [Barlow Girl]

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Israel Saeta Pérez () Re: Plone 4.0 Documentation Updates

Reply Threaded

Maurits van Rees wrote:
> Sometime last year I started an upgrade guide from Plone 3.x to 4.0:
>
> http://plone.org/documentation/manual/upgrade-guide/version/upgrading-plone-3-x-to-4.0
>
> Only one page in there for now, about fixes needed as there are no
> more global definitions in the main template.
>
> Please add and improve. :-)
>

Yeah! Thanks Maurits; I've already asked the PLIP implementors to add
pages to this section when needed.

-- israel

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Israel Saeta Pérez