mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-10 19:06:16 +03:00
Focus/Suggest filling "Change Log" on big edits #761
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @tuaris on GitHub (Jul 27, 2018).
Originally assigned to: @Abijeet on GitHub.
Desired Feature:
The "change log" feature seems under utilized and could be helped if there is a way to have the feature visually highlighted/focused, or have a dialog box come up after clicking the save button on large edits. This should be as non-intrusive as possible and should be a configurable option.
@Abijeet commented on GitHub (Aug 5, 2018):
Hey @ssddanbrown,
I think this might not be a bad idea. For this we can add a system wide setting - Set change-log as mandatory.. By default this option will be off, and can be turned on by the administration. When turned on if the user presses save without entering a change-log, the system will
open the change-log box, and focus on the textbox present there with a message stating -
Thoughts?
@ssddanbrown commented on GitHub (Aug 6, 2018):
@Abijeet I can definitely see the benefit, especially in particular environments that need enhanced auditing but I do wonder if there's a demand for such a feature? The original request here did not request this to be mandatory.
@tuaris If there was an option to set it as mandatory would you turn it on to achieve better utilization of the changelog or would you leave if off to negate the increased effort of editing that enabling would bring?
The original request does add complication of strict 'mandatory/non-mandatory' since you'd then need to start diff checking content which can be a bit unreliable from my experience. Plus there'd need to be options to configure what constitutes a 'big edit' so I do favour the stricter implementation, As long as it would be used.
@derek-shnosh commented on GitHub (Aug 21, 2018):
Adding my support/request for a flag in
.envto configure mandatory changelog entries while saving.Diffing and checking is not required for our use-case, as our document standards require that all revisions are commented, even if just for formatting. If a user is hitting save, even if they've simply added a single space character, a comment is required.
In the same vein, it would be nice if the save button was inactive until a user actually changed the contents of the file after clicking Edit.
@tuaris commented on GitHub (Aug 22, 2018):
@ssddanbrown depends on the situation. On certain pieces of process/policy related documentation a valid change log is required for compliance purposes.
Maybe this could be a book level option?
@do-it4fun commented on GitHub (Jun 24, 2025):
Any update on this?
It would be really helpful if we could force the changelog.
For some documents, it is important to be able to track changes and see why something has changed. There are also regulatory requirements (compliance) for some documents.
It would therefore be important for us to have an option to force the changelog to be filled out for every change. We don't need to differentiate a 'big edit'.
We think it would make sense if this is a global or book-wide setting. It doesn't matter to us whether it is activated or deactivated by default.
@scrivoy commented on GitHub (Jan 12, 2026):
Hi @do-it4fun, I was just searching for the same.
Here is the solution:
Issue: #1051
Comment from Dan
Great stuff btw, thanks @ssddanbrown !