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
+96 −95
Open

Update README.md #48705

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
520eaca
Add visuals to README.md
Priyanka0300 Nov 12, 2024
1af78a2
made changes
Priyanka0300 Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
191 changes: 96 additions & 95 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,181 +1,176 @@
# The Kubernetes documentation

[![Netlify Status](https://api.netlify.com/api/v1/badges/be93b718-a6df-402a-b4a4-855ba186c97d/deploy-status)](https://app.netlify.com/sites/kubernetes-io-main-staging/deploys) [![GitHub release](https://img.shields.io/github/release/kubernetes/website.svg)](https://github.com/kubernetes/website/releases/latest)
[![Netlify Status](https://api.netlify.com/api/v1/badges/be93b718-a6df-402a-b4a4-855ba186c97d/deploy-status)](https://app.netlify.com/sites/kubernetes-io-main-staging/deploys) [![GitHub release](https://img.shields.io/github/release/kubernetes/website.svg)](https://github.com/kubernetes/website/releases/latest)

Welcome! This repository contains the assets required to build the [Kubernetes website and documentation](https://kubernetes.io/). We're glad you're interested in contributing.

## Table of Contents
- [Using This Repository](#using-this-repository)
- [Prerequisites](#prerequisites)
- [Running the Website](#running-the-website)
- [Building the API Reference Pages](#building-the-api-reference-pages)
- [Troubleshooting](#troubleshooting)
- [Get Involved with SIG Docs](#get-involved-with-sig-docs)
- [Contributing to the Docs](#contributing-to-the-docs)
- [Localization READMEs](#localization-readmes)
- [Code of Conduct](#code-of-conduct)
- [Thank You!](#thank-you)

This repository contains the assets required to build the [Kubernetes website and documentation](https://kubernetes.io/). We're glad that you want to contribute!

- [Contributing to the docs](#contributing-to-the-docs)
- [Localization READMEs](#localization-readmes)

## 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.
You can run the website locally using [Hugo (Extended version)](https://gohugo.io/), or in a container runtime (recommended for deployment consistency with the live site).

## Prerequisites

To use this repository, you need the following installed locally:
To use this repository, you will need:

- [npm](https://www.npmjs.com/)
- [Go](https://go.dev/)
- [Hugo (Extended version)](https://gohugo.io/)
- A container runtime, like [Docker](https://www.docker.com/).

> [!NOTE]
Make sure to install the Hugo extended version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L11) file.
> [!NOTE]
Ensure you install the Hugo extended version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L11).

## Running the Website

Before you start, install the dependencies. Clone the repository and navigate to the directory:
### Initial Setup

1. **Clone the Repository**:

```bash
git clone https://github.com/kubernetes/website.git
cd website
```

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:
>[!Note]
The Kubernetes website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme).So, pulling in submodule is strongly recommended.

### Windows
2. **Initialize Submodules and Dependencies**:

```powershell
# fetch submodule dependencies
- **Windows**:

```bash
git submodule update --init --recursive --depth 1
```

### Linux / other Unix
- **Linux / Unix**:

```bash
# fetch submodule dependencies
make module-init
```

## Running the website using a container
### Running using a container

To build the site in a container, run the following:
1. **Build the site**:

```bash
# You can set $CONTAINER_ENGINE to the name of any Docker-like container tool
make container-serve
```
2. Open <http://localhost:1313> in a browser to view the website.

If you see errors, it probably means that the hugo container did not have enough computing resources available. To solve it, increase the amount of allowed CPU and memory usage for Docker on your machine ([MacOS](https://docs.docker.com/desktop/settings/mac/) and [Windows](https://docs.docker.com/desktop/settings/windows/)).
>[!Note]
If you see errors, increase the amount of allowed CPU and memory usage for Docker on your machine ([MacOS](https://docs.docker.com/desktop/settings/mac/) and [Windows](https://docs.docker.com/desktop/settings/windows/)).

Open up your browser to <http://localhost:1313> to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh.
### Running Locally using Hugo

## Running the website locally using Hugo
To install dependencies, deploy and test the site:

To install dependencies, deploy and test the site locally, run:
- **macOS/Linux**:

- For macOS and Linux
```bash
npm ci
make serve
```

```bash
npm ci
make serve
```
- **Windows (PowerShell)**:

- For Windows (PowerShell)
```powershell
npm ci
hugo.exe server --buildFuture --environment development
```

```powershell
npm ci
hugo.exe server --buildFuture --environment development
```
Visit <http://localhost:1313> to see your changes.

This will start the local Hugo server on port 1313. Open up your browser to <http://localhost:1313> to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh.

## Building the API reference pages
## Updating API Reference Pages

The API reference pages located in `content/en/docs/reference/kubernetes-api` are built from the Swagger specification, also known as OpenAPI specification, using <https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs>.
The API reference pages are built from the Swagger (OpenAPI) specification using [gen-resourcesdocs](https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs).

To update the reference pages for a new Kubernetes release follow these steps:
### Steps to Update for a New Kubernetes Release:

1. Pull in the `api-ref-generator` submodule:
1. **Pull in the api-ref-generator submodule**:
```bash
git submodule update --init --recursive --depth 1
```

```bash
git submodule update --init --recursive --depth 1
```
2. **Update the Swagger specification**:

2. Update the Swagger specification:
```bash
curl 'https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-assets/api/swagger.json
```

```bash
curl 'https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-assets/api/swagger.json
```
3. **Update the configuration files** (`toc.yaml` and `fields.yaml`) in `api-ref-assets/config/` to reflect the new release.

3. In `api-ref-assets/config/`, adapt the files `toc.yaml` and `fields.yaml` to reflect the changes of the new release.
4. **Build the pages**:

4. Next, build the pages:
```bash
make api-reference
```

```bash
make api-reference
```
5. **Test locally by serving the site**:

You can test the results locally by building and serving the site from a container:
```bash
make container-serve
```

```bash
make container-serve
```
View at:<http://localhost:1313/docs/reference/kubernetes-api/>

In a web browser, go to <http://localhost:1313/docs/reference/kubernetes-api/> to view the API reference.
6. Once everything is updated, create a Pull Request with the new API reference pages.

5. When all changes of the new contract are reflected into the configuration files `toc.yaml` and `fields.yaml`, create a Pull Request with the newly generated API reference pages.

## Troubleshooting

### error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version

Hugo is shipped in two set of binaries for technical reasons. The current website runs based on the **Hugo Extended** version only. In the [release page](https://github.com/gohugoio/hugo/releases) look for archives with `extended` in the name. To confirm, run `hugo version` and look for the word `extended`.

### Troubleshooting macOS for too many open files

If you run `make serve` on macOS and receive the following error:
### TOCSS Error
-This issue occurs if the Hugo Extended version isn’t installed. Verify it shows `extended` by running:

```bash
ERROR 2020/08/01 19:09:18 Error: listen tcp 127.0.0.1:1313: socket: too many open files
make: *** [serve] Error 1
hugo version
```

Try checking the current limit for open files:

`launchctl limit maxfiles`

Then run the following commands (adapted from <https://gist.github.com/tombigel/d503800a282fcadbee14b537735d202c>):

```shell
#!/bin/sh

# These are the original gist links, linking to my gists now.
# curl -O https://gist.githubusercontent.com/a2ikm/761c2ab02b7b3935679e55af5d81786a/raw/ab644cb92f216c019a2f032bbf25e258b01d87f9/limit.maxfiles.plist
# curl -O https://gist.githubusercontent.com/a2ikm/761c2ab02b7b3935679e55af5d81786a/raw/ab644cb92f216c019a2f032bbf25e258b01d87f9/limit.maxproc.plist
-In the [release page](https://github.com/gohugoio/hugo/releases) look for archives with `extended` in the name.

curl -O https://gist.githubusercontent.com/tombigel/d503800a282fcadbee14b537735d202c/raw/ed73cacf82906fdde59976a0c8248cce8b44f906/limit.maxfiles.plist
curl -O https://gist.githubusercontent.com/tombigel/d503800a282fcadbee14b537735d202c/raw/ed73cacf82906fdde59976a0c8248cce8b44f906/limit.maxproc.plist
### Too Many Open Files(macOS)
-Check the open file limit:
```bash
launchctl limit maxfiles
```

sudo mv limit.maxfiles.plist /Library/LaunchDaemons
sudo mv limit.maxproc.plist /Library/LaunchDaemons
-Follow the [gist instructions](https://gist.github.com/tombigel/d503800a282fcadbee14b537735d202c) to increase the limit.

sudo chown root:wheel /Library/LaunchDaemons/limit.maxfiles.plist
sudo chown root:wheel /Library/LaunchDaemons/limit.maxproc.plist

sudo launchctl load -w /Library/LaunchDaemons/limit.maxfiles.plist
```

This works for Catalina as well as Mojave macOS.

## Get involved with SIG Docs

Learn more about SIG Docs Kubernetes community and meetings on the [community page](https://github.com/kubernetes/community/tree/master/sig-docs#meetings).
Learn more about [SIG Doc](https://github.com/kubernetes/community/blob/master/sig-docs/README.md) and join the Kubernetes community on Slack.

You can also reach the maintainers of this project at:

- [Slack](https://kubernetes.slack.com/messages/sig-docs)
- [Get an invite for this Slack](https://slack.k8s.io/)
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)

## Contributing to the docs

You can click the **Fork** button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a _fork_. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.
## Contributing to the Docs
Click the **Fork** button to create a copy of this repository in your GitHub account. Make any changes in your fork and, when ready, create a pull request.

Once your pull request is created, a Kubernetes reviewer will take responsibility for providing clear, actionable feedback. As the owner of the pull request, **it is your responsibility to modify your pull request to address the feedback that has been provided to you by the Kubernetes reviewer.**
Once submitted, a Kubernetes reviewer will provide feedback. As the PR owner, you are responsible for modifying the PR as needed.

Also, note that you may end up having more than one Kubernetes reviewer provide you feedback or you may end up getting feedback from a Kubernetes reviewer that is different than the one initially assigned to provide you feedback.
> [!Note]: Multiple reviewers may provide feedback. Reviewers will try to respond promptly, but response time may vary.

Furthermore, in some cases, one of your reviewers might ask for a technical review from a Kubernetes tech reviewer when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances.

For more information about contributing to the Kubernetes documentation, see:

Expand All @@ -185,14 +180,17 @@ For more information about contributing to the Kubernetes documentation, see:
- [Localizing Kubernetes Documentation](https://kubernetes.io/docs/contribute/localization/)
- [Introduction to Kubernetes Docs](https://www.youtube.com/watch?v=pprMgmNzDcw)

### New contributor ambassadors

If you need help at any point when contributing, the [New Contributor Ambassadors](https://kubernetes.io/docs/contribute/advanced/#serve-as-a-new-contributor-ambassador) are a good point of contact. These are SIG Docs approvers whose responsibilities include mentoring new contributors and helping them through their first few pull requests. The best place to contact the New Contributors Ambassadors would be on the [Kubernetes Slack](https://slack.k8s.io/). Current New Contributors Ambassadors for SIG Docs:
**New contributor ambassadors**

If you need help while contributing, the [New Contributor Ambassadors](https://kubernetes.io/docs/contribute/advanced/#serve-as-a-new-contributor-ambassador) are SIG Docs approvers who mentor new contributors. Contact them via [Kubernetes Slack](https://slack.k8s.io/). Current Ambassadors for SIG Docs:

| Name | Slack | GitHub |
| -------------------------- | -------------------------- | -------------------------- |
| Sreeram Venkitesh | @sreeram.venkitesh | @sreeram-venkitesh |

---

## Localization READMEs

| Language | Language |
Expand All @@ -206,10 +204,13 @@ If you need help at any point when contributing, the [New Contributor Ambassador
| [Italian](./content/it/README.md) | [Vietnamese](./content/vi/README.md) |
| [Japanese](./content/ja/README.md) | |



## Code of conduct

Participation in the Kubernetes community is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).

## Thank you

Kubernetes thrives on community participation, and we appreciate your contributions to our website and our documentation!
## Thank you!

Thank you for contributing to Kubernetes! Your support and participation make a difference.