From 338d6df8eba72db6fc5a16819fc58355c4583f28 Mon Sep 17 00:00:00 2001 From: Jim Angel Date: Sun, 19 Apr 2020 23:41:32 -0500 Subject: [PATCH] improving readme --- README.md | 108 +++++++++++++++++++++++------------------------------- 1 file changed, 45 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index ebd864bdc8..3329b1a8c3 100644 --- a/README.md +++ b/README.md @@ -1,83 +1,65 @@ # The Kubernetes documentation -[![Build Status](https://api.travis-ci.org/kubernetes/website.svg?branch=master)](https://travis-ci.org/kubernetes/website) -[![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-master-staging/deploys) [![GitHub release](https://img.shields.io/github/release/kubernetes/website.svg)](https://github.com/kubernetes/website/releases/latest) -Welcome! This repository houses all of the assets required to build the [Kubernetes website and documentation](https://kubernetes.io/). We're glad that you want to contribute! +This repository contains the assets required to build the [Kubernetes website and documentation](https://kubernetes.io/). We're glad that you want to contribute! + +## Running the website locally using Hugo + +See the [official Hugo documentation](https://gohugo.io/getting-started/installing/) for Hugo installation instructions. Make sure to install the Hugo extended version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L10) file. + +To run the website locally when you have Hugo installed: + +```bash +git clone https://github.com/kubernetes/website.git +cd website +hugo server --buildFuture +``` + +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. + +## 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). + +You can also reach the maintainers of this project at: + +- [Slack](https://kubernetes.slack.com/messages/sig-docs) +- [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. -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.** 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. Furthermore, in some cases, one of your reviewers might ask for a technical review from a [Kubernetes tech reviewer](https://github.com/kubernetes/website/wiki/Tech-reviewers) when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances. +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.** + +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. + +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: -* [Start contributing](https://kubernetes.io/docs/contribute/start/) -* [Staging Your Documentation Changes](http://kubernetes.io/docs/contribute/intermediate#view-your-changes-locally) -* [Using Page Templates](http://kubernetes.io/docs/contribute/style/page-templates/) -* [Documentation Style Guide](http://kubernetes.io/docs/contribute/style/style-guide/) +* [Contribute to Kubernetes docs](https://kubernetes.io/docs/contribute/) +* [Using Page Templates](https://kubernetes.io/docs/contribute/style/page-templates/) +* [Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/) * [Localizing Kubernetes Documentation](https://kubernetes.io/docs/contribute/localization/) ## Localization `README.md`'s -| | | + +| Language | Language | |---|---| -|[French README](README-fr.md)|[Korean README](README-ko.md)| -|[German README](README-de.md)|[Portuguese README](README-pt.md)| -|[Hindi README](README-hi.md)|[Spanish README](README-es.md)| -|[Indonesian README](README-id.md)|[Chinese README](README-zh.md)| -|[Japanese README](README-ja.md)|[Vietnamese README](README-vi.md)| -|[Russian README](README-ru.md)|[Italian README](README-it.md)| -|[Polish README](README-pl.md)|[Ukrainian README](README-uk.md)| -||| +|[French](README-fr.md)|[Korean](README-ko.md)| +|[German](README-de.md)|[Portuguese](README-pt.md)| +|[Hindi](README-hi.md)|[Spanish](README-es.md)| +|[Indonesian](README-id.md)|[Chinese](README-zh.md)| +|[Japanese](README-ja.md)|[Vietnamese](README-vi.md)| +|[Russian](README-ru.md)|[Italian](README-it.md)| +|[Polish](README-pl.md)|[Ukrainian](README-uk.md)| -## Running the website locally using Docker +## Code of conduct -The recommended way to run the Kubernetes website locally is to run a specialized [Docker](https://docker.com) image that includes the [Hugo](https://gohugo.io) static website generator. - -> If you are running on Windows, you'll need a few more tools which you can install with [Chocolatey](https://chocolatey.org). `choco install make` - -> If you'd prefer to run the website locally without Docker, see [Running the website locally using Hugo](#running-the-website-locally-using-hugo) below. - -If you have Docker [up and running](https://www.docker.com/get-started), build the `kubernetes-hugo` Docker image locally: - -```bash -make docker-image -``` - -Once the image has been built, you can run the website locally: - -```bash -make docker-serve -``` - -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 the website locally using Hugo - -See the [official Hugo documentation](https://gohugo.io/getting-started/installing/) for Hugo installation instructions. Make sure to install the Hugo extended version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L9) file. - -To run the website locally when you have Hugo installed: - -```bash -make serve -``` - -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. - -## Community, discussion, contribution, and support - -Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/). - -You can reach the maintainers of this project at: - -- [Slack](https://kubernetes.slack.com/messages/sig-docs) -- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) - -### Code of conduct - -Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). +Participation in the Kubernetes community is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). ## Thank you! -Kubernetes thrives on community participation, and we appreciate your contributions to our website and our documentation! +Kubernetes thrives on community participation, and we appreciate your contributions to our website and our documentation! \ No newline at end of file