On 3/8/08, Christopher Arndt <[EMAIL PROTECTED]> wrote:
(I hope you don't mind if I take this discussion to the docs ML,
I'm
sure, this is interesting for others as well.)
No. In fact I tried to cc the list on the first message to you, but
messed up.
In theory, every document that can be edited by non-editors,
should be
labelled as "Freely editable".
Then I propose just throwing that tag out since it is redundant with
the Wiki edit button, it will serve mostly just to confuse people
(like me) when the button doesn't match the typed in tag, which, right
now, is most of the time.
The document status flags were never really formalized, and usage
has
evolved over time. Thats why their application certainly lacks
consistency.
Then is sounds like they are due for being revisited. I have some
thoughts. To start with, the tag "awaiting anything" sounds awefully
passive to me. It makes it sound like something is happening when it
isn't. How about "requires" instead of "awaiting"? It is more
suggestive to whoever is reading that they can do something about
it... even if it is just to bug someone.
Here are some suggestions for the whole sequence, in progressive
order:
1. work in progress (author still working)
2. submitted for review (Trac ticket has actually been opened)
3. ready to place (reviewed/approved and ready for promotion to
somewhere on the main docs page TOC)
4. (something to indicate a doc that went through this process.
"official", "vetted" or how about just "Approved Doc 1.0 Mar-2008".
You know what might also be useful next to the status would be a date
of when the most recent review took place. That would help a reader
recognize a doc that is current, or likely been abandoned. Small edits
can make the history appear more recent than it really is. And it
might facilitate a crawler script that alerts to old documents?
Also, status flags could be linked to a legend of what they mean.. or
link to a page describing the whole edit process, which is kind of the
same thing in more detail.
I would discard official, unofficial, contributed tags. They don't
seem to mean much anymore.
> >Why submit diff files
> it would be easier for me to apply a patch than going through your manual
> notes in a trac ticket.
Oh Ok. I get it now. That actually sounds like a good plan for now. I
don't anticipate being a TG long termer. (I don't even know how to use
it yet.) Mainly, I can help with intro docs, organization, and English
editing. Using diffs would also make me feel a little less worried
about trying new rewrites now and then since I would know someone else
will still get to idiot check it before it's posted. I would also feel
more like I'm helping with the effort than just giving you more work
to do.
Andy
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"TurboGears Docs" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/turbogears-docs?hl=en
-~----------~----~----~----~------~----~------~--~---
