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 generate README.md files #1421

Open
NimJay opened this issue Aug 19, 2024 · 0 comments
Open

Automatically generate README.md files #1421

NimJay opened this issue Aug 19, 2024 · 0 comments
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@NimJay
Copy link
Collaborator

NimJay commented Aug 19, 2024

Background info/Context:

  • Each folder containing a set of samples should contain a README.md file (as noted by the samples' requirements here).
  • See README.md template here.
  • This README.md ensures visitors of this repository know:
    • where the full tutorials/instructions are for a given sample file.
    • what the sample is doing.
  • Today, sample authors are expected to manually create these README.md files.

Feature request: Ideally, these README.md would be generated automatically. This would reduce the amount of back-and-forth between sample authors, and reduce the work necessary to create new GKE samples.

Additional info:

@NimJay NimJay added priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

1 participant