Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Single articles should have a changelog #6

Open
ryelle opened this issue Nov 22, 2022 · 2 comments
Open

Single articles should have a changelog #6

ryelle opened this issue Nov 22, 2022 · 2 comments
Labels
[Component] Blocks Custom blocks or block variations [Component] Theme Templates, patterns, CSS Low Priority This should happen sometime, but other things are more important [Status] On Hold Work is paused temporarily

Comments

@ryelle
Copy link
Collaborator

ryelle commented Nov 22, 2022

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 ryelle added [Component] Blocks Custom blocks or block variations [Component] Theme Templates, patterns, CSS labels Nov 22, 2022
@ryelle ryelle mentioned this issue Nov 22, 2022
@ryelle ryelle added the Low Priority This should happen sometime, but other things are more important label Nov 22, 2022
@ryelle ryelle added this to the Post-Launch Iteration milestone Jan 20, 2023
@ryelle
Copy link
Collaborator Author

ryelle commented Jan 18, 2024

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

@ryelle ryelle added the [Status] On Hold Work is paused temporarily label Jan 18, 2024
@ndiego
Copy link
Member

ndiego commented Jan 23, 2024

if the HelpHub is on GitHub

I have followed up on this here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Component] Blocks Custom blocks or block variations [Component] Theme Templates, patterns, CSS Low Priority This should happen sometime, but other things are more important [Status] On Hold Work is paused temporarily
Projects
None yet
Development

No branches or pull requests

2 participants