docs: add a reference of helm values #16238
Conversation
maintainer-s-little-helper
bot
added
the
dont-merge/needs-release-note-label
bmcustodio
added
area/documentation
aanm
added
needs-backport/1.8
release-note/misc
maintainer-s-little-helper
bot
removed
the
dont-merge/needs-release-note-label
There was a problem hiding this comment.
Nice additions, but some items need some fix up.
Please let's make sure we only add the minimal set of entries required to the spelling list. A few of them are unnecessary, some of them are superseding the equivalent entries with capital letters, and for some I just don't understand how they ended up in the list.
Another important point - What does the result look like on your setup? The generated table is very wide in my browser, and anything past the two or three first columns needs a lot of scrolling, making the table unreadable in practice. Have you tried alternative ways to render the values, or at least looking at table options to see if there's a way to wrap the content?
@qmonnet you are right, but unfortunately I don't know if there's a way to work around it — we have the same issue, I think, in some other places such as https://docs.cilium.io/en/v1.9/operations/metrics/#endpoint. I'll try to see what I can do. |
|
Have you tried looking at the available options for the |
I hadn't, thank you for the link 🙂 — unfortunately, I had a look and that doesn't seem to help much in making the table readable. I've pushed a CSS-based solution which, while not perfect, will hopefully work well 🙏🏼 |
|
I'm removing this from the 1.8 backport queue. If we really want this on 1.8, this needs a manual backport as the Helm setup is different there. |
PR cilium#16238 added a reference for the Helm values in the Charts to the documentation. A number of these values are not common words from the dictionary, and need to be added to the list of acceptable words in the spelling list as we update the charts. The GitHub action for documentation is supposed to help with the task, catching omitted keywords. But it is only run when a number of documentation-related files are run, and this does not currently include the Charts! Let's fix in order to catch spelling mistake (or omitted spelling list updates). Fixes: cilium#16238 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
PR #16238 added a reference for the Helm values in the Charts to the documentation. A number of these values are not common words from the dictionary, and need to be added to the list of acceptable words in the spelling list as we update the charts. The GitHub action for documentation is supposed to help with the task, catching omitted keywords. But it is only run when a number of documentation-related files are run, and this does not currently include the Charts! Let's fix in order to catch spelling mistake (or omitted spelling list updates). Fixes: #16238 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
[ upstream commit 4e5272b ] PR cilium#16238 added a reference for the Helm values in the Charts to the documentation. A number of these values are not common words from the dictionary, and need to be added to the list of acceptable words in the spelling list as we update the charts. The GitHub action for documentation is supposed to help with the task, catching omitted keywords. But it is only run when a number of documentation-related files are run, and this does not currently include the Charts! Let's fix in order to catch spelling mistake (or omitted spelling list updates). Fixes: cilium#16238 Signed-off-by: Quentin Monnet <quentin@isovalent.com> Signed-off-by: Tobias Klauser <tobias@cilium.io>
[ upstream commit 4e5272b ] PR cilium#16238 added a reference for the Helm values in the Charts to the documentation. A number of these values are not common words from the dictionary, and need to be added to the list of acceptable words in the spelling list as we update the charts. The GitHub action for documentation is supposed to help with the task, catching omitted keywords. But it is only run when a number of documentation-related files are run, and this does not currently include the Charts! Let's fix in order to catch spelling mistake (or omitted spelling list updates). Fixes: cilium#16238 Signed-off-by: Quentin Monnet <quentin@isovalent.com> Signed-off-by: Tobias Klauser <tobias@cilium.io>
[ upstream commit 4e5272b ] PR #16238 added a reference for the Helm values in the Charts to the documentation. A number of these values are not common words from the dictionary, and need to be added to the list of acceptable words in the spelling list as we update the charts. The GitHub action for documentation is supposed to help with the task, catching omitted keywords. But it is only run when a number of documentation-related files are run, and this does not currently include the Charts! Let's fix in order to catch spelling mistake (or omitted spelling list updates). Fixes: #16238 Signed-off-by: Quentin Monnet <quentin@isovalent.com> Signed-off-by: Tobias Klauser <tobias@cilium.io>
joestringer
moved this from Needs backport from master
to Backport done to v1.9
in 1.9.9
Adds a reference of all Helm values that can be set on the chart to the documentation.