Making WordPress.org

Opened 3 years ago

Last modified 2 months ago

#2082 new enhancement

Enable revisions on the front end for DevHub/HelpHub/Handbook pages

Reported by: atachibana Owned by:
Milestone: Priority: low
Component: HelpHub Keywords: 2nd-opinion


Each article in DevHub, HelpHub and Handbook should have revision page so that both general readers and editors can refer the previous versions and distinguish the recent updates or differences of it.

'History' function of Codex must be the good starting point of discussion:
ex) https://codex.wordpress.org/index.php?title=Version_4.6&action=history

This function is also useful handbook translators. They will update their materials by 'diff' of past revision and the latest one.

Attachments (1)

codex-diff.png (64.0 KB) - added by Nao 3 months ago.
Diff link displayed at the bottom of https://wpdocs.osdn.jp/The_Loop

Download all attachments as: .zip

Change History (9)

#1 @netweb
3 years ago

  • Summary changed from DevHub/HelpHub/Handbook should have revisison page per article as like as Codex history page. to Enable revisions on the front end for DevHub/HelpHub/Handbook pages

Thanks for creating the ticket @atachibana

Personally I see a good use case for revisions with regard to WordPress' coding standards handbook pages.

For example, if having read a particular coding standard and you then later discover or are informed that what you originally had read and thought to understand to be correct is no longer the case as that standard has since been updated.

Being able to use what is currently available in the back end (to those with access) is to browse the handbook page revisions, this would be beneficial to all users on the front end (without back end access) to perform that same functionality in that having a way to browse and compare the revisions of what are for the most part still evolving document/handbook pages I believe would be beneficial for users to "discover what's new" to the coding standards.

#2 @netweb
3 years ago

Related: #1504 - Improve functionality surrounding comment examples in the developer reference

  • Adding revisions to users edited contributor notes on devhub is another potential example of helpful revisions

#3 @Kenshino
3 years ago

  • Component changed from Handbooks to Support Hub
  • Priority changed from normal to low

So I discussed this with @sam, sounds like a great plugin to be built for v2 of Helphub.

Let's KIV this.

Version 0, edited 3 years ago by Kenshino (next)

#4 @tellyworth
10 months ago

  • Keywords 2nd-opinion added

Is there a plugin or proof of concept that would implement something like this?

#5 follow-up: @dd32
10 months ago

Just noting the two plugins I found for public post revisions:

#6 @Nao
3 months ago

Now that HelpHub plugin is enabled on https://ja.wordpress.org/ , I feel the most needed (yet missing) feature is this revision comparison.

On Codex, we were able to compare the current doc with the point where the previous translation was made by noting the revision number.


Ideally, we'd like to be able to see the revision history of HelpHub docs on front-end using a similar URL.
Showing revision history is beneficial to English users as well.

P.S. Found an old partially related core ticket: https://core.trac.wordpress.org/ticket/38368

Last edited 3 months ago by Nao (previous) (diff)

3 months ago

Diff link displayed at the bottom of https://wpdocs.osdn.jp/The_Loop

#7 in reply to: ↑ 5 @Nao
3 months ago

Replying to dd32:

Just noting the two plugins I found for public post revisions:

The second one by Elio works now, he said (he just updated it). Any possibility of making use something like that?
I really hope this feature to be there when more teams start migrating/translating so that they can keep track of the changes.

This ticket was mentioned in Slack in #docs by nao. View the logs.

2 months ago

Note: See TracTickets for help on using tickets.