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

[Docs]: OpenAPI docs Plugin #54

Open
1 task done
AleksandarCole opened this issue Jun 11, 2024 · 0 comments
Open
1 task done

[Docs]: OpenAPI docs Plugin #54

AleksandarCole opened this issue Jun 11, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation docusaurus Issue related to our docs engine help wanted Extra attention is needed

Comments

@AleksandarCole
Copy link
Member

AleksandarCole commented Jun 11, 2024

Type

New content idea

What do you want to report?

As a part of a API v1 project we are using OpenAPI to generate documentation for new Semaphore API.

Goal of this task is to:

  • Find the best way to integrate API docs into our new Docusaurus based documentation
  • Create the implementation plan
  • Integrate our API docs into new documentation

Suggested starting point:
https://github.com/PaloAltoNetworks/docusaurus-openapi-docs

Code of Conduct

  • I agree to follow this project's Code of Conduct
@AleksandarCole AleksandarCole added documentation Improvements or additions to documentation help wanted Extra attention is needed docusaurus Issue related to our docs engine labels Jun 11, 2024
@AleksandarCole AleksandarCole self-assigned this Jun 11, 2024
@AleksandarCole AleksandarCole moved this to Ready in Docs Project Jun 11, 2024
@hamir-suspect hamir-suspect moved this from Ready to In progress in Docs Project Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation docusaurus Issue related to our docs engine help wanted Extra attention is needed
Projects
Status: Backlog
Development

No branches or pull requests

2 participants