-
December '08 Migration Planning Session
last modified December 10, 2008 by vedawms
Weekend planning in Seattle with Alexander Limi, Steve McMahon, Jon Stahl, Sam Knox and Veda Williams
Clarification on the Way Forward
- We are still dependent on the 3.0 migration of Plone.org, due to happen over the winter holiday.
- Deliverables will be determined and scheduled by SteveM and Veda, with the assumption that the migration goes smoothly.
- Docs will be split into a quickstart, a manual, and a separate open-edit section to be known as the Knowledgebase or "tips and tricks".
- We need to be clear that all docs are community docs, not just the KB docs.
How the KB Area Will Work
- KB docs will be editable by anyone with a plone.org login.
- Docs can be published immediately.
- Any docs that are edited will have a note sent to the author.
- Need to be conscious of spambots and come up with a plan for this.
- The KB will be part of the main navigation for Documentation section.
- Docs will only be grouped into major categories, not into subcategories.
- No real branding effort will be launched here.
How the Official Documentation Section Will Work
- We will use iterate. This means that when a user wants to make an edit to the KB docs, they will get a "staged" version of the document. Upon saving it, the documentation team will get a notification that the manual has been forked.
- Only documentation team editors will be able to delete documentation.
- Home page of docs section should show most recent tips and tricks and their main section.
- Within each section we will have static portlets to highlight things like books that are relevant, external resources, special announcements, etc.
- Docs will be filtered by version. Older docs will only be found if you search for them specifically.
- Section assessments need to be reviewed to determine which docs will be part of manuals, which will be part of a quickstart, and which will be released into the KB.
- Tutorials will be part of manuals, assuming they are of good quality. Maybe manuals will have a specific section for tutorials? Need to be aware of a natural flow and leave this up to the editors to handle.
- Need an interim design for the official docs area. Veda and Alexander Limi to work on this.
Thoughts on Migration and Additional Functionality
- KB docs will live on plone.org, to ease migration woes. Initially, both sections will share the same top-level navigation, but they will diverge over time.
- Where documents are integrated into plone.org manuals and then deleted, an automatic URL redirect will point to the manual. Need to be able to choose the URL.
- Content types: will be radically simplified. SteveM and Veda to work on this.
- Content types will be able to be used outside of PHC.
- Need to run a script to sniff out which documents show which docs appear in multiple sections. These will need to be restricted to a single section before the migration happens.
- Run a script to sniff out docs with comments so we don't lose any that might have value.
- Need to capture contributors and versions. Contributors should be captured automatically.
- Search widget for Plone.org will split out official docs vs. KB docs, much in the way that apple.com splits out their livesearch. Actual search will return only official docs.
- Comments will be removed and replaced with a link to Trac. We need to capture these comments in some cases and should put this on the schedule.
- Current members of the Documentation Team will be flushed. Editors will remain on the list. Contributors can be handled via iterate.
- We will make our changes and provide a migration script for users of PHC.
- When the migration happens, it will be done by hand. Plone.org will be put in maintenance mode. We have to do it on the live data.fs so that URL redirects happen properly. SteveM will get us a mountpoint so that we're dealing with a smaller data.fs. (Will this be necessary if we're doing this live?)
Legal Issues
- Need to get the docs classified as CC. Jon Stahl to do Foundation Board legwork here. Might be some functional questions here -- terms of agreement popup the next time someone logs in. We will steal from Wordpress on their terms of agreement doc. If a person does not sign the SA, the doc disappears.
- Docs will be moderated quietly, e.g. we will not promise to review and eradicate all instances of abuse. In the event that we fail to do so, we become liable.
- For documents with multiple contributors, we need to evaluate the quality of the document and ask the OWNER of the document to sign the terms of agreement. We're just looking to provide good intent.
Next Steps
- Veda and SteveM to work on a schedule for the migration and identify human resources to assist.
- Veda and SteveM to put together a complete list of technical concerns, content rules, notifications, etc.
- Veda and Alexander Limi to work on an interim design.
- Jon Stahl to work on the Creative Commons licensing and communicate with the Foundation Board.
- Joanna to cat-herd editors into identifying which docs should be part of the manual, which should be part of a quickstart guide, and which should be released into the KB.
- Joanna to work with editors to brainstorm what items might be good as contextual portlets for each section.
- Joanna to find a home for documentation like "how to contribute to plone.org" that doesn't fit neatly into the documentation area.