README.md is manually maintained?

[fabiand]

What happened: Could it be that the READ is manually maintainted instead of auto generated?

What you expected to happen: To have README.md to be auto generated

How to reproduce it (as minimally and precisely as possible): Always

Additional context: https://github.com/fabiand/instanceTypes/blob/main/hacks/docs.py is auto generating a readme based on the metadata/yamls.

Environment:

• KubeVirt version (use virtctl version): N/A
• Kubernetes version (use kubectl version): N/A
• VM or VMI specifications: N/A
• Cloud provider or hardware configuration: N/A
• OS (e.g. from /etc/os-release): N/A
• Kernel (e.g. uname -a): N/A
• Install tools: N/A
• Others: N/A

[fabiand]

[fabiand@toolbox common-instancetypes (main)]$ git grep "Has GPUs"
README.md:*Has GPUs*                  |     |     |      |  ✓   |     |
README.md:- *Has GPUs* - Has GPUs predefined.
[fabiand@toolbox common-instancetypes (main)]$

[0xFelix]

The README is partially auto generated, partially manually maintained.

See https://github.com/kubevirt/common-instancetypes/blob/main/scripts/readme.sh

Does this meet your requirements?

[fabiand]

@0xFelix did you know about https://github.com/fabiand/instanceTypes/blob/main/hacks/docs.py (rendered: https://github.com/fabiand/instanceTypes/blob/main/README.md) ?

It's carefulyl written (tho not beautiful), because it addresses the following:

1. It's for the suer
2. therefore it has a diagram to give a high level overview over the ITs and their "classification"
3. It has a series comparison to show the user how the series technically differ
4. It provides a human friendly more elaborative description for each series
5. It lists the available sizes for each series
6. It's for the developer
7. As all of this is quto generated
8. It firces the developer to keep all the information in the metadata of the objects, aka makes it available to higher level consumers like a UI

Does this meet your requirements?

because of the above i'd say carefully no.

[kubevirt-bot]

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[lyarwood]

/remove-lifecycle stale