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.

Sign up for GitHub

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

Jump to bottom

Update README.md #48705

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #48705

wants to merge 2 commits into from

Conversation

Priyanka0300
Copy link

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:

  • Updated instructions to make the setup process clearer for new users.
  • Improved formatting for consistency with the rest of the documentation.
  • Added examples and clarifications where needed.

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

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Nov 12, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign sftim for approval. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Nov 12, 2024
@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Nov 12, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @Priyanka0300!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 12, 2024
@netlify Netlify
Copy link

netlify bot commented Nov 12, 2024 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 1af78a2
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6734a0e9b47b37000867df6c
😎 Deploy Preview https://deploy-preview-48705--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Priyanka0300
Copy link
Author

I'm uncertain if the formatting of the prerequisites section aligns with our style guide. Any suggestions on this would be appreciated!

stmcginnis
stmcginnis reviewed Nov 12, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
stmcginnis
stmcginnis reviewed Nov 12, 2024
View reviewed changes
Copy link
Contributor

@stmcginnis stmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me, just a couple minor comments.

README.md Outdated

## Prerequisites

To use this repository, you need the following installed locally:
To use this repository, you'll need:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

tengqm
tengqm reviewed Nov 13, 2024
View reviewed changes
README.md Outdated

## Table of Contents
1. [Using This Repository](#using-this-repository)
2. [Prerequisites](#prerequisites)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please try avoid using explicit numbers in an ordered list. I.e.,

Suggested change
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.

Suggested change
2. [Prerequisites](#prerequisites)
- [Prerequisites](#prerequisites)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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**:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why indent this line with a space?
Space is meaningful in markdown.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have made all the changes as you have suggested above . Thank you for your valuable feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tengqm tengqm tengqm left review comments

@stmcginnis stmcginnis stmcginnis left review comments

@reylejano reylejano Awaiting requested review from reylejano

@salaxander salaxander Awaiting requested review from salaxander

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[hi] Enhance README file to improve readability and user-friendliness
4 participants
@Priyanka0300 @k8s-ci-robot @stmcginnis @tengqm