[Plone-docs] plan for collective.developermanual

[Dylan Jay]

Hi,

I'm not sure where we're going in making a decision but there doesn't
seem to be too much variation in options so I'm going to go out on a
limb and propose a plan. Unless someone violently disagrees I'll start
implementing it.

1. Someone gives me plone.org manual area access

2. I upload collective.developermanual to http://plone.org/documentation/manual/plone3/developer-manual
and delete the kb version.

3. I convert http://plone.org/documentation/manual/developer-manual
into reST and check into the collective. We create two branches called
plone3 and plone4. I setup nightly uploading script to sync both to
plone.org.

4. Mikko and Israel sit down and discuss chapter headings that take
the best of both manuals (and anyone else who wants to of course).
They raise some tickets about merging the two manuals.

5. Run a tuneup day maybe to help get the work done to do the merge

6. Turn off the old manual so only one exists on the manuals section

7. Publize it to the dev team and product developers lists. Give
examples on how existing code documetnation can be included or how and
where to edit new content for the manual

8. If after a few months the manual isn't awesome we re-evaluate.


---
Dylan Jay, Plone Solutions Manager
www.pretaweb.com
tel:[phone]
mob:[phone]
skype:dylan_jay

[Veda Williams]

I think the only issue is where you mention deleting the kb version. I don't
know if there's a way to insert a redirect to the new version. Then again,
I'm not sure it's a huge deal...

Post by Dylan Jay
Hi,
I'm not sure where we're going in making a decision but there doesn't
seem to be too much variation in options so I'm going to go out on a
limb and propose a plan. Unless someone violently disagrees I'll start
implementing it.
1. Someone gives me plone.org manual area access
2. I upload collective.developermanual to
http://plone.org/documentation/manual/plone3/developer-manual
and delete the kb version.
3. I convert http://plone.org/documentation/manual/developer-manual
into reST and check into the collective. We create two branches called
plone3 and plone4. I setup nightly uploading script to sync both to
plone.org.
4. Mikko and Israel sit down and discuss chapter headings that take
the best of both manuals (and anyone else who wants to of course).
They raise some tickets about merging the two manuals.
5. Run a tuneup day maybe to help get the work done to do the merge
6. Turn off the old manual so only one exists on the manuals section
7. Publize it to the dev team and product developers lists. Give
examples on how existing code documetnation can be included or how and
where to edit new content for the manual
8. If after a few months the manual isn't awesome we re-evaluate.
---
Dylan Jay, Plone Solutions Manager
www.pretaweb.com
tel:[phone]
mob:[phone]
skype:dylan_jay
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

--
Veda Williams
Web Developer
Groundwire
206.286.1235x23
***@groundwire.org
http://groundwire.org

ONE/Northwest is now Groundwire!

[Alexander Limi]

Redirects are easy (@@manage-aliases on an item). Just make sure to record
the existing old URLs before deleting, since we're probably redirecting to
slightly different chapters in the other manual.

Post by Veda Williams
I think the only issue is where you mention deleting the kb version. I don't
know if there's a way to insert a redirect to the new version. Then again,
I'm not sure it's a huge deal...

Post by Dylan Jay
Hi,
I'm not sure where we're going in making a decision but there doesn't
seem to be too much variation in options so I'm going to go out on a
limb and propose a plan. Unless someone violently disagrees I'll start
implementing it.
1. Someone gives me plone.org manual area access
2. I upload collective.developermanual to
http://plone.org/documentation/manual/plone3/developer-manual
and delete the kb version.
3. I convert http://plone.org/documentation/manual/developer-manual
into reST and check into the collective. We create two branches called
plone3 and plone4. I setup nightly uploading script to sync both to
plone.org.
4. Mikko and Israel sit down and discuss chapter headings that take
the best of both manuals (and anyone else who wants to of course).
They raise some tickets about merging the two manuals.
5. Run a tuneup day maybe to help get the work done to do the merge
6. Turn off the old manual so only one exists on the manuals section
7. Publize it to the dev team and product developers lists. Give
examples on how existing code documetnation can be included or how and
where to edit new content for the manual
8. If after a few months the manual isn't awesome we re-evaluate.
---
Dylan Jay, Plone Solutions Manager
www.pretaweb.com
tel:[phone]
mob:[phone]
skype:dylan_jay

