nebari-dev / nebari-dev/nebari-docs
[DOC] - Use of json schema for configuration documenation
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Preliminary Checks
- This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions
Summary
Currently the configuration documentation has been written by hand. I would like us to rely more heavily on the json schema. As an example visit https://json-schema.app/view/%23?url=https%3A%2F%2Fgist.githubusercontent.com%2Fcostrouc%2F603071253cf3f942e480afeb5af37750%2Fraw%2Fd814480005856426052a772a4a63dbefe9e83cf2%2Fschema.json for what is possible.
>>> import nebari
>>> with open('schema.json', 'w') as f:
>>> f.write(nebari.plugins.nebari_plugin_manager.config_schema.schema_json())
This will render the json schema. We could also choose to export subsections and include that embeded within certain documentation.
Steps to Resolve this Issue
Use json schema within the docs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing configuration documentation and the schema entry point shown in the issue: nebari.plugins.nebari_plugin_manager.config_schema.schema_json(). Determine which documentation sections should use the generated JSON schema or embedded subsections, then verify that the documented configuration is represented by the schema and renders as expected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100