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

Generate API docs #1884

Merged
merged 7 commits into from
Jun 10, 2024
Merged

Generate API docs #1884

merged 7 commits into from
Jun 10, 2024

Conversation

lucacome
Copy link
Member

@lucacome lucacome commented Apr 25, 2024

Proposed changes

Problem: We want to have our CRDs documented

Solution: Use gen-crd-api-reference-docs to automatically generate the
docs

Closes #1754

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

NONE

@github-actions github-actions bot added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file labels Apr 25, 2024
@lucacome lucacome force-pushed the docs/generate-api-docs branch 3 times, most recently from 9838a02 to 06d6744 Compare April 25, 2024 22:16
@lucacome lucacome marked this pull request as ready for review April 25, 2024 22:16
@lucacome lucacome requested review from a team as code owners April 25, 2024 22:16
@lucacome
Copy link
Member Author

@nginxinc/nginx-docs I need your help to make the new page look good 😅

@ADubhlaoich
Copy link
Contributor

@Jcahilltorre @travisamartin Any thoughts on the formatting issues for this generated API documentation?

I think there's some examples without these formatting issues in NGINX Management Suite, which are OpenAPI based IIRC.

@lucacome lucacome force-pushed the docs/generate-api-docs branch 3 times, most recently from dd7cb3a to 5916cb9 Compare May 1, 2024 18:49
Copy link

@jputrino jputrino left a comment

Choose a reason for hiding this comment

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

Docs solutions need to be discussed with the docs team before implementation and must align with the NGINX content standards. Please close this PR until it can be brought into alignment with how we publish API documentation for NGINX and F5 products.

@lucacome lucacome closed this May 17, 2024
@lucacome lucacome reopened this Jun 6, 2024
@lucacome lucacome force-pushed the docs/generate-api-docs branch 5 times, most recently from a611491 to 97b2501 Compare June 6, 2024 19:37
@lucacome lucacome requested review from a team and jputrino June 6, 2024 19:57
@sjberman
Copy link
Contributor

sjberman commented Jun 6, 2024

The issue with this structure is it's just in alphabetical order. I want to easily be able to delineate between the different policies and their sub-fields. Should be separated by policy.

A ToC for each policy would also help.

@lucacome lucacome force-pushed the docs/generate-api-docs branch 3 times, most recently from 0a24c09 to c61ae14 Compare June 6, 2024 22:58
@lucacome lucacome requested a review from a team June 6, 2024 23:00
@lucacome
Copy link
Member Author

lucacome commented Jun 6, 2024

Turns out there was a missing tag for the types, they're now showing correctly by policy

@lucacome lucacome requested a review from a team June 7, 2024 18:55
lucacome and others added 5 commits June 10, 2024 11:55
Problem: We want to have our CRDs documented

Solution: Use gen-crd-api-reference-docs to automatically generate the
docs
Co-authored-by: Danielle De Leo <[email protected]>
@lucacome lucacome requested review from pleshakov, sjberman and a team June 10, 2024 19:01
@lucacome lucacome dismissed jputrino’s stale review June 10, 2024 19:09

discussed offline

@lucacome lucacome enabled auto-merge (squash) June 10, 2024 19:10
site/config/api/config.json Outdated Show resolved Hide resolved
site/config/api/config.json Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Show resolved Hide resolved
Copy link
Contributor

@salonichf5 salonichf5 left a comment

Choose a reason for hiding this comment

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

lgtm

@lucacome lucacome merged commit eb2daaf into nginxinc:main Jun 10, 2024
41 checks passed
@lucacome lucacome deleted the docs/generate-api-docs branch July 2, 2024 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Auto-generate docs for NGF CRDs
9 participants