Skip to content

docs: Add cmdref for cilium-cli #40017

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 1 commit into from
Jun 13, 2025
Merged

docs: Add cmdref for cilium-cli #40017

merged 1 commit into from
Jun 13, 2025

Conversation

HadrienPatte
Copy link
Member

@HadrienPatte HadrienPatte commented Jun 12, 2025 •
edited
Loading

Add generated documentation for the cilium CLI.

Additional updates:

  • Update .gitattributes to have github display the diff for .rst files under Documentation/cmdref as those are not autogenerated
  • Rework the indexes under Documentation/cmdref to have one main index and one sub-index per CLI to replace the current very large cli_index page.

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!
docs: Add cmdref for cilium-cli

@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 Jun 12, 2025
@github-actions github-actions bot added the cilium-cli This PR contains changes related with cilium-cli label Jun 12, 2025
@HadrienPatte HadrienPatte force-pushed the cilium-cli-cmdref branch 3 times, most recently from 3ed9989 to ca26715 Compare June 12, 2025 19:16
@HadrienPatte HadrienPatte marked this pull request as ready for review June 12, 2025 19:28
@HadrienPatte HadrienPatte requested review from a team as code owners June 12, 2025 19:28
@HadrienPatte HadrienPatte requested a review from a team as a code owner June 12, 2025 20:58
mhofstetter
mhofstetter reviewed Jun 13, 2025
View reviewed changes
Copy link
Member

@mhofstetter mhofstetter left a comment

Choose a reason for hiding this comment

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

Nice, thanks a lot! I left some comments / thoughts that came to my mind when I compared the new with the existing cmd ref.

@mhofstetter mhofstetter added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. labels Jun 13, 2025
@maintainer-s-little-helper maintainer-s-little-helper bot removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Jun 13, 2025
@mhofstetter mhofstetter added the kind/enhancement This would improve or streamline existing functionality. label Jun 13, 2025
mhofstetter
mhofstetter reviewed Jun 13, 2025
View reviewed changes
@HadrienPatte HadrienPatte force-pushed the cilium-cli-cmdref branch 2 times, most recently from 5449dc1 to a8d5a66 Compare June 13, 2025 10:00
mhofstetter
mhofstetter approved these changes Jun 13, 2025
View reviewed changes
Copy link
Member

@mhofstetter mhofstetter 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 again!

qmonnet
qmonnet approved these changes Jun 13, 2025
View reviewed changes
Copy link
Member

@qmonnet qmonnet 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, thanks for this work! And thanks Marco for the thorough review

@qmonnet
Copy link
Member

qmonnet commented Jun 13, 2025

/test

@HadrienPatte
docs: Add cmdref for cilium-cli
75a6751 
Signed-off-by: Hadrien Patte <hadrien.patte@datadoghq.com>
@HadrienPatte
Copy link
Member Author

/test

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jun 13, 2025
@joestringer joestringer added this pull request to the merge queue Jun 13, 2025
Merged via the queue into cilium:main with commit 0d66eb7 Jun 13, 2025
68 checks passed
@HadrienPatte HadrienPatte deleted the cilium-cli-cmdref branch June 16, 2025 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rolinh rolinh rolinh approved these changes

@mhofstetter mhofstetter mhofstetter approved these changes

@qmonnet qmonnet qmonnet approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. cilium-cli This PR contains changes related with cilium-cli kind/enhancement This would improve or streamline existing functionality. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. 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.
5 participants
@HadrienPatte @qmonnet @rolinh @mhofstetter @joestringer