Addison Berry
2009-03-15 12:38:40 UTC
add1sun has posted a Discussion at http://groups.drupal.org/node/20127
New documentation module (proof of concept)
---------------
There has been a small group of people looking at how to use
Advanced help in Drupal 6 (and the new help system in Drupal 7) to
add documentation about Drupal right into a site. Last week Adam
Moore (redndahead) and a small team of sprinters worked on
screenshot madness with the idea that we will eventually get this
sorted out. I have had a proof of concept module sitting around for
a while on my desktop and now that we really seem to be getting
momentum, and I inexplicably woke up at 3:30 am this morning, I
finally gave it a good look over, changed some stuff and committed a
very, very barebones module to CVS. This should let people be able
to play with the concept on their own sites to make it more real
while we figure out exactly how we want to organize it, standards we
need, etc. It also gives us something tangible to make patches for
and use for testing out other advanced things we need to do, like
syncing it with Drupal.org handbook pages. So, here are the
1. We have a new component in the Documentation issue queue, called
Documentation module, to use for all issues about the module.
2. I will not make an official release for this, but since I know
many docs folks are not going to grab this directly from CVS, I have
made a dev snapshot tarball we can use for playing to help
discussion - http://drupal.org/node/402496. (For CVS users, the
module is currently in HEAD, contributions/modules/documentation.)
3. The code is for Drupal 6 and requires the Advanced help module.
Instructions here (for now): http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/documentati
...
4. Yes, this is code in CVS. Changes can only be made with patches
and I'm the only person with commit access right now (well, except
Dries ;-)). Most of the work on this for now will be discussion as
we figure out how to set things up. When we get to actually filling
out docs we will look at how that will happen and who can do it.
5. We're not gonna go nuts filling out the docs just yet. It doesn't
sync with Drupal.org yet and until we get a better temperature on
the likelihood of that I'd hate to do tons of duplicative work.
1. What should be in the documentation module? We aren't going to be
able to put the whole handbook in there. We should start small and
focused and add as we go. For now, I have starter pages for cron,
upgrading and terminology (these aren't even complete pages - I just
grabbed the text from the existing top-level handbook pages).
2. How do we want to organize this? We can have a master docs module
that has sub-modules for various sections if we want. This would
allow us to have different top-level sections rather than everything
under "documentation." It wold also allow admins to turn off
sections they don't want for whatever reason.
3. What "special" standards do we need to create that are different
or above and beyond the current spanky, new style guide for the D.o
handbooks?
4. I'm sure there are other thoughts, concerns and topics out there
too. Feel free to get the discussion going - either on the mailing
list (where this will also be posted) or the issue queue, using the
new Documentation module component.
--New documentation module (proof of concept)
---------------
There has been a small group of people looking at how to use
Advanced help in Drupal 6 (and the new help system in Drupal 7) to
add documentation about Drupal right into a site. Last week Adam
Moore (redndahead) and a small team of sprinters worked on
screenshot madness with the idea that we will eventually get this
sorted out. I have had a proof of concept module sitting around for
a while on my desktop and now that we really seem to be getting
momentum, and I inexplicably woke up at 3:30 am this morning, I
finally gave it a good look over, changed some stuff and committed a
very, very barebones module to CVS. This should let people be able
to play with the concept on their own sites to make it more real
while we figure out exactly how we want to organize it, standards we
need, etc. It also gives us something tangible to make patches for
and use for testing out other advanced things we need to do, like
syncing it with Drupal.org handbook pages. So, here are the
1. We have a new component in the Documentation issue queue, called
Documentation module, to use for all issues about the module.
2. I will not make an official release for this, but since I know
many docs folks are not going to grab this directly from CVS, I have
made a dev snapshot tarball we can use for playing to help
discussion - http://drupal.org/node/402496. (For CVS users, the
module is currently in HEAD, contributions/modules/documentation.)
3. The code is for Drupal 6 and requires the Advanced help module.
Instructions here (for now): http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/documentati
...
4. Yes, this is code in CVS. Changes can only be made with patches
and I'm the only person with commit access right now (well, except
Dries ;-)). Most of the work on this for now will be discussion as
we figure out how to set things up. When we get to actually filling
out docs we will look at how that will happen and who can do it.
5. We're not gonna go nuts filling out the docs just yet. It doesn't
sync with Drupal.org yet and until we get a better temperature on
the likelihood of that I'd hate to do tons of duplicative work.
1. What should be in the documentation module? We aren't going to be
able to put the whole handbook in there. We should start small and
focused and add as we go. For now, I have starter pages for cron,
upgrading and terminology (these aren't even complete pages - I just
grabbed the text from the existing top-level handbook pages).
2. How do we want to organize this? We can have a master docs module
that has sub-modules for various sections if we want. This would
allow us to have different top-level sections rather than everything
under "documentation." It wold also allow admins to turn off
sections they don't want for whatever reason.
3. What "special" standards do we need to create that are different
or above and beyond the current spanky, new style guide for the D.o
handbooks?
4. I'm sure there are other thoughts, concerns and topics out there
too. Feel free to get the discussion going - either on the mailing
list (where this will also be posted) or the issue queue, using the
new Documentation module component.
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/