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

Added the new antctl check command documentation #6373

Merged
merged 5 commits into from
May 31, 2024

Conversation

kanha-gupta
Copy link
Contributor

Added documentation for the new antctl check command.

Signed-off-by: Kanha gupta <kanhag4163@gmail.com>
Signed-off-by: Kanha gupta <kanhag4163@gmail.com>
docs/antctl.md Outdated Show resolved Hide resolved
docs/antctl.md Outdated Show resolved Hide resolved
docs/antctl.md Show resolved Hide resolved
docs/antctl.md Outdated Show resolved Hide resolved
Signed-off-by: Kanha gupta <kanhag4163@gmail.com>
@kanha-gupta
Copy link
Contributor Author

Please review. changes have been pushed

docs/antctl.md Outdated Show resolved Hide resolved
docs/antctl.md Outdated Show resolved Hide resolved
docs/antctl.md Outdated Show resolved Hide resolved
Signed-off-by: Kanha gupta <kanhag4163@gmail.com>
Copy link
Contributor

@antoninbas antoninbas left a comment

Choose a reason for hiding this comment

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

Only nits from me. Overall it looks good.
Maybe it's a bit early for this now, but as we keep improving this tool it may make sense to add a reference to it in getting-started.md

docs/antctl.md Outdated Show resolved Hide resolved
docs/antctl.md Outdated Show resolved Hide resolved
docs/antctl.md Outdated Show resolved Hide resolved
docs/antctl.md Outdated Show resolved Hide resolved
docs/antctl.md Outdated Show resolved Hide resolved
docs/antctl.md Outdated Show resolved Hide resolved
@antoninbas antoninbas added the kind/documentation Categorizes issue or PR as related to a documentation. label May 30, 2024
Signed-off-by: Kanha gupta <kanhag4163@gmail.com>
@kanha-gupta
Copy link
Contributor Author

Only nits from me. Overall it looks good. Maybe it's a bit early for this now, but as we keep improving this tool it may make sense to add a reference to it in getting-started.md

Can we add reference with a beta tag on it ? I believe that even its early, It would be very helpful while setup

Copy link
Member

@tnqn tnqn left a comment

Choose a reason for hiding this comment

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

LGTM

@antoninbas
Copy link
Contributor

Only nits from me. Overall it looks good. Maybe it's a bit early for this now, but as we keep improving this tool it may make sense to add a reference to it in getting-started.md

Can we add reference with a beta tag on it ? I believe that even its early, It would be very helpful while setup

I think it's better to wait for a release before updating getting-started.md. Let's keep adding a few more tests and keep on enhancing the tool. We will mention the new commands in the release notes for Antrea v2.1 though.
When we update getting-started.md, we should also update the NOTES for the Antrea Helm chart, to suggest that users run the antctl check installation command after a successful installation.

@antoninbas antoninbas merged commit 264372d into antrea-io:main May 31, 2024
47 of 54 checks passed
@antoninbas antoninbas added the action/release-note Indicates a PR that should be included in release notes. label May 31, 2024
@luolanzone luolanzone added this to the Antrea v2.1 release milestone Jun 3, 2024
@kanha-gupta kanha-gupta deleted the antctl-docs branch June 5, 2024 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
action/release-note Indicates a PR that should be included in release notes. kind/documentation Categorizes issue or PR as related to a documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants