Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically insert the code snippets into the K8s tutorial #1512

Open
tonyandrewmeyer opened this issue Dec 18, 2024 · 0 comments
Open

Automatically insert the code snippets into the K8s tutorial #1512

tonyandrewmeyer opened this issue Dec 18, 2024 · 0 comments
Labels
docs Improvements or additions to documentation

Comments

@tonyandrewmeyer
Copy link
Contributor

tonyandrewmeyer commented Dec 18, 2024

Now that we have the K8s tutorial in git, we should be able to have a helper script that takes the relevant code snippets from the tutorial repository and inserts them into the doc files (or some other technique that means that the docs are composed rather than hand-coded). This would ensure that they remain in sync and that the code is tested and formatted consistently (once each chapter has tests for all features, and CI is set up).

Maybe the script could even take care of stitching the chapters together? There's a "previous" and a "next" link in each chapter, as well as instructions at the start for how to check out the previous branch and create a new one, and instructions at the end for how to compare the branches.

@tonyandrewmeyer tonyandrewmeyer added the docs Improvements or additions to documentation label Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant