Make k8s backend configuration docs in the same format as others

[micash545]

No description provided.

[woodpecker-bot]

Deployment of preview was successful: https://woodpecker-ci-woodpecker-pr-3081.surge.sh

[pat-s]

IMO this should be other way round, i.e. the k8s format should be applied to the others. We should not use markdown headers for config descriptions.

Yes I know, headers create link which can be used as direct references but they also bloat the always-visible sidebar in the docs - and this looks quite strange (having only capitalized config values there).

[qwerty287]

Yes I know, headers create link which can be used as direct references but they also bloat the always-visible sidebar in the docs - and this looks quite strange (having only capitalized config values there).

I don't think so if they're formatted as code. I think it's fine how it's done here.

[zc-devs]

they also bloat the always-visible sidebar in the docs

This. One option is move it at the end of the page, like in Agent and Server docs. JFYI: WOODPECKER_ADDONS doesn't look as others.

headers create link which can be used as direct references

Another option is set them as H4 and hide headers >H3 from menu. Something like that.

---

This should be fixed as well as this.

[qwerty287]

JFYI: WOODPECKER_ADDONS doesn't look as others.

I know, I fixed that already in #3069

One option is move it at the end of the page

I think this is the best option. You get a good overview over, can use links, but everything that could be more important than just a config list is still on top of the TOC.

[pat-s]

Moving them to the end and reducing the header level sounds good to me too.

Should there be a new PR? I don't think we should urge @micash545 to do all of the mentioned improvements on every page.

[qwerty287]

Yes, should be done in a new PR.

To get this one done, @micash545: Can you change the header level of the settings to h4? (I.e. all ### to ####.)

[qwerty287]

Should we ignore this markdownlint issue? (we have to if we want to use h4 there)

https://results.pre-commit.ci/run/github/179344069/1704442479.eN-2loQKRUyx8W0ngwz0ww

docs/docs/30-administration/22-backends/40-kubernetes.md:21 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]

[qwerty287]

To fix this precommit issue for now, you could also add another h3 header with Options or something like this above the env var list.

[pat-s]

Thanks @qwerty287

Another option is set them as H4 and hide headers >H3 from menu. Something like that.

Could we also get this in as suggested by @zc-devs? If we do so, options would be alone in the ToC which also looks a bit weird. But likely still better than having all individual options as a single entry.

I would also vote for moving the list of options to the end to avoid long scrolling at the top of the page.

[qwerty287]

@pat-s Here you go: https://woodpecker-ci-woodpecker-pr-3081.surge.sh/docs/next/administration/backends/kubernetes