------------------------------------------------------------------------------

Post by Dylan Jay
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the

business

Post by Dylan Jay
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call

away.

Post by Dylan Jay
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

--
Veda Williams
Web Developer
Groundwire
206.286.1235x23
http://groundwire.org
ONE/Northwest is now Groundwire!
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

[Alexander Limi]

This sounds great!

Post by Dylan Jay
Hi,
I'm not sure where we're going in making a decision but there doesn't
seem to be too much variation in options so I'm going to go out on a
limb and propose a plan. Unless someone violently disagrees I'll start
implementing it.
1. Someone gives me plone.org manual area access
2. I upload collective.developermanual to
http://plone.org/documentation/manual/plone3/developer-manual
and delete the kb version.
3. I convert http://plone.org/documentation/manual/developer-manual
into reST and check into the collective. We create two branches called
plone3 and plone4. I setup nightly uploading script to sync both to
plone.org.
4. Mikko and Israel sit down and discuss chapter headings that take
the best of both manuals (and anyone else who wants to of course).
They raise some tickets about merging the two manuals.
5. Run a tuneup day maybe to help get the work done to do the merge
6. Turn off the old manual so only one exists on the manuals section
7. Publize it to the dev team and product developers lists. Give
examples on how existing code documetnation can be included or how and
where to edit new content for the manual
8. If after a few months the manual isn't awesome we re-evaluate.
---
Dylan Jay, Plone Solutions Manager
www.pretaweb.com
tel:[phone]
mob:[phone]
skype:dylan_jay
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the
business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

[Alex Clark]

Hi Dylan,

I may be missing something, but this sounds like moving in the wrong
direction to me. I'm pushing for "less code" on PloneOrg,
because it's not being managed properly IMO (too much
code outside core, too few active maintainers).

However I think c.developermanual is a great idea and I personally just
want to read it, so I have created (based on trunk):

http://collective-docs.plone.org/

I'm calling this an "experiment" to see if anyone else finds it useful.

If not, or if I have stepped on any toes, or if it confuses people let
me know and I'll remove it.

Alex

Post by Dylan Jay
Hi,
I'm not sure where we're going in making a decision but there doesn't
seem to be too much variation in options so I'm going to go out on a
limb and propose a plan. Unless someone violently disagrees I'll start
implementing it.
1. Someone gives me plone.org manual area access
2. I upload collective.developermanual to http://plone.org/documentation/manual/plone3/developer-manual
and delete the kb version.
3. I convert http://plone.org/documentation/manual/developer-manual
into reST and check into the collective. We create two branches called
plone3 and plone4. I setup nightly uploading script to sync both to
plone.org.
4. Mikko and Israel sit down and discuss chapter headings that take
the best of both manuals (and anyone else who wants to of course).
They raise some tickets about merging the two manuals.
5. Run a tuneup day maybe to help get the work done to do the merge
6. Turn off the old manual so only one exists on the manuals section
7. Publize it to the dev team and product developers lists. Give
examples on how existing code documetnation can be included or how and
where to edit new content for the manual
8. If after a few months the manual isn't awesome we re-evaluate.
---
Dylan Jay, Plone Solutions Manager
www.pretaweb.com
tel:[phone]
mob:[phone]
skype:dylan_jay
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com

[Dylan Jay]

Post by Alex Clark
Hi Dylan,
I may be missing something, but this sounds like moving in the wrong
direction to me. I'm pushing for "less code" on PloneOrg,

no new code. It's an offline converversion that can happen on another
server if need be and then uploaded via xmlrpc nightly.

Post by Alex Clark
because it's not being managed properly IMO (too much
code outside core, too few active maintainers).
However I think c.developermanual is a great idea and I personally just
http://collective-docs.plone.org/
I'm calling this an "experiment" to see if anyone else finds it useful.

Might just confuse the issue since the best place for the manual is
integrated into the manual section of plone.org. There is already a
mirror at http://plonemanual.twinapex.fi. Having another temporary
verison might lead to more future dead links.

Post by Alex Clark
If not, or if I have stepped on any toes, or if it confuses people let
me know and I'll remove it.
Alex

