WordPress.org

Making WordPress.org

Opened 4 years ago

Last modified 5 months ago

#2082 new enhancement

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

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

Description

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 14 months ago.
Diff link displayed at the bottom of https://wpdocs.osdn.jp/The_Loop

Download all attachments as: .zip

Change History (22)

#1 @netweb
4 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
4 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
4 years ago

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

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

Let's KIV this.

Last edited 4 years ago by Kenshino (previous) (diff)

#4 @tellyworth
20 months ago

  • Keywords 2nd-opinion added

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

#5 follow-up: @dd32
20 months ago

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

#6 @Nao
14 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.

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

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

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

@Nao
14 months ago

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

#7 in reply to: ↑ 5 @Nao
13 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.


12 months ago

#9 @Marcio Zebedeu
8 months ago

@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.

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


8 months ago

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


8 months ago

#12 @nobnob
8 months ago

@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!

This ticket was mentioned in Slack in #meta-devhub by zzap. View the logs.


8 months ago

#14 @casiepa
6 months ago

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.

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


5 months ago

#16 follow-up: @_DorsVenabili
5 months ago

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! :)

#17 in reply to: ↑ 16 @Marcio Zebedeu
5 months ago

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

#18 @casiepa
5 months ago

  • Priority changed from low to normal

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!)

This ticket was mentioned in Slack in #polyglots by casiepa. View the logs.


5 months ago

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


5 months ago

This ticket was mentioned in Slack in #meta by casiepa. View the logs.


5 months ago

Note: See TracTickets for help on using tickets.