WordPress / Documentation-Issue-Tracker

Issue Tracker for the WordPress Documentation team.
https://make.wordpress.org/docs/
Other
81 stars 42 forks source link

Changelogs for Docs managed directly in WordPress #41

Open zzap opened 3 years ago

zzap commented 3 years ago

Issue Description

Block editor end user docs has manually added changelog for every new edit on the article. This is very helpful, especially for translators when updating articles in their locales.

First part of this issue is to apply this practice to the rest of documentation managed directly in WordPress - the rest of HelpHub and parts of DevHub (Plugin, Theme, Common APIs Handbooks).

Second part of the issue is that we can expect to come to the point in time when this changelog will be longer than the content itself. We don't want that so we need to think of a better way to do it. Perhaps the quick solution could be placing it on the second page using <!--nextpage--> tag.

Third part of the issue is making everything automated. Before Gutenberg HelpHub had Enhanced Revisions plugin which allowed adding a short message for the update. If something like this can be restored and used on frontend to show dates and messages that could be extremely useful and time saving.

Why is this a problem?

It is unknown when was the last content update and how current it is. Also, this would make life so much easier for locale translators.

Suggested Fix

Let's discuss about possible ways to add changelog wherever needed/possible, how to do it and how to automate it.

courtneyr-dev commented 3 years ago

This would also be a great area to also explore on Learn.