Skip to content

Proposal: Host a YAML Schema on a Static CDN for values.yml #993

@Longwater1234

Description

@Longwater1234

What motivated this proposal?

As a user of the nats-io/k8s Helm charts, it would be greatly beneficial to have a YAML schema available for values.yml. Hosting this schema on a static CDN would streamline the configuration process by enabling features such as real-time validation and autocompletion in popular IDEs and editors (e.g., VS Code, IntelliJ, etc.).

What is the proposed change?

Create a JSON or YAML schema that defines the structure and allowed values for values.yml.

Host the schema on a static CDN (e.g., GitHub Pages, a dedicated CDN service, or a public bucket in a cloud provider).

Include a reference to the hosted schema in the project documentation for users to easily integrate it into their workflows.
Users would then reference it in their values.yml as:

# yaml-language-server:
 $schema=https://nats-io.github.io/k8s/schemas/values.schema.json

Who benefits from this change?

Benefits:

Validation: Users can validate their values.yml files against the schema, ensuring that their configurations are correct before deployment.

Autocompletion: IDEs can use the schema to provide context-aware suggestions, reducing the learning curve for new users.

Reduced Errors: Clear guidance and validation would help reduce misconfigurations and errors.

Improved User Experience: A schema hosted on a CDN ensures easy access and integration without requiring additional setup.

What alternatives have you evaluated?

This feature would align with best practices seen in other popular projects that provide schemas for their configuration files, improving usability and community adoption.

Metadata

Metadata

Assignees

No one assigned

    Labels

    proposalEnhancement idea or proposal

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions