Hi Andy (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.)
Andrew Brown schrieb: > If you didn't already infer from above, documents status flags need to > be explained too. The document status flags were never really formalized, and usage has evolved over time. Thats why their application certainly lacks consistency. > I don't understand yet, for example: > Why some docs are marked "Freely Editable" even though many docs are > not write protected. In theory, every document that can be edited by non-editors, should be labelled as "Freely editable". > What is the difference between Draft and Waiting for Approval No difference. Both mean that a documents waits for review/approval. We could consider distinguishing both cases by using the labels "Waits for review" and "Waits for approval" instead, but we have no fixed guidelines for the transition between those states yet. > Why mark a doc "contributed"? Aren't all documents contributed? That's probably a historic thing. The original "Official" documents grew out of a set of static docuemnts, originally published o the website and created by a well-defined group of authers. Since we don't have that well-defined author group anymore, the distinction may make not much sense anymore. See also below. > What are "unofficial" documents? I have found very few. IMO, "Unofficial" docs are very similar to "Contributed". One could argue that "Contributed" documents may become "Official" at some point but "Unofficial" should stay unoffial. But that distinction is hard to maintain in practice. > Chris wrote: >> * I you want, I can grant you wiki editor privileges, so you can edit >> official pages. >> * If you find typos in non-official docs, please correct them directly. >> No need to open a ticket. >> > Sure. Sounds good. I will try not to screw anything up too badly. > I am comfortable doing small cleaning. If I find something in to > official docs that could stand to be worded differently or whatever, I'm > not confident yet on the procedure for that as per conversation above. It's meant as an offer. If you want editor privileges, that would mean a certain commitment to help looking after the documentation over a longer period. If you rather say that you just want to work on one or two documents for a limited time, we can find other ways to give you write access to those, but then you would probably have to ask me to grant you more permissions from time to time. It's up to you how far you want to get involved. We're certainly happy about everybody who wants to help out! > I "can" attach the diff, or I "should" attach the diff? I am not > actually clear yet on why this helps? Would this be in addition to > changing it using the wiki editor? Is a diff easier for humans to read > than using the wiki diff tool? This was meant for the case you didn't want wiki editor privileges and wanted to submit changes to an official document (which you wouldn't be able to edit then). In that case, it would be easier for me to apply a patch than going through your manual notes in a trac ticket. Chris --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
