-
Notifications
You must be signed in to change notification settings - Fork 197
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
docs(self-managed): update helm version matrix #5266
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm hesitant to include versions higher than the docs version (for example, if you're on 8.5, you should only see the matrix for 8.5 and lower) - it means there's more to remember and keep accurate at future releases. Is this something that is helpful to have documented in this way? @akeller Do you have any opinions on how much to document here?
I agree with you @conceptualshark. Unless there is a reason you need to see this info for higher versions, let's keep changes to anything current version and lower. |
I believe it's the same. We need to go through all releases and remove the unsupported version for each one. So when 8.7 is released, we need to go to all versions and remove 8.3 I'd say either we include the info for the current version or make all versions have the same content instead of having them. @conceptualshark @akeller, what do you think? |
We already remove/add info to the supported environment page for each minor version, so I don't see any differences there. If you don't want to have to deal with removing it manually for the minor, we can add that to our release manager checklist so you and your team just need to review it. |
f42c148
to
edbb74a
Compare
@akeller If I got your comment correctly, I just added the info for the corresponding Camunda release, as we do in all other parts of the docs. |
The preview environment relating to the commit 308049b has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-5266/index.html |
@aabouzaid I added the Do we need to add the helm version matrix to the component version table? Or should we not have the helm version as a matrix/table at all? If there is one version of the helm chart for one minor version, we probably don't need a table. I'm having trouble seeing what the best way is to present this information based on the conversation. |
@akeller That makes sense. Should I remove the table then and make a normal format? |
We'd thought add it to the component version table, but I didn't want to make this table more unwieldy at the time, and it seemed more logical to find in the Self-Managed section. We do use a lot of "see the Helm version matrix to determine x y z" in the docs, but I don't know how often needing to know versions outside of the one you're on is necessary (outside of upgrading)? So maybe just having the single version match the docs version/product version is fine here. |
Description
As we release the alpha Helm charts publically, I've added the version matrix links for those charts.
Also, I added it to previous Camunda docs from 8.3-8.5
When should this change go live?
bug
orsupport
label)available & undocumented
label)hold
label)low prio
label)PR Checklist
/docs
directory (version 8.8)./versioned_docs/version-8.7/
directory (version 8.7)./versioned_docs
directory.@camunda/tech-writers
unless working with an embedded writer.