Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Version documentation matching infisical version. #3140

Open
naguam opened this issue Feb 21, 2025 · 2 comments
Open

Version documentation matching infisical version. #3140

naguam opened this issue Feb 21, 2025 · 2 comments

Comments

@naguam
Copy link

naguam commented Feb 21, 2025

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.

@naguam
Copy link
Author

naguam commented Feb 21, 2025

Also v111 brings automated migration, does it mean I should I disable the autoDatabaseSchemaMigration in the helm chart ?

@maidul98
Copy link
Collaborator

@naguam yes, you can turn that off since migrations are automatic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants