From 3ca1955a1372b60ef3483ab4c7ce08fe09e0d637 Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Fri, 12 Jul 2019 02:03:07 +0100 Subject: [PATCH] =?UTF-8?q?Add=20=E2=80=9CCNCF=E2=80=9D=20to=20glossary=20?= =?UTF-8?q?(#14537)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add glossary entry for CNCF * Use CNCF glossary entry --- content/en/docs/contribute/advanced.md | 4 ++-- content/en/docs/contribute/localization.md | 2 +- content/en/docs/contribute/start.md | 15 ++++++------ content/en/docs/reference/glossary/cncf.md | 23 +++++++++++++++++++ .../windows/intro-windows-in-kubernetes.md | 2 +- .../docs/tasks/administer-cluster/coredns.md | 2 +- .../users/cluster-operator/intermediate.md | 2 +- 7 files changed, 37 insertions(+), 13 deletions(-) create mode 100755 content/en/docs/reference/glossary/cncf.md diff --git a/content/en/docs/contribute/advanced.md b/content/en/docs/contribute/advanced.md index f77dea8dee..b885d6de33 100644 --- a/content/en/docs/contribute/advanced.md +++ b/content/en/docs/contribute/advanced.md @@ -176,7 +176,7 @@ Responsibilities include: - Learn and set best practices for the SIG by updating contribution guidelines - Schedule and run SIG meetings: weekly status updates, quarterly retro/planning sessions, and others as needed - Schedule and run doc sprints at KubeCon events and other conferences -- - Recruit for and advocate on behalf of SIG Docs with the CNCF and its platinum partners, including Google, Oracle, Azure, IBM, and Huawei +- Recruit for and advocate on behalf of SIG Docs with the {{< glossary_tooltip text="CNCF" term_id="cncf" >}} and its platinum partners, including Google, Oracle, Azure, IBM, and Huawei - Keep the SIG running smoothly ### Running effective meetings @@ -190,7 +190,7 @@ To schedule and run effective meetings, these guidelines show what to do, how to **Set a clear agenda**: - Set a clear agenda of topics -- Publish the agenda in advance +- Publish the agenda in advance For weekly meetings, copypaste the previous week's notes into the "Past meetings" section of the notes diff --git a/content/en/docs/contribute/localization.md b/content/en/docs/contribute/localization.md index c41c1b4ef2..7c0f251089 100644 --- a/content/en/docs/contribute/localization.md +++ b/content/en/docs/contribute/localization.md @@ -285,6 +285,6 @@ You can also help add or improve content to an existing localization. Join the [ Once a localization meets requirements for workflow and minimum output, SIG docs will: - Enable language selection on the website -- Publicize the localization's availability through [Cloud Native Computing Foundation](https://www.cncf.io/) (CNCF) channels, including the [Kubernetes blog](https://kubernetes.io/blog/). +- Publicize the localization's availability through [Cloud Native Computing Foundation](https://www.cncf.io/about/) (CNCF) channels, including the [Kubernetes blog](https://kubernetes.io/blog/). {{% /capture %}} diff --git a/content/en/docs/contribute/start.md b/content/en/docs/contribute/start.md index f1ee122d0a..4a60234318 100644 --- a/content/en/docs/contribute/start.md +++ b/content/en/docs/contribute/start.md @@ -32,13 +32,14 @@ The Kubernetes documentation is written in Markdown and processed and deployed u You can file issues, edit content, and review changes from others, all from the GitHub website. You can also use GitHub's embedded history and search tools. -Not all tasks can be done in the GitHub UI, but these are discussed in the +Not all tasks can be done in the GitHub UI, but these are discussed in the [intermediate](/docs/contribute/intermediate/) and [advanced](/docs/contribute/advanced/) docs contribution guides. ### Participating in SIG Docs -The Kubernetes documentation is maintained by a Special Interest Group (SIG) +The Kubernetes documentation is maintained by a +{{< glossary_tooltip text="Special Interest Group" term_id="sig" >}} (SIG) called SIG Docs. We communicate using a Slack channel, a mailing list, and weekly video meetings. New participants are welcome. For more information, see [Participating in SIG Docs](/docs/contribute/participating/). @@ -68,9 +69,9 @@ We make use of the standard Hugo shortcodes, as well as a few that are custom to the Kubernetes documentation. See [Custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) for information about how to use them. -### Multiple languages +### Multiple languages -Documentation source is available in multiple languages in `/content/`. Each language has its own folder with a two-letter code determined by the [ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php). For example, English documentation source is stored in `/content/en/docs/`. +Documentation source is available in multiple languages in `/content/`. Each language has its own folder with a two-letter code determined by the [ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php). For example, English documentation source is stored in `/content/en/docs/`. For more information about contributing to documentation in multiple languages, see ["Localize content"](/docs/contribute/intermediate#localize-content) in the intermediate contributing guide. @@ -158,7 +159,7 @@ upcoming Kubernetes release, your process is a bit different. See process guidelines and information about deadlines. {{< /note >}} -### Sign the CLA +### Sign the CNCF CLA {#sign-the-cla} Before you can contribute code or documentation to Kubernetes, you **must** read the [Contributor guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md) and @@ -299,7 +300,7 @@ conventions and etiquette and get used to the workflow. PR, and if applicable, also look at any linked issues. If you see a problem or room for improvement, hover over the line and click the `+` symbol that appears. - + You can type a comment, and either choose **Add single comment** or **Start a review**. Typically, starting a review is better because it allows you to leave multiple comments and notifies the PR owner only when you have @@ -342,7 +343,7 @@ or follow the steps below. Case studies highlight how organizations are using Kubernetes to solve real-world problems. They are written in collaboration with the Kubernetes -marketing team, which is handled by the CNCF. +marketing team, which is handled by the {{< glossary_tooltip text="CNCF" term_id="cncf" >}}. Have a look at the source for the [existing case studies](https://github.com/kubernetes/website/tree/master/content/en/case-studies). diff --git a/content/en/docs/reference/glossary/cncf.md b/content/en/docs/reference/glossary/cncf.md new file mode 100755 index 0000000000..7b56de0df8 --- /dev/null +++ b/content/en/docs/reference/glossary/cncf.md @@ -0,0 +1,23 @@ +--- +title: Cloud Native Computing Foundation (CNCF) +id: cncf +date: 2019-05-26 +full_link: https://cncf.io/ +short_description: > + Cloud Native Computing Foundation + +aka: +tags: +- community +--- + The Cloud Native Computing Foundation (CNCF) builds sustainable ecosystems and + fosters a community around [projects](https://www.cncf.io/projects/) that + orchestrate containers as part of a microservices architecture. + +Kubernetes is a CNCF project. + + + +The CNCF is a sub-foundation of [the Linux Foundation](https://www.linuxfoundation.org/). +Its mission is to make cloud native computing ubiquitous. + diff --git a/content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md b/content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md index fbad6af993..d34aaca1c4 100644 --- a/content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md +++ b/content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md @@ -541,7 +541,7 @@ We have a lot of features in our roadmap. An abbreviated high level list is incl ### CRI-ContainerD -ContainerD is another OCI-compliant runtime that recently graduated as a CNCF project. It's currently tested on Linux, but 1.3 will bring support for Windows and Hyper-V. [[reference](https://blog.docker.com/2019/02/containerd-graduates-within-the-cncf/)] +{{< glossary_tooltip term_id="containerd" >}} is another OCI-compliant runtime that recently graduated as a {{< glossary_tooltip text="CNCF" term_id="cncf" >}} project. It's currently tested on Linux, but 1.3 will bring support for Windows and Hyper-V. [[reference](https://blog.docker.com/2019/02/containerd-graduates-within-the-cncf/)] The CRI-ContainerD interface will be able to manage sandboxes based on Hyper-V. This provides a foundation where RuntimeClass could be implemented for new use cases including: diff --git a/content/en/docs/tasks/administer-cluster/coredns.md b/content/en/docs/tasks/administer-cluster/coredns.md index 7055b21f6b..657459b145 100644 --- a/content/en/docs/tasks/administer-cluster/coredns.md +++ b/content/en/docs/tasks/administer-cluster/coredns.md @@ -19,7 +19,7 @@ This page describes the CoreDNS upgrade process and how to install CoreDNS inste ## About CoreDNS [CoreDNS](https://coredns.io) is a flexible, extensible DNS server that can serve as the Kubernetes cluster DNS. -Like Kubernetes, the CoreDNS project is hosted by the [CNCF.](http://www.cncf.io) +Like Kubernetes, the CoreDNS project is hosted by the {{< glossary_tooltip text="CNCF" term_id="cncf" >}}. You can use CoreDNS instead of kube-dns in your cluster by replacing kube-dns in an existing deployment, or by using tools like kubeadm that will deploy and upgrade the cluster for you. diff --git a/content/en/docs/user-journeys/users/cluster-operator/intermediate.md b/content/en/docs/user-journeys/users/cluster-operator/intermediate.md index 5421b5822b..b590e4862c 100644 --- a/content/en/docs/user-journeys/users/cluster-operator/intermediate.md +++ b/content/en/docs/user-journeys/users/cluster-operator/intermediate.md @@ -84,7 +84,7 @@ Start with the [basics on Kubernetes logging](/docs/concepts/cluster-administrat Like log aggregation, many clusters utilize additional software to help capture metrics and display them. There is an overview of tools at [Tools for Monitoring Compute, Storage, and Network Resources](/docs/tasks/debug-application-cluster/resource-usage-monitoring/). Kubernetes also supports a [resource metrics pipeline](/docs/tasks/debug-application-cluster/resource-metrics-pipeline/) which can be used by Horizontal Pod Autoscaler with custom metrics. -[Prometheus](https://prometheus.io/), which is another CNCF project, is a common choice to support capture and temporary collection of metrics. There are several options for installing Prometheus, including using the [stable/prometheus](https://github.com/kubernetes/charts/tree/master/stable/prometheus) [helm](https://helm.sh/) chart, and CoreOS provides a [prometheus operator](https://github.com/coreos/prometheus-operator) and [kube-prometheus](https://github.com/coreos/prometheus-operator/tree/master/contrib/kube-prometheus), which adds on Grafana dashboards and common configurations. +[Prometheus](https://prometheus.io/), another {{< glossary_tooltip text="CNCF" term_id="cncf" >}} project, is a common choice to support capture and temporary collection of metrics. There are several options for installing Prometheus, including using the [stable/prometheus](https://github.com/kubernetes/charts/tree/master/stable/prometheus) [helm](https://helm.sh/) chart, and CoreOS provides a [prometheus operator](https://github.com/coreos/prometheus-operator) and [kube-prometheus](https://github.com/coreos/prometheus-operator/tree/master/contrib/kube-prometheus), which adds on Grafana dashboards and common configurations. A common configuration on [Minikube](https://github.com/kubernetes/minikube) and some Kubernetes clusters uses [Heapster](https://github.com/kubernetes/heapster) [along with InfluxDB and Grafana](https://github.com/kubernetes/heapster/blob/master/docs/influxdb.md).