Ensure all technical documentation provides clear explanations and follows proper formatting conventions. Technical parameters, configuration options, and complex concepts should include explanatory comments or descriptions to make them accessible to users and maintainers.
Key practices:
Example from configuration documentation:
- name: deviceshare
arguments:
deviceshare.VGPUEnable: true # Enable virtual GPU support for workloads
deviceshare.KnowGeometriesCMName: volcano-vgpu-device-config # ConfigMap containing GPU geometry definitions
This approach ensures documentation serves its primary purpose: helping users understand and correctly use the system.
Enter the URL of a public GitHub repository