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

Document JSON Schema Specification Version In The Docs & Readme #20592

Open
M3TIOR opened this issue Apr 4, 2020 · 0 comments
Open

Document JSON Schema Specification Version In The Docs & Readme #20592

M3TIOR opened this issue Apr 4, 2020 · 0 comments

Comments

@M3TIOR
Copy link

@M3TIOR M3TIOR commented Apr 4, 2020

Summary

I'd like someone to add a link to the particular version of the JSON Schema Specification that Atom is supposed to support to both the documentation on Atom.io and in the README.md. I am building my own Atom plugin at the moment to support code formatting on load and save events; and while I have been able to get quite far by just playing around and using the available specification within The Atom Flight Manual: Configuration Section, I'd still like to get a better idea of what features are available to me. I plan on filing a separate issue in the Atom Settings Manager Repository for this; but I'm also running into a problem where the schema I've created isn't producing configuration options in Atom's Settings Manager. To understand the circumstances that are producing my problem and know my how I should proceed from here, I need to know: whether it's a schema misconfiguration on my end, a misunderstanding and improper expectation of the Settings Editor, or a bug.

Motivation

Having accurate documentation is good for developers and plugin creators alike. It helps keep ideas solidified and in a place where code contributors can directly see their operating parameters. I expect having this schema specification version available will at the very least help new plugin developers produce their products faster. This would support all use-cases for JSON and Javascript plugin configuration.

Describe alternatives you've considered

I'm currently looking through the Git repositories code to better try and understand the JSON Schema implementation. The only other alternative I've thought of is completely forgoing use of the Atom Settings Editor, but I think that's pretty lamesauce. Even though I'm already planning on adding my own UI elements for configuration of my plugin because it's so complex, I don't think it's fair to the people using my plugin that they can't use the pre-existing Settings Editor for the bulk of configuration since it's what they should be most familiar with.

Additional context

The latest JSON Schema Specification which is linked to on the main json-schema.org page.(possibly the incorrect version and where your documentation currently points to by proxy)
A comprehensive list of all the current and previous JSON Schema Specifications available. (For the convenience of the person that is tasked with completion of this request should it be accepted)

Also, I don't mean to sound snarky or stuckup, re-reading this what I all I've said kinda does to me. 😅 I'm really just trying to follow your community guidelines to the best of my ability. So sorry about that 🙃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.