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

Bundle resources reference autogen fixes #2489

Merged
merged 1 commit into from
Mar 20, 2025
Merged

Conversation

juliacrawf-db
Copy link
Collaborator

@juliacrawf-db juliacrawf-db commented Mar 13, 2025

Changes

Fixes to the bundle reference docgen tool:

  • Update the bundle docgen resources.md template
  • Remove apps resource override so openapi field descriptions are used
  • Regenerate docs: make docs schema (schema/jsonschema.json) and make vendor docs (docgen/output/reference.md and docgen/output/resources.md)

Why

In order to make the docgen process seamless, the resources.md file that is generated by the bundle docgen tool needs to create markdown that does not throw doc build errors.

Tests

Tech review, local testing, and creating a docs PR with the generated reference.md and resources.md files.

@pietern pietern enabled auto-merge March 20, 2025 11:02
@pietern pietern added this pull request to the merge queue Mar 20, 2025
Merged via the queue into main with commit eb070cd Mar 20, 2025
9 checks passed
@pietern pietern deleted the resources-ref-changes branch March 20, 2025 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants