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

[DOCS] improve cmd docs helper #38

Merged
merged 1 commit into from
Sep 14, 2024
Merged

[DOCS] improve cmd docs helper #38

merged 1 commit into from
Sep 14, 2024

Conversation

nicolastakashi
Copy link
Collaborator

This pull request focuses on improving the documentation and command descriptions for the poctl tool, enhancing clarity and providing more detailed explanations of its functionalities. The most important changes include updated descriptions for the analyze and create commands, as well as revisions to the overall tool description.

Documentation Improvements:

  • Documentation/commands/analyze/index.md: Enhanced the description of the analyze command to emphasize its role in assessing the health of Prometheus Operator resources and providing actionable insights.

Command Descriptions:

  • cmd/analyze.go: Updated the Short and Long descriptions of the analyze command to highlight its capabilities in detecting misconfigurations and optimizing monitoring setups.
  • cmd/create.go: Revised the Short and Long descriptions of the create command to better explain its function in generating Prometheus Operator resources and simplifying configuration processes.

README Enhancements:

  • README.md: Improved the overall description of poctl, detailing its purpose in managing Prometheus Operator resources and streamlining deployment, troubleshooting, and validation processes. [1] [2]

Root Command Description:

  • cmd/root.go: Updated the Short and Long descriptions of the root command to reflect the enhanced capabilities and user benefits of using poctl.

Signed-off-by: Nicolas Takashi <nicolas.tcs@hotmail.com>
@nicolastakashi nicolastakashi merged commit 2091d3b into main Sep 14, 2024
4 checks passed
@nicolastakashi nicolastakashi deleted the refactory/cmd-docs branch September 14, 2024 18:49
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.

1 participant