https://gateway-api.sigs.k8s.io/references/spec renders code snippets improperly

[pmalek]

It seems that the tooling responsible for generating the source for https://gateway-api.sigs.k8s.io/references/spec is not doing it properly for code snippets (e.g. yaml manifests)

Taking a look at https://github.com/kubernetes-sigs/gateway-api/blob/ff862f153f1c3c014ddf84a1194bc44982d027e2/site-src/api-types/httproute.md#matches the manifest looks correct

Although what's rendered at https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1beta1.HTTPRouteRule doesn't look right

Note the squashed list items.

Not sure how feasible it is to address this.

[robscott]

Thanks for filing this @pmalek! Hopefully someone can find a solution to this that also passes linting. If not, we may just need to find an alternative to inline YAML snippets. We ran into similar problems in https://github.com/kubernetes-sigs/gateway-api/pull/1416.

[kundan2707]

/assign

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle stale
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[shaneutt]

Hi @kundan2707 👋

Wanted to check in on this one: are you still planning on doing this, and do you need any assistance from us? If not that's totally fine just let us know and we can unassign you 🖖

[kundan2707]

/remove-lifecycle stale

[kundan2707]

@shaneutt can you help me to get path or any document related to tooling which is responsible for generation of this document?

[shaneutt]

What I usually do when I need to update the site is make my changes (e.g. in site-src/) and then make a draft PR, so that netlify can build it for me and provide a demo URL I can test my changes at.

[kundan2707]

@shaneutt thanks I will make change and push draft PR soon.

[robscott]

Closing this in favor #2555.