You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I think it is important to avoid having to look into the details github commit log to see if/which settings changed from the last version.
Also I don't know if version jumps are ok or not, because upgrading every week is hard for maintenance unless it is security only non breaking fixes.
Why would it be useful?
When you are a few version late and a few settings change in a breaking way (new requirements or renaming) it is nice to be able to go back in time in the documentation before proceeding to the updates.
Because if one can look in the changelog for actual changes, this is nice to see the new changes in procedures in the documentation with a point of comparison.
An complementary solution.
Add a page in the menu which describe every upgrade steps to be taken and which versions can be jumped before meeting a breaking change that require more intervention than just a version bump.
Important to keep in mind.
Make latest (tag) version always point to the latest version tag one and use robot.txt or equivalent to only allow search engine to index the latest (tag), because otherwise old doc become indexed for a longer time and people reach outdated doc first. If new documentation removes a page, redirect to home page is a solution.
In general
I may be bad at explaining the benefits, but a versioned documentations is very useful for me as an admin, so I don't have to second guess whats available on my instance or not for setup but also later maintainance.
The text was updated successfully, but these errors were encountered:
Feature description
I think it is important to avoid having to look into the details github commit log to see if/which settings changed from the last version.
Also I don't know if version jumps are ok or not, because upgrading every week is hard for maintenance unless it is security only non breaking fixes.
Why would it be useful?
When you are a few version late and a few settings change in a breaking way (new requirements or renaming) it is nice to be able to go back in time in the documentation before proceeding to the updates.
Because if one can look in the changelog for actual changes, this is nice to see the new changes in procedures in the documentation with a point of comparison.
An complementary solution.
Add a page in the menu which describe every upgrade steps to be taken and which versions can be jumped before meeting a breaking change that require more intervention than just a version bump.
Important to keep in mind.
Make latest (tag) version always point to the latest version tag one and use robot.txt or equivalent to only allow search engine to index the latest (tag), because otherwise old doc become indexed for a longer time and people reach outdated doc first. If new documentation removes a page, redirect to home page is a solution.
In general
I may be bad at explaining the benefits, but a versioned documentations is very useful for me as an admin, so I don't have to second guess whats available on my instance or not for setup but also later maintainance.
The text was updated successfully, but these errors were encountered: