Open 1Shubham7 opened 1 month ago
@1Shubham7 i believe that is really nice to address your points. i am happy to help review !!!
@fujitatomoya @wbc6080 @fisherxu @Shelley-BaoYue , I have made some PRs under this issue, please give your suggestions whenever you have time.
PRs related to this issue:
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.
I see some inconsistencies in the docs. For example: at https://kubeedge.io/docs/setup/install-with-keadm/ ,
keadm
is sometimes referred as Keadm and sometimes as keadmGrammatical errors: (link)
Need super user rights (or root rights) to run.
-> It should be Needs.And sentences are not phrased in a proper manner (In my opinion). for example:
can be rephrased as :
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.