TL;DR

Add a config.template.yaml file and reference it in config.yaml using the yaml-language-server: $schema directive to provide a template for configuration.

Guidance

• Create a config.template.yaml file with the desired template structure to serve as a guide for users.
• Update config.yaml to include the yaml-language-server: $schema entry, pointing to the location of the config.template.yaml file.
• Verify that the template is correctly applied by checking that the config.yaml file is validated against the schema defined in config.template.yaml.
• Consider adding documentation or comments to explain the purpose and usage of the template file.

Example

# config.yaml
yaml-language-server: $schema=config.template.yaml

Notes

This solution assumes that the yaml-language-server supports the $schema directive and can correctly interpret the template file.

Recommendation

Apply workaround by adding a config.template.yaml file and updating config.yaml to reference it, as this provides a clear and straightforward solution to the problem of lacking a template for configuration.