Enhance PageRevision to include release notes #24
Conversation
There was a problem hiding this comment.
Thank you for the proposed change @kutenai.
RFC29 propose internal changes to the page revisions in order to accommodate things like revisions comment.
IMO, completion of the first step of RFC29 would be required in order to proceed with this one.
I would encourage you to jump on the corresponding discussions so the work moves in a way which will be compatible with the vision of this RFC and/or this RFC can be updated accordingly.
|
|
||
| ### User Experience | ||
|
|
||
| Adding comments for a draft should be optional, but allowed. I could see a simple option, possibly with a keyboard enabler, such as Control+Click on Save Draft will show |
There was a problem hiding this comment.
Control+Click sounds like a big issue from an accessibility point of view. Given there's already a dropdown over the Save button showing additional options, it would probably make sense to leverage the same mechanism (a Save with comment option maybe?).
|
|
||
| If notes are part of the UI, then they should be paged, since it would be possible to have many notes. | ||
|
|
||
| Also, if notes are captured during draft mode, they should be consolidated and condensed during release, so there would only be draft notes betwween publishes, and all drafts would be combined into the publish notes. |
There was a problem hiding this comment.
That's an interesting idea. You would probably need some human intervention though as it is possible to "revert" one or more draft by selecting a previous one. The automatic consolidation would probably pick up notes from discarded drafts.
| ### Editing Notes | ||
|
|
||
| One appraoch here would be to allow editing revision notes in the Settings panel. I don't think this should be a "required" option, but more of a optional one, enabled | ||
| in configuraiton. |
There was a problem hiding this comment.
So the idea here would be to be able to see all the notes without having to navigate to the specific pages, in other words, a centralised location for notes?
Also, why the settings panel? I can't really think of revisions notes as settings. Is the intent to hide it from the main view?
| If each draft offers the ability to add a note for the release, then a publish could then combine the notes from the drafts created since the last release, into | ||
| a single release note. | ||
|
|
||
| I do not suggest anything very fancy here. Limit the release notes to simle text, or, at best text with Markdown support that can be rendered later. This |
There was a problem hiding this comment.
I would imagine simple text to be enough, but if we need rich text, we should leverage draftail instead of pushing for Markdown. As a developer I love Markdown, but this would be a confusing experience to regular user of the CMS.
|
Just a thought, maybe Workflow makes some of this functionality possible through comments on approval/steps. Maybe it's worth reviewing this RFC on the context of what's available now. Additionally, the page status sidebar opens up some UI space for links or content on the sidebar to be visible more easily. |
Adding an RFC on a request to enhance the current revision system to include an optional ability to replace the current model with one that includes release notes.