Post by Dylan Jay
Hi,
I'm not sure where we're going in making a decision but there doesn't
seem to be too much variation in options so I'm going to go out on a
limb and propose a plan. Unless someone violently disagrees I'll start
implementing it.
1. Someone gives me plone.org manual area access
2. I upload collective.developermanual to http://plone.org/documentation/manual/plone3/developer-manual
and delete the kb version.
3. I convert http://plone.org/documentation/manual/developer-manual
into reST and check into the collective. We create two branches called
plone3 and plone4. I setup nightly uploading script to sync both to
plone.org.
4. Mikko and Israel sit down and discuss chapter headings that take
the best of both manuals (and anyone else who wants to of course).
They raise some tickets about merging the two manuals.
5. Run a tuneup day maybe to help get the work done to do the merge
6. Turn off the old manual so only one exists on the manuals section
7. Publize it to the dev team and product developers lists. Give
examples on how existing code documetnation can be included or how and
where to edit new content for the manual
8. If after a few months the manual isn't awesome we re-evaluate.
---
Dylan Jay, Plone Solutions Manager
www.pretaweb.com
tel:[phone]
mob:[phone]
skype:dylan_jay
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com

--
Alex Clark · http://aclark.net
Author of Plone 3.3 Site Administration · http://aclark.net/plone-site-admin
------------------------------------------------------------------------------
Download Intel® Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

[Alex Clark]

Post by Dylan Jay

Post by Alex Clark
Hi Dylan,
I may be missing something, but this sounds like moving in the wrong
direction to me. I'm pushing for "less code" on PloneOrg,

no new code. It's an offline converversion that can happen on another
server if need be and then uploaded via xmlrpc nightly.

Ah OK, so no change to PHC then. Do you have the access you need? Do we
have an up to date description of "doc team" procedures anywhere? I see:
http://plone.org/documentation/kb/creating-documentation-for-plone.org
But that doesn't say much. I can give people access, but I'm never
sure when I should do so (i.e. who is currently driving this ship?)
I guess I just hate to see this project stalling, and the documentation
front page looking like crap for months on end ;-) E.g.
http://plone.org/documentation

Post by Dylan Jay

Post by Alex Clark
because it's not being managed properly IMO (too much
code outside core, too few active maintainers).
However I think c.developermanual is a great idea and I personally just
http://collective-docs.plone.org/
I'm calling this an "experiment" to see if anyone else finds it useful.

Might just confuse the issue since the best place for the manual is
integrated into the manual section of plone.org. There is already a
mirror at http://plonemanual.twinapex.fi. Having another temporary
verison might lead to more future dead links.

True, maybe I'll just do a redirect from collective-docs to
http://plonemanual.twinapex.fi …

Post by Dylan Jay

Post by Alex Clark
If not, or if I have stepped on any toes, or if it confuses people let
me know and I'll remove it.
Alex

Post by Dylan Jay
Hi,
I'm not sure where we're going in making a decision but there doesn't
seem to be too much variation in options so I'm going to go out on a
limb and propose a plan. Unless someone violently disagrees I'll start
implementing it.
1. Someone gives me plone.org manual area access
2. I upload collective.developermanual to http://plone.org/documentation/manual/plone3/developer-manual
and delete the kb version.
3. I convert http://plone.org/documentation/manual/developer-manual
into reST and check into the collective. We create two branches called
plone3 and plone4. I setup nightly uploading script to sync both to
plone.org.
4. Mikko and Israel sit down and discuss chapter headings that take
the best of both manuals (and anyone else who wants to of course).
They raise some tickets about merging the two manuals.
5. Run a tuneup day maybe to help get the work done to do the merge
6. Turn off the old manual so only one exists on the manuals section
7. Publize it to the dev team and product developers lists. Give
examples on how existing code documetnation can be included or how and
where to edit new content for the manual
8. If after a few months the manual isn't awesome we re-evaluate.
---
Dylan Jay, Plone Solutions Manager
www.pretaweb.com
tel:[phone]
mob:[phone]
skype:dylan_jay
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com

--
Alex Clark · http://aclark.net
Author of Plone 3.3 Site Administration · http://aclark.net/plone-site-admin
------------------------------------------------------------------------------
Download Intel® Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

------------------------------------------------------------------------------
Download Intel® Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev