MonkeyCanCode commented on code in PR #3879:
URL: https://github.com/apache/polaris/pull/3879#discussion_r2850789740
##########
helm/polaris/values.schema.json:
##########
@@ -323,7 +323,7 @@
}
},
"features": {
- "description": "Features to enable or disable globally. If a
feature is not present in the map, the default built-in value is used. Refer to
Polaris [Configuration reference]({{% ref \"../configuration\" %}}) for a
complete list of available features.",
Review Comment:
Nice catch on this @flyingImer . So this is actually due to parsing with
helm-doc via `helm schema -f values.yaml --use-helm-docs --draft 7`.
The issue here is due to we are using
`https://polaris.apache.org/in-dev/unreleased/configuration/configuration-reference/#features--behavior`
as url where there is two dashes. That somehow break the parsing. The two
dashes are due to safe url from hugo when using `&` (in this case `features &
behavior` got converted to `#features--behavior`).
Now to fix this problem, here are couple options:
1. Convert this to a single line to avoid rendering issue
2. Update hugo template to handle `&`
3. Avoid use `&` in the headers which will be using as anchor (there is
nothing wrong here just issue from the tooling)
4. Refer to other links which doesn't have `--` (e.g. maybe point to
`https://polaris.apache.org/in-dev/unreleased/configuration/configuration-reference/`
instead?)
5. Check if we can fix bug from the tooling (in this case helm docs and helm
schema)
There may other options available. @adutra thoughts?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
