Docs: Kratos Helm chart doc is not rendered correctly on k8s.ory.sh
MichaelMarner opened this issue · comments
Preflight checklist
- I could not find a solution in the existing issues, docs, nor discussions.
- I agree to follow this project's Code of Conduct.
- I have read and am following this repository's Contribution Guidelines.
- This issue affects my Ory Network project.
- I have joined the Ory Community Slack.
- I am signed up to the Ory Security Patch Newsletter.
Describe the bug
The hosted Helm docs for Kratos:
https://k8s.ory.sh/helm/kratos.html
Do not render the sample yaml correctly. Specifically, the section about supplying an identity schema with a file using --set-file, should look like this:
# values.yaml
kratos:
identitySchemas:
<schema-name>.schema.json: |-
{{ .Values.<your-key> }}
Github renders this correctly, as shown here:
https://github.com/ory/k8s/blob/master/docs/helm/kratos.md#identity-schemas
However, the vital {{.Values<your-key<}} is not rendered at all on the generated HTML:
Reproducing the bug
N/A - This is an error in the generated documentation.
Relevant log output
N/ARelevant configuration
N/AVersion
N/A
On which operating system are you observing this issue?
None
In which environment are you deploying?
None
Additional Context
No response
@MichaelMarner thank you! :)
Can confirm that this is still an issue, and very confusing for those who are not super familiar with helm. :D
Uhm, could it be browser depended 🤔? On my end i see the following
Looks the same on both Firefox and chrome based Opera
@Demonsthere I think you are looking at the "wrong" thing:
I just checked in Firefox and Chrome on a Mac, and Brave on iOS. It looks like this.
Yeah, it's the github pages based rendering 😞 The file renders correctly as a md, and even local md -> html shows it correctly. I have tried updating the pages theme, but it looks the same. Don't really know what we can do here 😞
Add a note that it may not render correctly? :D (aka quickfix)