Skip to content

Update the Website Setup Instructions in Contributor Docs and README #49638

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
Merged
merged 1 commit into from
Feb 6, 2025
Merged

Update the Website Setup Instructions in Contributor Docs and README #49638

merged 1 commit into from
Feb 6, 2025

Conversation

@aman4433
Copy link
Contributor

@aman4433 aman4433 commented Feb 4, 2025

This PR updates the Kubernetes contributor documentation regarding the local setup for building and previewing the website. The current instructions are outdated due to recent changes in the Docsy theme and the build process. The steps for installing dependencies and building the site locally have been updated to reflect the new, correct process.

Changes:
Revise instructions for installing the Docsy theme.
Update the README to include the correct steps for setting up the project.
Clarify the build process using npm ci and make serve to preview changes locally.

This update ensures that contributors can successfully follow the steps for local development and avoid issues caused by the previous setup instructions.

Closes: #49627

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 4, 2025
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Feb 4, 2025
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Feb 4, 2025

Welcome @aman4433!

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 the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 4, 2025
@netlify
Copy link

netlify bot commented Feb 4, 2025 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 9538fde
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67a3b17201a4f00008fb6b6f
😎 Deploy Preview https://deploy-preview-49638--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.

sftim
sftim reviewed Feb 4, 2025
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks. The change to content/en/docs/contribute/new-content/open-a-pr.md is the most important thing to cover here.

shannonxtreme
shannonxtreme reviewed Feb 4, 2025
View reviewed changes
Copy link
Contributor

@shannonxtreme shannonxtreme left a comment

Choose a reason for hiding this comment

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

This already looks great. Provided some comments about requirements and splitting a comment in a code block into its own code block. Thanks!

README.md Outdated
```

The Kubernetes website uses git submodules. 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:
The Kubernetes website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme),which can be installed via npm. You can also download a pre-configured development container image that includes Hugo and Docsy. Additionally, a Git submodule is used for tools that generate the reference documentation.
Copy link
Contributor

@shannonxtreme shannonxtreme Feb 4, 2025

Choose a reason for hiding this comment

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

@sftim wasn't there a recent change to remove the Hugo dependency from the container image?

shannonxtreme
shannonxtreme reviewed Feb 5, 2025
View reviewed changes
Copy link
Contributor

@shannonxtreme shannonxtreme left a comment

Choose a reason for hiding this comment

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

This looks good as-is. I suggested a change for code style and accessibility

@shannonxtreme
Copy link
Contributor

shannonxtreme commented Feb 5, 2025

This looks good to me. Thanks for working on this!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 5, 2025
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Feb 5, 2025

LGTM label has been added.

Git tree hash: ed405f240275caf36aaa8f4da39b58e1a0084e33

@sftim
Copy link
Contributor

sftim commented Feb 6, 2025

/approve

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Feb 6, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 6, 2025
@k8s-ci-robot k8s-ci-robot merged commit 70a8ccd into kubernetes:main Feb 6, 2025
6 checks passed
@aman4433 aman4433 mentioned this pull request Sep 9, 2025
Closed
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@katcosgrove katcosgrove Awaiting requested review from katcosgrove

@salaxander salaxander Awaiting requested review from salaxander

@sftim sftim Awaiting requested review from sftim

1 more reviewer

@shannonxtreme shannonxtreme shannonxtreme left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@shannonxtreme shannonxtreme

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Website guidance for staging docs is outdated

4 participants

@aman4433 @k8s-ci-robot @shannonxtreme @sftim