Problem/Motivation
We are currently showing the "original author" in the header of all Documentation pages. However:
- The displayed "original author" changes over time. For instance, when this issue was filed, https://drupal.org/node/310075 said that Xano was the original author, but it currently shows Crell as the original author. It's not really clear who was the original author, but... something is going wrong there.
- In many cases the "original author" only created a placeholder and doesn't deserve any more credit than other people who revised the page.
Proposed resolution
Remove the display of the original author. Just show the most recent revision authors, as we are now in the line below.
Remaining tasks
Write a patch for the drupalorg module. The code is in: http://cgit.drupalcode.org/drupalorg/tree/drupalorg_handbook/drupalorg_h...
User interface changes
Original node author will not be shown for documentation pages.
API changes
None.
Original report by batigolix
Currently the original author of a docs page is shown in the header of the page. In some cases the wrong author is shown. In other cases it is a bit too much honour because the original author was the one that only created the placeholder.
I would like to propose to remove the original author.
See the example of https://drupal.org/node/310075:
Dynamic queries
Last updated January 21, 2013. Created by Xano on September 18, 2008.
Edited by klausi, drupalshrek, jthorson, Crell. You can edit this page, too.Dynamic queries refer to queries that are built dynamically by Drupal rather than provided as an explicit query string. All Insert, Update, Delete, and Merge quer .....
Here the user "Xano" is given the credit of having written this page. But in reality this user only changed one letter:
https://drupal.org/node/310075/revisions?page=1
https://drupal.org/node/310075/revisions/view/358335/374959
Comment | File | Size | Author |
---|---|---|---|
#12 | 2017673-remove-orig-author-display.patch | 1.17 KB | jhodgdon |
Comments
Comment #1
batigolixSame problem here:
https://drupal.org/node/310086/revisions
Not the original author is shown but someone who made a small change
Comment #2
LeeHunter CreditAttribution: LeeHunter commentedI'd actually like to remove the author information completely as per #1946268: Rethink the documentation UI.
Or if we keep it, push it down below the content that people came to see.
Comment #3
batigolixMaybe we can take a small step towards a new documentation UI by changing the current author&date information to:
1. Above the title: "Edit this page" - button/tab/link (no preference). Basically leaving the current tabs (View, edit, revision/history) as they are, but maybe renaming the Edit button.
2. Below the content:
"Last updated January 21, 2013. [Edit this page]".
Comment #4
MGParisi CreditAttribution: MGParisi commentedThe author & date is no longer displayed. Probably removed during the upgrade to d7.Edit: The Author & date is shown, example https://drupal.org/node/310075
Is this issue still upto date? I look at the links and they show Crell the original author.
Comment #5
batigolixYes, I think it is still up to date. I changed the author to the original.
Let me find an example where this problem is occurring.
Comment #6
batigolixOk, here is an example:
According to the revisions list (https://drupal.org/node/310086/revisions) this document (https://drupal.org/node/310086) was written by Crell, but solotandem is credited as author, although she/he really only made 2 small changes (https://drupal.org/node/310086/revisions/view/401467/430960).
Comment #7
jhodgdonThis is actually a bug. Not sure what is going on.
Comment #8
Steven Jones CreditAttribution: Steven Jones commentedMaybe not a bug as such, https://drupal.org/node/310086 has an author of 'solotandem', not Crell, so it looks like it's just that the author on the node doesn't match up to the author of the first revision.
Maybe something just got corrupted along the way, or there was a bug at some point, but there doesn't look to be much we can do here without going through all nodes, and comparing author to the first revision and making updates.
Comment #9
batigolixMoving this to drupal.org for feedback
Comment #10
jhodgdonComment #11
drummIt sounds like we want to remove this, updating the title.
I recommend not worrying about the seemingly-inconsistent data. If I recall correctly, D6 would overwrite the node table's uid; this was noticed quite a bit for issue nodes. And the issue is removing it anyway.
The code that renders this on documentation pages is at http://cgit.drupalcode.org/drupalorg/tree/drupalorg_handbook/drupalorg_h...
Comment #12
jhodgdonGreat, I made an issue summary as well. It looks like D7 is also causing problems -- since this original report, the page that was used as an example has a different "original author" shown.
Here is an untested patch to do this. We'll need to try it out on a dev site. What it does is:
- Remove the "orginal author" section on the first line
- Make it so that the revision editor list can include the person who is currently listed as the "original" author, so we should have the most recent 4 revision authors shown.
To test:
- Apply this on a dev site
- Cross-check a few pages: the display of "Edited by" should match the most recent 4 authors of revisions if you go to the Revisions tab on the page.
Comment #13
jhodgdonOK, I applied this patch to the docs_manage dev site, which was still active.
It looks like the dev sites do not have node revisions in their databases, which made this a bit difficult to test properly, but I logged in as bacon and made a revision on this page:
https://docs_manage-drupal.redesign.devdrupal.org/documentation/modules/...
and both the original author (as shown by the Revisions log on the dev site) and bacon are now showing up in the "Edited by" list.
So I think this patch is probably fine. I'll take the liberty of marking it RTBC; it's pretty simple.
Comment #14
jhodgdonFurther testing: I used drush uli on the dev site to log in as user 1 (Dries) and then as myself, and then as drumm, and made further revisions with all 3 of these users.
The page is now showing:
Last updated October 6, 2014. Created on May 30, 2009.
Edited by drumm, jhodgdon, Dries, bacon. You can edit this page, too.
So this is working correctly -- those are the last 4 edits. During the process I checked and at each step the last 4 (or less) were showing (including the original author).
So I think it is fine.
Comment #16
drummI also committed an update to the comment.
Comment #17
drummNow deployed on Drupal.org.
Comment #18
jhodgdonThanks!
Comment #19
mitchell CreditAttribution: mitchell commentedPlease re-analyze this.
These two scenarios are not the same.
Both of these problems deserve a solution. A wholesale removal of original authors is an expedient path around both and runs over people like me.
Comment #20
jhodgdonYou have not lost any honor -- the record of your work is still in the Revisions tab, as well as on your user profile in the "Your posts" tab.
There are other reasons for the Documentation Working Group deciding to make this change, and I'm sorry that we didn't articulate them well in this issue. Keep in mind that this is the *community documentation* section. We are continually having trouble with people not being willing to edit pages, so we want to emphasize that no one "owns" pages, and that everyone is encouraged to edit them. We also don't really want to encourage people to create even more pages than we already have -- we'd rather have them edit existing pages than create more spaghetti. So, we thought hard about this -- the concerns listed here were not the only ones we considered.
Comment #21
mitchell CreditAttribution: mitchell commentedHmm... So, in 2014, this project's approach toward improving its UI and user encouragement is for, on occasion, those who work most on a community's document to only have a mention tucked away in a revisions tab (with no assurance of accuracy), instead of among each of its contributors, as well as somewhere on an unspecified page listing everything else they did. 'Fixed'?
Comment #22
YesCT CreditAttribution: YesCT commentedwould #2332855: Maintainership for Documentation pages and sections help?
Comment #23
mitchell CreditAttribution: mitchell commentedCathy, that seems like it would help ongoing work. This case seems more about an accurate portrayal of work in any time period. I believe these two issues would help improve UI/UX, what do you think?: #2357059: Mention all contributors in handbooks & #2357045: Restore original node authors.