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

Register json schema in schema store for mrdocs.yml #772

Closed
Freed-Wu opened this issue Dec 20, 2024 · 4 comments · Fixed by #814
Closed

Register json schema in schema store for mrdocs.yml #772

Freed-Wu opened this issue Dec 20, 2024 · 4 comments · Fixed by #814

Comments

@Freed-Wu
Copy link

https://github.com/SchemaStore/schemastore

https://www.schemastore.org/

TIA!

@alandefreitas alandefreitas moved this to Accepted in MrDocs Dec 23, 2024
@alandefreitas
Copy link
Collaborator

I guess we can do their external schema thing: https://github.com/SchemaStore/schemastore/blob/master/CONTRIBUTING.md#how-to-add-a-json-schema-thats-self-hostedremoteexternal

I'm very ignorant on the matter though. What's the advantage of having the schema in schemastore.org instead of

# $schema: https://mrdocs.com/docs/mrdocs/develop/_attachments/mrdocs.schema.json
# yaml-language-server: $schema=https://mrdocs.com/docs/mrdocs/develop/_attachments/mrdocs.schema.json

@alandefreitas
Copy link
Collaborator

Oh...

By registering the existing JSON schemas in the generated crd-schemas with https://github.com/SchemaStore/schemastore it should automatically be picked up by many of the supporting IDEs and editors such as VS Code, JetBrains IDEA, etc. This would be extremely useful when using Flux as it offers code completion and basic validation for editors.

@alandefreitas
Copy link
Collaborator

@alandefreitas
Copy link
Collaborator

Fixed by SchemaStore/schemastore@28d4076

and already available:

Image

alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Jan 21, 2025
@github-project-automation github-project-automation bot moved this from Accepted to Done in MrDocs Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants