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

[atachibana]

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.

[netweb]

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.

[netweb]

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

[Kenshino]

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

Let's KIV this.

[tellyworth]

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

[dd32]

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

• ​https://wordpress.org/plugins/post-revision-display/ (long outdated and closed)
• ​https://github.com/eliorivero/revview (old POC plugin?)

[Nao]

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.

​https://codex.wordpress.org/The_Loop?diff=cur&oldid=152002

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 also beneficial to English users as well.

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

[Nao]

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

[Nao]

Replying to dd32:

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

• ​https://wordpress.org/plugins/post-revision-display/ (long outdated and closed)
• ​https://github.com/eliorivero/revview (old POC plugin?)

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.

[Marcio Zebedeu]

@Nao @netweb I believe that we should move the priority to a higher level because there are already teams working on translation / migration. This resource is important and urgent.

[nobnob]

@netweb @Kenshino @Nao

I totally agree with @marcio-zebedeu's opinion. The priority of this ticket should be "High" (IMHO should be "Highest"):

• Users should be able to know if they are reading the most up-to-date version of the articles.
  

• Translators, as with the plugins and themes, must also have the possibility to know if there is a new version of the articles and what's changed in them.
  

Please give priority to this subject...

Thank you!

[casiepa]

Revisions is indeed the missing piece here to allow polyglots work in an efficient way on the changes in the HelpHub articles.
As a starting point, I have created ​https://wp-info.org/tools/helphubchanges.php to at least understand that a page has been added/changed, but there is no indication of WHAT has changed in the page.

​https://wordpress.org/support/wp-json/wp/v2/articles is open to the public.

Opening up the default ​https://wordpress.org/support/wp-json/wp/v2/articles/p_id/revisions and ​https://wordpress.org/support/wp-json/wp/v2/articles/p_id/revisions/id to the public too (in one way or another) would be sufficient as a first step to work on the data outside of wordpress.org waiting for a fully integrated one like the one of Elio higher up.

[_DorsVenabili]

I'd like to share here that the lack of “notification/review process” is what is stopping us in the Spanish community to start translating the Handbooks and HelpHub :(

It'd be great if we can prioritize this ticket because that lack of sync between the original doc and the translation page has had the Polyglots and Docs team stuck for for a long time.

As soon as this is done, we would be able to start translating Handbook pages, HelpHub pages, etc.

Thanks! :)

[Marcio Zebedeu]

Replying to _DorsVenabili:

I'd like to share here that the lack of “notification/review process” is what is stopping us in the Spanish community to start translating the Handbooks and HelpHub :(

It'd be great if we can prioritize this ticket because that lack of sync between the original doc and the translation page has had the Polyglots and Docs team stuck for for a long time.

As soon as this is done, we would be able to start translating Handbook pages, HelpHub pages, etc.

Thanks! :)

@_DorsVenabili I agree with you. I'm from the same opnion. La on top I had already suggested to raise the priority of this ticket to high. I stopped translating HelpHub exactly by the same situation

[casiepa]

As this ticket is getting more importance now that HelpHub is being deployed in different locales and translators really need see the latest changes to be able to review the changed parts of the articles, I'm moving priority to 'Normal' (I would prefer setting it high, but for sure it should not be low!)

[Clorith]

Bumping priority of this ticket as per docs teams prioritizing for the upcoming meta-doc-focus-session