How do I add a comment to a page edit? | Community
Skip to main content
S
stuart.mcgarrity
April 6, 2017
Solved

How do I add a comment to a page edit?

  • April 6, 2017
  • 5 replies
  • 3563 views

After editing a page, but before roll-out and publishing, I want to save a text comment about what I did and why, to help with future troubleshooting or change tracking.

I see I can add a label/comment when saving a version. But I don't need to make a new version (although I know a new version is created on publishing). I see I can add annotations, but they appear to be associated with the page and not with the page versions.

What is the best way to do this? 

Thanks

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.
Best answer by Hemant_arora

Simply ask the developer to add a new tab/new fields to add changes done to the page properties dialog where you can specify what changes you did the page.

Secondly ask the developer to customize siteadmin and add another column to siteadmin to display the comments what work you did.

If the above doesn't suits then you should go with annotations and versioning.

5 replies

Kunal_Gaba_
Kunal_Gaba_
April 7, 2017

If you do not want to use versioning and annotation then add a custom property on the page to store your comments. 

kautuk_sahni
Community Manager
kautuk_sahniCommunity Manager
Community Manager
April 7, 2017

Your requirement is very custom.

But for sure it can be achieved by page versioning and adding label/comment there while saving the version. Why are you avoiding the versioning?

~kautuk

Kautuk Sahni
S
stuart.mcgarrityAuthor
April 7, 2017

Its not that I don't want to use them, its that they don't seem to do what I want. So the custom property would be a long string? A user would probably need save the date in the field with each they note a change. Perhaps. Sounds a bit ugly.

S
stuart.mcgarrityAuthor
April 7, 2017

I guess, I'm more used to the software development model: You add a comment when you submit a change. Its essential for trouble shooting. I understand its not as important for content edits but when you have multiple people working on the same page I think I can be difficult to track down what happened. Looks like versioning is the closest to what I want.

I would make a change, save a version, then publish, but the publishing itself would save another version and it would have not comments stored with it. A user in the future (who was trying to understand changes to the page) would just need to scan back in the versions to find ones with comments? That could work.

Hemant_arora
Hemant_aroraAccepted solution
Level 8
April 7, 2017

Simply ask the developer to add a new tab/new fields to add changes done to the page properties dialog where you can specify what changes you did the page.

Secondly ask the developer to customize siteadmin and add another column to siteadmin to display the comments what work you did.

If the above doesn't suits then you should go with annotations and versioning.

Terms & ConditionsAccessibility statement

Loading footer...