Kubernetes Contributor Site

This repository contains the Hugo site and generator scripts for the Kubernetes Contributor site. In the future, the site will be available at https://contributors.kubernetes.io. For now, you can access the in-progress site at https://kubernetes-contributor.netlify.com.

Site content

The content for the Contributor Site is sourced from multiple locations. Content managed within this repository is generated from generated from Markdown found within the content directory. To update the site's content, make changes to the Markdown sources and submit a pull request to this repository.

Some content is externally sourced and changes to that must be made in the original location. A list of sources and their locations within the content is available below:

External sources

• Source: https://git.k8s.io/community/contributors/guide
  Destination: /guide

Running the site locally

To develop site content, you can run the site locally using Hugo in two ways:

1. Inside a Docker container
2. Natively (not inside a Docker container)

When you make changes to the site's content, Hugo will automatically update the site and refresh your browser window.

Using Docker

The easiest and most cross-system-compatible way to run the Contributor Site is to use Docker. To begin, create the docker image to be used with generating the site by executing make docker-image.

To ensure you can view the site with externally sourced content, run make docker-gen-content before previewing the site by with make docker-server.

Natively

For instructions on installing and using Hugo, see the Hugo Documentation.

To run the site locally using an installed Hugo executable, run make server.

YouTube embeds

You can embed YouTube videos on pages using the youtube shortcode and specifying the unique ID of the video. Here's an example:

Check out this cool video:

{{< youtube 6cCEmAisx8A >}}

This embed would take up the full width of the surrounding element. You can specify a smaller width as a percentage by changing the second argument. This embed, for example, would occupy 70% of the width:

Check out this cool video:

{{< youtube 6cCEmAisx8A 70 >}}

Community, discussion, contribution, and support

This project is managed by SIG Contributor Experience as a part of KEP-0005

You can reach the maintainers of this project at:

• Slack
• Mailing List

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.