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

Enhance the doc #1152

Closed
mkumatag opened this issue Mar 10, 2023 · 2 comments · Fixed by #1324
Closed

Enhance the doc #1152

mkumatag opened this issue Mar 10, 2023 · 2 comments · Fixed by #1324
Assignees
Labels
area/provider/ibmcloud Issues or PRs related to ibmcloud provider good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation.
Milestone

Comments

@mkumatag
Copy link
Member

/kind cleanup
/kind doc
/area provider/ibmcloud

What steps did you take and what happened:
[A clear and concise description of what the bug is.]

What did you expect to happen:

Anything else you would like to add:
[Miscellaneous information that will assist in solving the issue.]

Environment:

  • Cluster-api version:
  • Minikube/KIND version:
  • Kubernetes version: (use kubectl version):
  • OS (e.g. from /etc/os-release):
@k8s-ci-robot k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. area/provider/ibmcloud Issues or PRs related to ibmcloud provider labels Mar 10, 2023
@k8s-ci-robot
Copy link
Contributor

@mkumatag: The label(s) kind/doc cannot be applied, because the repository doesn't have them.

In response to this:

/kind cleanup
/kind doc
/area provider/ibmcloud

What steps did you take and what happened:
[A clear and concise description of what the bug is.]

What did you expect to happen:

Anything else you would like to add:
[Miscellaneous information that will assist in solving the issue.]

Environment:

  • Cluster-api version:
  • Minikube/KIND version:
  • Kubernetes version: (use kubectl version):
  • OS (e.g. from /etc/os-release):

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@mkumatag mkumatag added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 10, 2023
@mkumatag mkumatag added this to the v0.5 milestone Mar 10, 2023
@mkumatag mkumatag modified the milestones: v0.5, Next Apr 21, 2023
@mkumatag mkumatag modified the milestones: Next, v0.6 May 19, 2023
@mkumatag mkumatag added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels May 19, 2023
@Amulyam24
Copy link
Contributor

The CAPIBM doc needs to be enhanced to ensure easy understanding by users. The data is not well organized into sections or subsections, lacks indentation, and can make proper use of quoted blocks to highlight important notes. A good starting point for improvements would be the getting started page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/provider/ibmcloud Issues or PRs related to ibmcloud provider good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants