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

ci,go.*: Remove the gen-crd-api-reference-docs tool #10561

Closed

Conversation

timflannagan
Copy link
Member

Description

Remove the unused github.com/ahmetb/gen-crd-api-reference-docs tool. We use the fybrik.io/crdoc tool right now.

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

@timflannagan timflannagan force-pushed the chore/remove-unnused-tool branch from 6376364 to b9a5889 Compare January 30, 2025 22:50
@timflannagan timflannagan changed the title ci,go.*: Remove the github.com/ahmetb/gen-crd-api-reference-docs tool ci,go.*: Remove the gen-crd-api-reference-docs tool Jan 30, 2025
@timflannagan timflannagan force-pushed the chore/remove-unnused-tool branch from b9a5889 to d076db9 Compare January 30, 2025 23:32
sigs.k8s.io/yaml v1.4.0
)

require (
Copy link
Contributor

Choose a reason for hiding this comment

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

just curious why did these get broken out into a new require block?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm on my phone, but it looks like I messed up with the merge conflicts when updating the branch 😢 .

/hold

@yuval-k
Copy link
Contributor

yuval-k commented Jan 31, 2025

we actually may want to swap fybrik.io/crdoc wiith github.com/ahmetb/gen-crd-api-reference-docs. looking at the docs crdoc generates, i don't see the comments making it to the final docs

@timflannagan
Copy link
Member Author

Closing until decision on #10568 is made.

@timflannagan timflannagan deleted the chore/remove-unnused-tool branch January 31, 2025 21:09
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.

3 participants