wiki icon indicating copy to clipboard operation
wiki copied to clipboard

Proposal: Remove the "Date last updated" title in docs

Open alaurie opened this issue 1 year ago • 5 comments

I propose we eliminate the 'Date Last Updated' section from our documentation. I've observed that in several documents, updates are made without corresponding changes to the last updated date. This date isn't automatically updated; it requires manual adjustment, which is often overlooked. Moreover, we can always retrieve this information from Git history if needed.

Including dates in our documents might give the impression that they are outdated if not frequently refreshed, which could affect user perception negatively, even when the content remains valid.

If there's a consensus that we should retain this information, I suggest we include it as a markdown comment, so it doesn't appear in the rendered wiki version:

<!-- Date Last Updated: [Insert Date Here] -->

This approach ensures the date is available for those who need it without impacting the document's appearance to end users.

alaurie avatar Jan 23 '25 01:01 alaurie

@sboldyreva I can't actually remember when/why we added those, but I like them because I sincerely hate having to guess about whether or not a document is up to date. There might be another/better way to accomplish the same thing, and/or I might be in the minority here. :D

bennyvasquez avatar Jan 23 '25 21:01 bennyvasquez

Thanks for bringing this up! This was originally made for easier tracking of when was the page last updated. It seems that we can automate this and in this case there will be no need in manually updating the dates https://github.com/AlmaLinux/wiki/pull/579

sboldyreva avatar Jan 30 '25 20:01 sboldyreva

Now that #647 is merged, should we remove the 'last updated' text in the documents themselves? They still serve some purpose, as there's a difference between "the content was meaningfully updated" and "the file was touched in any way", but still...

alexiri avatar Oct 15 '25 13:10 alexiri

~One issue with mass-removing manual update dates is that it'll overwrite the whole history. I don't really mind though.~ Ah, Alex already said the same thing.

pastalian avatar Oct 15 '25 13:10 pastalian

Hey folks, I don't mind removing them either - https://github.com/AlmaLinux/wiki/pull/710

sboldyreva avatar Nov 06 '25 13:11 sboldyreva