readthedocs / readthedocs.org

The source code that powers readthedocs.org
https://readthedocs.org/
MIT License
8.03k stars 3.58k forks source link

Create a YAML schema file to plan out our changes to our yaml spec #4058

Closed agjohnson closed 6 years ago

agjohnson commented 6 years ago

I raised in #3878 a good way to start our YAML spec changes would be to write a schema:

I think the next step is to start writing a schema and some actual examples. https://github.com/23andMe/Yamale looks promising.

We should start here so that we can formalize the tree structure and naming conventions, and provide some validation checks.

Work required here might be:

stsewd commented 6 years ago

I was looking at https://json-schema-everywhere.github.io/yaml, seems like more standard, but there is only a js implementation :(, I'll try to see if the library is mature enough, maybe we can use it doing external calls.

agjohnson commented 6 years ago

I'd be -1 on using a javascript solution here. A python module gives us the ability to quickly turn the schema into unit tests.

agjohnson commented 6 years ago

The underlying PR was just merged. Closing.