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

Build settings docs from setting schema #5099

Closed
lampwins opened this issue Jan 12, 2024 · 3 comments · Fixed by #5363
Closed

Build settings docs from setting schema #5099

lampwins opened this issue Jan 12, 2024 · 3 comments · Fixed by #5363
Assignees
Labels
type: documentation Improvements or additions to documentation type: feature Introduction of new or enhanced functionality to the application
Milestone

Comments

@lampwins
Copy link
Member

lampwins commented Jan 12, 2024

As a nautobot engineer, I want the docs for settings to be automatically built from the settings JSONSchema, so that I have incentive to maintain the schema, because I do not have to manually maintain the settings docs.

  • Build mkdocs plugin to generate settings docs from the JSONSchema in JSONSchema for core settings #5097
  • Ensure tooling is built such that apps can consume it in the future for the same purpose
  • Integrate settings docs into overall docs build
@lampwins lampwins added this to the v2.2 milestone Jan 12, 2024
@glennmatthews glennmatthews added type: documentation Improvements or additions to documentation type: feature Introduction of new or enhanced functionality to the application labels Feb 5, 2024
@HanlinMiao
Copy link
Contributor

  1. Remove optional_settings.md and required_settings.md
  2. Create jinja2 templates for those two files.
  3. Add a script to a Gen-Files plugin to render the jinja templates using the JSONSchema as inputs

@gsnider2195
Copy link
Contributor

Look at using https://pypi.org/project/mkdocs-macros-plugin/ for rendering the jinja2

@gsnider2195
Copy link
Contributor

Fixed by #5363

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation type: feature Introduction of new or enhanced functionality to the application
Projects
No open projects
Status: To Groom
Development

Successfully merging a pull request may close this issue.

4 participants