[documentation] Improving help pages in D7

[Ariane Khachatourians]

When it comes down to it, the issue of how the text is edited is really an
entirely different discussion than how to restructure the help content.

At the risk of sounding like a broken record, the timeline is much too short
for this issue (we have just over 2 weeks) to change the way the help
documentation works - I'm sure if you want to sign up to rewrite help text
for a module with the new format, and post it as a comment, someone else can
put it into the PHP code and roll the patch.

But to be honest, like Jennifer said on the other thread that was started on
barriers to contributing, there are many other really useful places you can
help that do not require going into the code or rolling patches. She put
several examples in her reply that I think are worth going through if you
want to help out more!

Ariane




On Sat, Nov 14, 2009 at 5:06 AM, adept digital evolution
<techlists at ade.pt>wrote:

>
> I have to agree. There should be an easier way to participate for
> non-developers who, like myself, know nothing of CVS systems or patches
> or php, and who do not have time or inclination to learn that end of
> things, but who (also like myself) might be quite good at helping to
> author and organize good help documentation.
>
> I've pretty much given up on helping with docs because I click links
> from this discussion list to look at an issue, and then have absolutely
> no idea what to do. It looks like I'd have to know php, to know how to
> check out items from some repository somewhere (where?), how to write
> something called a "patch", how to test it, and so on. This is just not
> my profession. The whole approach pretty much freezes just regular old
> consultants and writers from your process.
>
> I had done much work on  he D7 install guide (the online version) and
> therefore offered to also review the install.txt document that gets
> included with the downloaded installer , but for some reason this is
> much more complicated than just editing a text document. I didn't know
> where to get it or what the heck to do with it. I used up my time trying
> to figure all that out without ever even finding it.
>
> I will continue to edit any d.o doc pages that I might have priv's to
> edit. But I hope some day editing help text is as easy as editing
> anything on d.o
>
> kazar
>
>
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.drupal.org/pipermail/documentation/attachments/20091114/1719ad25/attachment.html