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

Umbrella Issue: A part of docs has some issues, is inconsistent, and should be improved #533

Open
1Shubham7 opened this issue May 14, 2024 · 2 comments

Comments

@1Shubham7
Copy link
Contributor

1Shubham7 commented May 14, 2024

PRs related to this issue:

  1. Docs: Improving the install with keadm documentation #544
  2. Docs: Improving the install with binary docs #558
  3. Replacing Twitter with X #543
  4. Docs: Improving the HA CloudCore docs #559
  5. Docs: Improving the CloudCore && EdgeCore Config docs #564
  6. Docs: Improving the 'Upgrading KubeEdge' docs #565
  7. Bug: We need to fix some links for local development #567
  8. Docs: Improving the Developer build guide #568

Is your feature request related to a problem? Please describe.

There are inconsistencies, Grammatical mistakes and misspells in the current documentation. Apart from that it can generally also be improved to make it easier to understand.

And sentences are not phrased in a proper manner (In my opinion). for example:

Keadm is used to install the cloud and edge components of KubeEdge. It is not responsible for installing K8s and runtime.

Please refer [kubernetes-compatibility](https://github.com/kubeedge/kubeedge#kubernetes-compatibility) to get **Kubernetes compatibility** and determine what version of Kubernetes would be installed.

## Limitation

- Need super user rights (or root rights) to run.

can be rephrased as :

Keadm is used to install the cloud and edge components of KubeEdge. It does not handle the installation of K8s and its runtime environment.

Please refer to [kubernetes-compatibility](https://github.com/kubeedge/kubeedge#kubernetes-compatibility) documentation to check **Kubernetes compatibility** and ascertain the Kubernetes version to be installed.

## Limitation

- Needs super user rights (or root rights) to run.

Describe the solution you'd like

There are more such examples I am finding as I keep of reading more documentation. I can rephrase at least some part of docs if the maintainers are up for it.

Describe alternatives you've considered
Alternative would be to at least fix grammatical mistakes and inconsistencies.

@fujitatomoya
Copy link
Contributor

@1Shubham7 i believe that is really nice to address your points. i am happy to help review !!!

@1Shubham7 1Shubham7 changed the title Docs: A part of docs has some issues, is inconsistent, and should be rephrased Umbrella Issue: A part of docs has some issues, is inconsistent, and should be improved May 17, 2024
@1Shubham7
Copy link
Contributor Author

1Shubham7 commented Jun 4, 2024

@fujitatomoya @wbc6080 @fisherxu @Shelley-BaoYue , I have made some PRs under this issue, please give your suggestions whenever you have time.

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

No branches or pull requests

2 participants