One of the consequences to Drupal's rapid development cycles is dealing with the need to constantly change documentation. There may be big ideas afoot as to how to deal with that... but...
A small idea to help end users some, would be to add a "date updated" timestamp to the presentation of the handbook node. Ideally, in Wiki style, when a page is updated by its author there would be a "minor edit" checkbox so as to leave the "date updated" field untouched in the case of typo or other small corrections made.
I have found, over time, that the date fields connected to module commits helps me big time in assessing the status of a module (obviously together with other data).
I know that sometimes a simple idea is hard to implement for various reasons, but I thought I'd put it out there.
Shai
Comments
Comment #1
webchickOne simple fix for this would be to simply enable 'view revisions' permissions for authenticated/anonymous users. This would have this information, along with the author who changed it, as well as logs about why (if the person had the foresight to enter them).
Any objections?
Comment #2
webchickAdjusting title.
Based on discussions in http://drupal.org/node/183926 this appears to be the functionality that's suggested, and would meet both use cases.
Comment #3
sepeck commentedView revisions would be across all content nodes of the site. Handbook pages, forum topics, project descriptions.....
It is already enabled for the Documentation role. Would this really be helpful for the rest of the population?
Comment #4
Shai commentedSteve, I do really think it makes a big difference. As of yesterday I'm part of the documentation team and so I have can see revisions; it's awesome.
I can imagine that once one has those permissions its easy to forget about how the site feels without it.
I think one of the best things about Drupal is its transparency -- the ability to see revisions would significantly add to that.
Another way to ask the question is, what are the potential downsides? Why wouldn't we want to do this?
Shai
Comment #5
sepeck commentedPotential downsides are performance. I will have to check with killes to see what his thoughts are on this aspect. If there are no issues from his perspective I am will to enable visibility for authenticated users. If anonymous users cannot be bothered to create an account then I am not so worried about them as this would be a 'benefit' of creating an account.
Still not sold on 'benefits' presented so far. The vast majority of updates are typo's and verbiage fixes.
As this is a web site change to permissions, moving to webmasters queue.
Steven
Comment #6
webchickThe main benefits as I see it are:
- Easy to tell when the last time a document was updated and by whom. Useful for evaulating whether or not information might be out of date.
- Easy to tell when the document was initially created and by whom. Useful for tracking down "why" information about specific changes.
- Easy to tell at a glance whether this document has seen major restructural changes, or whether it's mostly been minor typos and that kind of thing. Much *more* useful when we have diff module installed on drupal.org.
- With this tab being visible to everyone, makes people more cognisant of putting in a log message (maybe).
I'm not sure that there would be huge performance concerns, as the revisions are stored anyway; it's just a matter of displaying them. But Gerhard would know.
The only downside I can think of is there's a lot less of a point in enabling this tab when we don't have diff module installed, but this could be an incremental improvement.
Comment #7
killes@www.drop.org commentedI am in favour of allowing authenticated users see the revisision, but not anonymous users.
We can always switch them off again.
Comment #8
sepeck commentedDone.
Comment #9
webchickWell that was easy. ;) Thanks, guys! :D
Comment #10
Shai commentedAwesome! I totally agree on limiting this to authenticated users.
Mucho gracias!
Comment #11
sepeck commentedSo, now that we have a 'why', Can anyone think of a way to determine that the outcome is a success?
Comment #12
dwwWhat about diff.module?
- Runs on at least g.d.o, infra.d.o, and sec.d.o, probably ass.d.o, too.
- Hugely useful, e.g. to see what someone changed.
- Integrates seemlessly with the revisions tab.
- Co-maintained by moshe and myself -- not exactly the most slacker of all slacking contrib maintaining duos.
Any objections, killes?
Thanks,
-Derek
p.s. I just made forum posts, newsletters, stories, and pages default to making new revisions at http://drupal.org/admin/content/types -- books and projects were already configured that way.
Comment #13
dwwOh, and I noticed over at http://drupal.org/node/183926 someone mentioned the only possible hold up for diff.module is that it needs a review by the security team. Uhh, moshe and I are both on the security team, and we're the maintainers. ;) Believe me, we've audited closely...
Comment #14
heine commentedI've reviewed diff.module and I believe its ok.
Comment #15
webchickActually, could we please *not* enable revisions by default on Forum topics (at least)? I want to make a core patch that makes the log field required on nodes that have that option turned on by default (so that people actually fill out the dang thing), and it doesn't make any sense with forum topics, as only 1/2000000000000 will actually need that level of control.
Or if you'd rather we wait until a) such a patch exists, b) it's applied to 6.x, and c) it's deployed on drupal.org, that works too. :P I guess I just don't get the point of it on forum topics, really. Those are by nature not updated over time by multiple people, but rather posted once and then left alone.
Comment #16
webchickStories fall under that umbrella too (i didn't even realize we had those enabled for people), and newsletters you could claim do as well, but those are for important announcements, so revisions make sense.
Comment #17
Shai commentedI agree with Angie that revision and diff are not needed for forum posts.
Regarding Steve's question about, "How will we know if this was a good idea?"
Some ideas:
All this, of course, only gives a general sense, unless these or other metrics were done previously when functionality on d.o. changed.
I think it is always helpful to know what resonates with people and what they like and dislike. I do think though that, for an open source project, the most pervasive question should be "what critical benefit does the project gain from keeping people away from x piece of information or y functionality?" as opposed to "why would we want to provide this for folks?"
Comment #18
dwwOk, sure, reverted forum posts. However, diff/revisions only help anything if people make revisions (even without a log field). Lots of the important front-page posts are in fact forum posts, so it'd be nice that people were conscious of that and made revisions whenever they promote something, or edit something on the fp, etc.
In the future, it'd be very nice to remember "create new revision" on a node, so that once it's selected once, it defaults to on again until someone unselects it... but I digress.
Heine reviewed diff.module and agreed. So, on it goes. ;)
Yay!
Comment #19
gábor hojtsyUnfortunately or not by design, we are posting front page posts as forum topic in the news and announcements forum for quite some time now. That said, we are "misusing" forums to some degree, and indeed, default revisioning for forums might not be a good idea. But remembering the revision checkbox state is a long time wishlist item (for me at least :), so I wholeheartedly agree that it should be tackled.
Comment #20
(not verified) commented