Update README.md #48705
Update README.md #48705
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
sig/docs
k8s-ci-robot
added
the
cncf-cla: no
|
Welcome @Priyanka0300! |
k8s-ci-robot
added
size/L
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
I'm uncertain if the formatting of the prerequisites section aligns with our style guide. Any suggestions on this would be appreciated! |
README.md
Outdated
|
|
||
| ## Prerequisites | ||
|
|
||
| To use this repository, you need the following installed locally: | ||
| To use this repository, you'll need: |
There was a problem hiding this comment.
I don't think there's anything in the style guide, but to make it maybe easier for non-English speakers, it might be better to not use contractions and say "you will need".
There was a problem hiding this comment.
Thank you for taking the time to review my work and provide feedback! I really appreciate your input . I’ve made the updates as you suggested .Let me know if there’s anything else you notice
README.md
Outdated
|
|
||
| ## Table of Contents | ||
| 1. [Using This Repository](#using-this-repository) | ||
| 2. [Prerequisites](#prerequisites) |
There was a problem hiding this comment.
Please try avoid using explicit numbers in an ordered list. I.e.,
| 2. [Prerequisites](#prerequisites) | |
| 1. [Prerequisites](#prerequisites) |
Actually, I don't think we want an ordered list here because the sections below may
be changed in the future. This order of section is not stable. So an unordered list
sounds better.
| 2. [Prerequisites](#prerequisites) | |
| - [Prerequisites](#prerequisites) |
There was a problem hiding this comment.
I have made the suggested changes in the file .Thank you for taking the time to review my work and provide feedback! I really appreciate your input .
README.md
Outdated
|
|
||
| ## Using this repository | ||
|
|
||
| You can run the website locally using [Hugo (Extended version)](https://gohugo.io/), or you can run it in a container runtime. We strongly recommend using the container runtime, as it gives deployment consistency with the live website. | ||
| Run the website locally using [Hugo (Extended version)](https://gohugo.io/), or in a container runtime (recommend for deployment consistency with the live site). |
There was a problem hiding this comment.
Removing the subjective is not necessary. We have to add back the subjective when,
for example, translating this to some languages.
Without a subjective, the sentence becomes imperative, which is not always appropriate.
README.md
Outdated
| git clone https://github.com/kubernetes/website.git | ||
| cd website | ||
| ``` | ||
| **Initial Setup** |
There was a problem hiding this comment.
Please try use subsection headers instead of this kind of "informal headers".
README.md
Outdated
|
|
||
| The Kubernetes website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme). Even if you plan to run the website in a container, we strongly recommend pulling in the submodule and other development dependencies by running the following: | ||
| 1. **Clone the Repository**: |
There was a problem hiding this comment.
Why indent this line with a space?
Space is meaningful in markdown.
There was a problem hiding this comment.
I have made all the changes as you have suggested above . Thank you for your valuable feedback.
Pull Request: Updates to Kubernetes Documentation
Overview
This pull request includes updates to the Kubernetes documentation to improve clarity and ensure consistency across the site. The changes involve restructuring the instructions, improving formatting, and adding additional explanations to certain sections.
Key Changes:
Requesting Feedback
I would greatly appreciate feedback on the README.md file.
Next Steps
Once I receive feedback, I will address any comments or suggestions and make necessary updates to the documentation.
Thank you for taking the time to review this PR!
Closes: #41989