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

feat(docs): autogenerate API documentation #27573

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

aramissennyeydd
Copy link
Contributor

Hey, I just made a Pull Request!

Addresses #26894.

This uses https://github.com/PaloAltoNetworks/docusaurus-openapi-docs to render our existing specs. The goal here is to make the OpenAPI spec the source of truth for docs + API definition. I moved the existing catalog docs into the spec and saw really nice results in the autogenerated markdown.

TODO:

  • Figure out a better balance of stored in git vs generated.

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

@github-actions github-actions bot added documentation Improvements or additions to documentation area:catalog Related to the Catalog Project Area microsite Changes to backstage.io labels Nov 10, 2024
@backstage-goalie
Copy link
Contributor

backstage-goalie bot commented Nov 10, 2024

Missing Changesets

The following package(s) are changed by this PR but do not have a changeset:

  • @backstage/plugin-catalog-backend

See CONTRIBUTING.md for more information about how to add changesets.

Changed Packages

Package Name Package Path Changeset Bump Current Version
@backstage/plugin-catalog-backend plugins/catalog-backend none v1.28.1-next.0

@backstage-goalie
Copy link
Contributor

Thanks for the contribution!
All commits need to be DCO signed before they are reviewed. Please refer to the the DCO section in CONTRIBUTING.md or the DCO status for more info.

Copy link
Collaborator

@awanlin awanlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a great addition to the docs @aramissennyeydd, thanks for taking this on!

Looks good over all, curious about two things:

  1. Whats the impact on build time?
  2. Do we need to manage the new sidebars manually?

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:catalog Related to the Catalog Project Area documentation Improvements or additions to documentation microsite Changes to backstage.io
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants