Re: Plone 3.2 User Manual Update
"Jeff Pittman" <[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.documentation |
|---|---|
| Message-ID | <[email protected]> |
Also, at a recent sprint, there was an exploration of automation for screen captures for the user manual and other documentation needs. Brandon Rhodes and I looked at windmill (http://pypi.python.org/pypi/windmill/) briefly for the task, and noted that there are several ways this could be done. Automation of screen captures is very interesting, and would be a good fit for a maintenance of a python/filesystem approach. Jeff Pittman http://www.geojeff.org On Sat, Dec 20, 2008 at 11:21 AM, Jeff Pittman <[email protected]> wrote: > The manual could be divided into its sections, storing the versions of the > sections by Plone version applicability, then having one single user manual > with a menu choice of which version to view. The sections shown for a view > of the user manual would be a best fit for the requested version, > accordingly. With each Plone release, sections would need to be > marked/updated. This is really how it should be done. Advice and ideas are > appreciated. One attractive possibility is to maintain the user manual in > straight python and directories/docs/images on the filesystem. > > I will, of course, coordinate with Sam and anyone else interested in the > user manual. > > Jeff > > Jeff Pittman > http://www.geojeff.org > > > On Sat, Dec 20, 2008 at 10:43 AM, JoAnna Springsteen <[email protected]>wrote: > >> I would really really like to avoid having a 3.0 manual and a 3.2 >> manual and then a 3.5 manual and then a 3.7 manual etc. I think that's >> overkill. >> That being said, updating the 3.0 manual isn't an issue. Just be >> careful to specific if something applies to 3.0 or 3.2 specifically. >> We can continue our pattern and create a new manual for 3.5. For now >> work with what exists. >> Also, I know Sam had some updates he wanted to make, not sure if he >> has started on them. Be sure to coordinate with Sam before starting on >> anything. >> >> >> On Sat, Dec 20, 2008 at 4:50 AM, Jeff Pittman <[email protected]> >> wrote: >> > I am interested in working on a Plone 3.2 version of the user manual. >> One >> > way of doing it is to copy the 3.0 version (manual content type in PHC), >> > then modifying in place for 3.2. That's what we did when we made a 3.0 >> > manual from the 2.5 version. Steve, iirc, you did something special to >> copy >> > it? >> > >> > New screen captures, updated text, and replacement screencasts will be >> > needed. >> > >> > The screencasts are stored outside of the manual, on Plone's media >> server. I >> > have Screenflow for making screencasts, and I think these are really >> > important to weave into the user manual, even more than we did for the >> > previous versions. Sam, I've been meaning to ask you about your current >> > screencast-making routine -- Veda mentioned jing... >> > >> > Jeff >> > >> > Jeff Pittman >> > http://www.geojeff.org >> > >> > >> ------------------------------------------------------------------------------ >> > >> > _______________________________________________ >> > Plone-docs mailing list >> > [email protected] >> > https://lists.sourceforge.net/lists/listinfo/plone-docs >> > >> > >> > > ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/plone-docs