Fix tab formatting in code-samples folder
Background
The files in code-samples folder are no longer viewable on the website, only in GitHub. However, this has caused broken formatting because tabbed elements are not available in GitHub markdown.
Task
Remove the tabbed formatting, for example === "yaml", in the files in the code-samples folder. Make sure that if the tabbed formatting is under a step, you indent your new formatting within each step.
Files that have this issue:
- [ ] ./code-samples/serving/cloudevents/cloudevents-nodejs/README.md
- [ ] ./code-samples/serving/cloudevents/cloudevents-rust/README.md
- [ ] ./code-samples/serving/cloudevents/cloudevents-go/README.md
- [ ] ./code-samples/serving/cloudevents/cloudevents-vertx/README.md
- [ ] ./code-samples/serving/cloudevents/cloudevents-spring/README.md
- [ ] ./code-samples/serving/hello-world/helloworld-ruby/README.md
- [ ] ./code-samples/serving/hello-world/helloworld-shell/README.md
- [ ] ./code-samples/serving/hello-world/helloworld-java-spring/README.md
- [ ] ./code-samples/serving/hello-world/helloworld-python/README.md
- [ ] ./code-samples/serving/hello-world/helloworld-java-spark/README.md
- [ ] ./code-samples/serving/hello-world/helloworld-go/README.md
- [ ] ./code-samples/serving/hello-world/helloworld-php/README.md
- [ ] ./code-samples/serving/hello-world/helloworld-scala/README.md
Question: why were the samples moved out of the website instead of being published properly here?
It would be a bit more initial work to format them correctly etc, but tbh I think some of these could actually move into the core docs content instead as procedures, tutorials, etc rather than being dumped into the samples section or github.
How do we feel about making this into an epic instead and for each of the samples figuring out if they can be integrated better into the main docs or where is the best place for them to live? I feel like it's just bad UX to send folks over to github for no reason and then have weird / less usable formatting because things like tabs aren't supported.
@abrennan89 The original reason why we moved the samples is mainly to make it easier for devs to clone the repo and have the whole sample, including instructions and accompanying YAML and other files, in one place. We got feedback from quite a few people saying they preferred to use the samples from GitHub rather than using them from the docs.
We also felt that if the samples are on the site, it would be our (Docs WG) responsibility to make sure they are up to date. We were considering moving the samples out of the docs repo entirely so that we would not be responsible for keeping them updated. However, we couldn't find anyone else who wanted the be responsible for updating the samples.
We discussed again in WG meeting today (August 30 2022) and keeping the samples in GitHub with links in the docs was again the consensus.
/good-first-issue
@evankanderson: This request has been marked as suitable for new contributors.
Please ensure the request meets the requirements listed here.
If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.
In response to this:
/good-first-issue
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/test-infra repository.
/assign