Skip to content

Add cmdref generated documentation for clustermesh-apiserver #36205

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Nov 28, 2024
Merged

Add cmdref generated documentation for clustermesh-apiserver #36205

merged 4 commits into from
Nov 28, 2024

Conversation

HadrienPatte
Copy link
Member

@HadrienPatte HadrienPatte commented Nov 27, 2024 •
edited
Loading

Please ensure your pull request adheres to the following guidelines:

  • For first time contributors, read Submitting a pull request
  • All code is covered by unit and/or runtime tests where feasible.
  • All commits contain a well written commit description including a title,
    description and a Fixes: #XXX line if the commit addresses a particular
    GitHub issue.
  • If your commit description contains a Fixes: <commit-id> tag, then
    please add the commit author[s] as reviewer[s] to this issue.
  • All commits are signed off. See the section Developer’s Certificate of Origin
  • Provide a title or release-note blurb suitable for the release notes.
  • Are you a user of Cilium? Please add yourself to the Users doc
  • Thanks for contributing!

This PR updates the clustermesh-apiserver CLI to allow it to generate its cmdref and updates the documentation with that newly generated cmdref.

Add cmdref generated documentation for clustermesh-apiserver

@HadrienPatte HadrienPatte requested review from a team as code owners November 27, 2024 13:48
@HadrienPatte HadrienPatte requested review from a user and giorio94 November 27, 2024 13:48
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Nov 27, 2024
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Nov 27, 2024
giorio94
giorio94 requested changes Nov 27, 2024
View reviewed changes
Copy link
Member

@giorio94 giorio94 left a comment

Choose a reason for hiding this comment

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

Thanks! A couple of comments inline.

giorio94
giorio94 approved these changes Nov 27, 2024
View reviewed changes
Copy link
Member

@giorio94 giorio94 left a comment

Choose a reason for hiding this comment

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

Looks great to me, thanks!
Could you please just squash the new commits into the old ones?

@HadrienPatte
clustermesh-apiserver: update CLI to generate cmdref
3b3adc9 
Signed-off-by: Hadrien Patte <hadrien.patte@datadoghq.com>
@HadrienPatte
clustermesh-apiserver: generate cmdref documentation
6613d45 
Generated by running clustermesh-apiserver --cmdref

Signed-off-by: Hadrien Patte <hadrien.patte@datadoghq.com>
@HadrienPatte HadrienPatte force-pushed the clustermesh-apiserver-cmdref branch from a3c82b5 to 6613d45 Compare November 27, 2024 16:49
@HadrienPatte
Copy link
Member Author

Thanks for the review, I squashed the commits

ghost
ghost approved these changes Nov 27, 2024
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

lgtm, thanks!

@giorio94
Copy link
Member

/test

@giorio94 giorio94 added area/clustermesh Relates to multi-cluster routing functionality in Cilium. release-note/misc This PR makes changes that have no direct user impact. labels Nov 27, 2024
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Nov 27, 2024
@HadrienPatte
clustermesh-apiserver: fix spelling
6d2abd0 
Fix "Initialise" spelling in clustermesh-apiserver etcdinit command and
add "etcdinit" to spelling wordlist.

See https://github.com/cilium/cilium/actions/runs/12054803453/job/33614531375?pr=36205

Signed-off-by: Hadrien Patte <hadrien.patte@datadoghq.com>
@HadrienPatte
clustermesh-apiserver: add clustermesh-apiserver to main Makefile
df42f50 
This is necessary to ensure that the clustermesh-apiserver binary gets
built in order to generate its cmdref documentation.

See https://github.com/cilium/cilium/actions/runs/12054803453/job/33614523855?pr=36205

Signed-off-by: Hadrien Patte <hadrien.patte@datadoghq.com>
@HadrienPatte HadrienPatte requested a review from a team as a code owner November 27, 2024 19:29
@HadrienPatte
Copy link
Member Author

I pushed 6d2abd0 to fix this CI failure and df42f50 to fix this one. But I'm not quite sure how/if these two are related to my changes:

@giorio94
Copy link
Member

I pushed 6d2abd0 to fix this CI failure and df42f50 to fix this one. But I'm not quite sure how/if these two are related to my changes

Thanks!

There is some automatic spell checking that is performed against the documentation, which apparently also applies to the autogenerated cmdref. And, for the second one, it has probably been missing forever, but it didn't matter because we never relied on make build to also build the clustermesh images (it is instead necessary now to generate the 'cmdref`).

@giorio94
Copy link
Member

/test

@aanm aanm enabled auto-merge November 28, 2024 14:15
@aanm aanm added this pull request to the merge queue Nov 28, 2024
Merged via the queue into cilium:main with commit 0db6049 Nov 28, 2024
68 checks passed
@HadrienPatte HadrienPatte deleted the clustermesh-apiserver-cmdref branch November 28, 2024 19:26
@HadrienPatte HadrienPatte mentioned this pull request Jan 13, 2025
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aanm aanm aanm approved these changes

@giorio94 giorio94 giorio94 approved these changes

@borkmann borkmann Awaiting requested review from borkmann borkmann is a code owner automatically assigned from cilium/build

+1 more reviewer
Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
area/clustermesh Relates to multi-cluster routing functionality in Cilium. kind/community-contribution This was a contribution made by a community member. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@HadrienPatte @giorio94 @aanm