Skip to content

generate docs for our CRDs #70

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

Merged
merged 2 commits into from
Jun 2, 2025
Merged

generate docs for our CRDs #70

merged 2 commits into from
Jun 2, 2025

Conversation

xrstf
Copy link
Contributor

@xrstf xrstf commented Jun 2, 2025

Summary

This adapts kcp's CRD generator to this repository. Fixes #59

I also improved our GitHub Action to use mkdocs strict mode, which will now actually do what the Action intended: validate the docs and exit with a non-zero error. To make this actually work, I also had to randomly update a plugin.

What Type of PR Is This?

/kind documentation

Release Notes

NONE

On-behalf-of: @SAP christoph.mewes@sap.com
@kcp-ci-bot kcp-ci-bot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. dco-signoff: yes Indicates the PR's author has signed the DCO. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 2, 2025
@xrstf xrstf force-pushed the api-docs branch 2 times, most recently from 517988c to 24e8702 Compare June 2, 2025 12:44
…updating some plugin

On-behalf-of: @SAP christoph.mewes@sap.com
@xrstf xrstf requested a review from embik June 2, 2025 12:48
@xrstf
Copy link
Contributor Author

xrstf commented Jun 2, 2025

/retest

Copy link
Member

@embik embik left a comment

Choose a reason for hiding this comment

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

/approve

@kcp-ci-bot kcp-ci-bot added the lgtm Indicates that a PR is ready to be merged. label Jun 2, 2025
@kcp-ci-bot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 9a3c098d8a914a59a9d6b2955b15d0e00da6f9bf

@kcp-ci-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: embik

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kcp-ci-bot kcp-ci-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 2, 2025
@kcp-ci-bot kcp-ci-bot merged commit 9725f26 into main Jun 2, 2025
8 of 9 checks passed
@kcp-ci-bot kcp-ci-bot deleted the api-docs branch June 2, 2025 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates the PR's author has signed the DCO. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feature: publish generated API docs for api-syncagent
3 participants