update headings and some format fixes #1125
Conversation
charts/kuadrant-operator/README.md
Outdated
| autoscaleEnabled: false | ||
| EOF | ||
| ``` | ||
| ```sh |
There was a problem hiding this comment.
Why the 4 space indent here.
Are the backticks not enough to render the code block?
There was a problem hiding this comment.
it does render as is but the numbered headings are producing an error then. this change isn't essential tho so if you'd prefer to have it removed I can do that.
There was a problem hiding this comment.
Funny you should mention the numbered headings.
I'm proposing we avoid numbered lists in this style guide PR.
Personally, I think that should extend to numbering of headers as well, for the same reason.
re: the spaces on the code blocks,
for consistency would you mind if we removed the indentation, to align with the usage docs in https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#usage
charts/kuadrant-operator/README.md
Outdated
|
|
||
| ### Install dependencies | ||
| [Envoy](https://www.envoyproxy.io/docs/envoy/latest/start/start) is also an option as a gateway provider, **Steps Coming soon!** |
There was a problem hiding this comment.
| [Envoy](https://www.envoyproxy.io/docs/envoy/latest/start/start) is also an option as a gateway provider, **Steps Coming soon!** | |
| [Envoy Gateway](https://gateway.envoyproxy.io/) is also an option as a gateway provider, **Steps Coming soon!** |
laurafitzgerald
force-pushed
the
update-helm-dependencies
branch
2 times, most recently
from
e9f96d1 to
74e5201
Compare
|
Thanks @laurafitzgerald |
Signed-off-by: Laura Fitzgerald <[email protected]>
laurafitzgerald
force-pushed
the
update-helm-dependencies
branch
from
74e5201 to
97e2e66
Compare
Changing from using the word pre-requisites as this might imply to the user when they are reading that they are responsible for those things when the steps needed to install are provided in the guide.
Also some small formatting fixes.