Skip to content
New issue

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

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

Already on GitHub? # to your account

Proposal: Remove changelogs #295

Open
johnbillion opened this issue Feb 27, 2025 · 1 comment
Open

Proposal: Remove changelogs #295

johnbillion opened this issue Feb 27, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@johnbillion
Copy link
Member

I propose that the "Changelog" section that's manually included at the bottom of most of the pages in the hosting handbook are removed. There are two problems with these changelogs:

  1. The information is mostly of no value to the reader. Picking this page at random, the changelog is quite substantial in length but contains nothing that adds to the content already on the page. Everything in the changelog is meta information and not relevant to the reader.
  2. The changelog can wrongly give the impression that content is out of date. For example the latest changelog entry on the security page was almost three years ago, but the page was in fact updated just a few weeks ago. Evergreen content doesn't always need to be continually updated. A visible changelog places too much emphasis on recency.

If there is a need to make note of an important change to a particular page then yes let's include that as an exception, but otherwise I think all the changelogs should be removed.

Any objections?

@javiercasares
Copy link
Contributor

This was something the Documentation Team had and we copied that way. Also, it was before the theme update, and having GitHub as the changelog, I don't think it should be a problem to delete/update the documentation without it.

I'm offering myself to fix it if we decide to move on this way.

@javiercasares javiercasares self-assigned this Feb 27, 2025
@javiercasares javiercasares added the documentation Improvements or additions to documentation label Feb 27, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants