WordPress / wporg-documentation-2022

15 stars 6 forks source link

Single articles should have a changelog #6

Open ryelle opened 1 year ago

ryelle commented 1 year ago

This is part of the Single template, #3.

Some pages use a "changelog" pattern, which seems to be a styled group block. For example, https://wordpress.org/support/article/dimension-controls-overview/, https://wordpress.org/support/article/wordpress-editor/.

In the new design, this is separate from the content, below the comment form. It's hidden under a "See the list of changes of this article" button.

Screenshot 2022-11-22 at 1 16 32 PM

When opened, it should display the changelog content, with a close button to hide it again.

single-open-changelog

There will probably need to be a new block to display the changelog, and maybe a new way for docs authors to enter the changelog in Articles (and WP Versions?) so that it can be displayed outside of the main content section.

ryelle commented 8 months ago

From figma:

Estela: oh Nick Diego you just reminded me of something 🫣We are moving HelpHub (documentation) to GitHub, so that last update block, won't be valid any longer. There is no quirk on the Block Editor Handbook, rather is a manifest that requires updates in 15 minutes intervals. The hosting and advanced administration handbooks work the same. Estela: Question: is it possible to add the change log block by default to every article during development?

Nick: I am not sure, but if the HelpHub is moving to GitHub, is a changelog necessary then? Any docs changes will be viewable in GitHub. That's one of the reasons we don't have a changelog in the Block Editor Handbook.

So I'm marking this officially on hold— if the HelpHub is on GitHub, we could use the same pattern as the developer handbooks to link to commit history, for example on this page

Screenshot 2024-01-18 at 4 17 42 PM
ndiego commented 8 months ago

if the HelpHub is on GitHub

I have followed up on this here.