fixed doc rendering issues

[anshuman-agarwala]

What type of PR is this?

/kind documentation
What this PR does / why we need it:
Fixes rendering error in documentation
Which issue(s) this PR fixes:

Fixes #3735

Does this PR introduce a user-facing change?:

NONE

[k8s-ci-robot]

Welcome @anshuman-agarwala!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @anshuman-agarwala. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: anshuman-agarwala
Once this PR has been reviewed and has the lgtm label, please assign youngnick for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[mikemorris]

/ok-to-test

I think we'd like to ideally keep this snippet inside a code block somehow, or restructure to move this example outside of the table where it doesn't render properly instead of just removing the attempted code styling.

[anshuman-agarwala]

@mikemorris I could not find a way to keep the code block inside the table. Could you give an example of how you would like the docs to be refactored so that the example is moved out of the table?

[youngnick]

This is probably okay as an emergency fix, but I think we may need to update the generator we're using to handle inline code snippets properly.

[shaneutt]

For https://github.com/kube-rs/gateway-api-rs we had an issue where the example sections would be interpreted as runnable Rust examples by cargo test, which we fixed in kube-rs/kopium#264 by adding an identifier of "```text". Does adding identifiers like that have any impact on the rendering here?

[anshuman-agarwala]

I tried something similar initially by adding the yaml identifier instead of text but all it does is print the identifier.
When I add ```text, I get the following output:

[shaneutt]

I tried something similar initially by adding the yaml identifier instead of text but all it does is print the identifier.

Ok gotcha, thank you for checking! I think I agree with @youngnick's assessment, but that leaves me wondering if we're much closer to being able to just update the generator than we realize? 🤔