-
Notifications
You must be signed in to change notification settings - Fork 288
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
Socket Slack Docs #1367
Comments
Hi @yllek, thank you for posting the user feedback. We use single curly braces to show that a given text is a placeholder. So, in case of
So curly braces should we always removed in such cases. However, I agree this might be confusing as we don't state it anywhere clearly that curly braces is our way to define placeholder. We tried to follow the MS content guidelines: https://learn.microsoft.com/en-us/contribute/content/text-formatting-guidelines#placeholders, but we clearly lack the "Inform the reader about the placeholder" guideline. Should we add text like "Text in curly braces, such as |
Description
Feedback from a user in Install Botkube in K8s Cluster section of Socket Slack docs:
Inputting the cluster name and other exported variables with curly brackets ({cluster_name}) will cause errors when running the following lines of config settings.
For example:
export CLUSTER_NAME={example_cluster}
will result in:
--set settings.clusterName=${{example_cluster}} \
and will throw an error. It is difficult to debug as the error message isn't descriptive.
Expected behavior
export CLUSTER_NAME=example_cluster
will result in:
--set settings.clusterName=${example_cluster} \
Actual behavior
export CLUSTER_NAME={example_cluster}
will result in:
--set settings.clusterName=${{example_cluster}} \
Steps to reproduce
I have not tried to reproduce myself. If docs are incorrect, remove curly bracket around value example. If docs are correct, then more clarity or a call out for users who might overlook.
The text was updated successfully, but these errors were encountered: