yunkon-kim
commented
1 year ago Issue
- When the result of
git diffincludes “```”, an issue occurs in the report output.
Reason
It affects the markdown below, which is generated by post-outdated-content-report.yaml (see lines 127-134).
<details>
<summary>Diff in detail</summary>
<p>
```diff
cat ${FILE}
```
</p>
</details>
This is an issue to track and reflect updates of English content. Please, check the files below as they may have been improved.
NOTICE - The following outdated content should be resolved before the next L10n branch updates.
Files to check
Changes in each file
_index.md
Diff in detail
```diff diff --git a/content/en/_index.md b/content/en/_index.md index 553f1b9..4465bc8 100755 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -19,8 +19,8 @@ We employ a community-driven process governed by the CNCF to develop and improve This Glossary provides a vendor-neutral platform to organize a shared vocabulary around cloud native technologies. Contributions are welcome from all participants who abide by the project's purpose and charter. -Anyone who wishes to make a contribution may submit a GitHub issue or create a pull request. -Please ensure you follow the [Style Guide](/style-guide/), read the [How To Contribute](/contribute/) doc, and join the [#glossary](https://cloud-native.slack.com/archives/C02TX20MQBB) channel on the CNCF Slack. +Anyone wishing to contribute may submit a GitHub issue or create a pull request. +Please ensure you follow the [Style Guide](/style-guide/), read the [How To Contribute](/contribute/) doc, join the [CNCF Slack](https://communityinviter.com/apps/cloud-native/cncf) workspace, and join the [#glossary](https://cloud-native.slack.com/archives/C02TX20MQBB) channel. There is also a [#glossary-localizations](https://cloud-native.slack.com/archives/C02N2RGFXDF) channel for those who want to help translate the glossary into their native language. ## Acknowledgements @@ -36,11 +36,16 @@ and many more contributors. For a complete contributor list, please refer to [this GitHub page](https://github.com/cncf/glossary/graphs/contributors). The Glossary is maintained by -[Catherine Paganini](https://www.linkedin.com/in/catherinepaganini/en/), -[Jason Morgan](https://www.linkedin.com/in/jasonmorgan2/), -[Jihoon Seo](https://www.linkedin.com/in/jihoon-seo/), +[Seokho Son](https://www.linkedin.com/in/seokho-son/), [Noah Ispas](https://www.linkedin.com/in/noah-ispas-0665b42a/), -and [Seokho Son](https://www.linkedin.com/in/seokho-son/). +[Jihoon Seo](https://www.linkedin.com/in/jihoon-seo/), +[Nate W.](https://www.linkedin.com/in/nate-double-u/), +and [Jorge Castro](https://www.linkedin.com/in/jorge-castro2112/). + +[Catherine Paganini](https://www.linkedin.com/in/catherinepaganini/en/), +and [Jason Morgan](https://www.linkedin.com/in/jasonmorgan2/) +are Emeritus Maintainers, and we are deeply grateful +for their invaluable contributions over the years. ## License ```style-guide/_index.md
Diff in detail
```diff diff --git a/content/en/style-guide/_index.md b/content/en/style-guide/_index.md index ea19f5f..5543543 100644 --- a/content/en/style-guide/_index.md +++ b/content/en/style-guide/_index.md @@ -7,7 +7,7 @@ menu: weight: 10 --- -This style guide will help you understand the Glossary audience, definition structure, required level of detail, and how to maintain a consistent style. +This style guide will help you understand the Glossary audience, definition structure, required level of detail, and how to keep a consistent style. The Cloud Native Glossary follows the [default style guide](https://github.com/cncf/foundation/blob/master/style-guide.md) of the CNCF repository. Additionally, it follows the following rules: @@ -25,19 +25,19 @@ Additionally, it follows the following rules: ## Audience -The Glossary is written for a technical AND non-technical audience. -Please ensure definitions are explained in simple terms and don’t assume technical knowledge. More do that below under Definition. +The Glossary is written for technical *and* non-technical audiences. +Please explain definitions in simple terms, and don’t assume technical knowledge. More about this is below in [Definition](#definition). -## Minimal Viable Definition +## Minimum viable definition -Our goal is to make it really easy for anyone to understand cloud native terms. +We aim to make it easy for anyone to understand cloud native terms. As such, we focus on simplicity. -That means using clear and simple language with examples anyone who uses technology can relate to (more to that below) but also providing a *minimal viable definition*, at least from a technical point of view. -We don't want to save on context and examples — after all, those things help the reader understand the concept — but if a technical detail is not needed to understand it, we'll skip it. -The goal is not to overcomplicate things. Once the reader understands the basic concept, other resources will help them dig deeper. +Use clear, simple language with examples anyone who uses technology can relate to while also providing a *minimum viable definition*, at least from a technical point of view. +We don't want to save on context and examples—after all, those things help the reader understand the concept—but if a technical detail is not needed to understand it, we'll skip it. +The goal is not to overcomplicate things. Once the reader understands the basic idea, other resources will help them dig deeper. That part is out of the scope of this Glossary. -## Definition Template +## Definition template Each glossary term is stored in a markdown file and follows this template: @@ -72,7 +72,7 @@ title: Definition Template ### Status -The **status** label will come after the title label. The status label indicates whether definitions are thoroughly vetted or require more effort. +The **status** label will come after the title label. These labels indicate the amount of effort still required to complete the definition. Valid values are: @@ -92,10 +92,10 @@ status: Feedback Appreciated The **tag** label follows the status label. For the tags to be meaningful and thus helpful to the user, we will use them in a strict sense. -Applying too many tags will only delute its meaning. -With the exception of "fundamental," which simply indicates this term is needed to understand other cloud native concepts, most terms will likely only have one tag. +Applying too many tags will only dilute its meaning. +An exception to this is the `fundamental` tag, which indicates this term is needed to understand other cloud native concepts; most terms will likely only have one tag. -**Note**: Please do not introduce new tags unless approved by the maintainers. When you add tags to an entry, ensure they are spelled exactly as listed below (singular, no typos). +**Note**: Please only introduce new tags if approved by the maintainers. When you add tags to an entry, ensure they are spelled exactly as listed below (singular, no typos). The current tags are: @@ -112,7 +112,7 @@ The current tags are: --- title: Definition Template status: Feedback Appreciated -tags: ["tag 1"], ["tag 2"] +tags: ["tag 1", "tag 2", ""] --- @@ -124,21 +124,21 @@ The definitions for **technology** and **concept** categories contain three subh - **What it is**: provide a short and clear overview of what we are talking about. - **Problem it addresses**: focus on the problem, not the solution (that comes in the next section). - In fact, avoid mentioning the term that is defined. The problem focuses on *what* led us to need that thing. + Avoid mentioning the term that is defined. The problem focuses on *what* led us to need that thing. - **How it helps**: now, come back to the term. How does it address the problem described above? Note that **properties** don't require separate sections. A definition will suffice. -To facilitate review, please use **semantic line breaks** (one sentence per line). +Please use **semantic line breaks** (one sentence per line) to ease review. #### Quality is paramount If merged, your submission will be the official CNCF definition for that term (until someone else improves it). -Creating a term that meets the CNCF's high standards can't be rushed — quality takes time and effort. +Creating a term that meets the CNCF's high standards can't be rushed—quality takes time and effort. **Do your research**: Even if you are confident you know the term, verify you got it right. -We often use terms in organizations a certain way that may not reflect the full picture. -When you do your research, especially when you're not 100% familiar with the term, use multiple resources. +We often use terms in organizations in a certain way that may not reflect the full picture. +When researching, especially when you're not 100% familiar with the term, use multiple resources. Many definitions are one-sided, especially if provided by a vendor. The Glossary must contain vendor-neutral, globally accepted definitions. @@ -151,40 +151,40 @@ Note that we cannot link to content developed by vendors. #### Keeping it simple -The Glossary aims at **explaining complex concepts in simple words** — that is a surprisingly difficult task that will likely take multiple revisions. +The Glossary aims to **explain complex concepts in simple words**—a surprisingly difficult task that will likely take multiple revisions. Always keep the audience in mind when drafting your definition. -Avoid using industry terms and buzzwords — you'll probably catch yourself going back to them and may need to autocorrect. +Avoid using industry terms and buzzwords—you might catch yourself returning to them and may need to train yourself to look for different terms. -When appropriate, use **real-world examples** that help readers (especially non-technical ones) better understand *when* and *why* the concept you’re explaining is relevant. +When appropriate, use **real-world examples** that help readers (especially non-technical ones) better understand *when* and *why* the idea you’re explaining is relevant. When used in your definition, always **link to existing glossary terms** (only the first mention should be hyperlinked). -**Example**: take a look at the “What it is” section of the [service mesh definition](/service-mesh/). -It links back to the microservices, service, reliability, and observability definitions. +**Example**: look at the “What it is” section of the [service mesh definition](/service-mesh/). +It links back to the definitions of microservices, service, reliability, and observability. Additionally, it uses a real-world example comparing network challenges in a microservices environment (something non-technical people can't relate to) to wifi problems (something anyone using a laptop can understand). Where possible, try to make that connection. #### Start with a Google or Word doc -We recommend starting with a Google or Word doc, letting it sit for a few days, and revisiting again. -This will allow you to catch phrases or expressions that could be worded in a simpler and more accessible way. +We recommend starting with a Google or Word doc, letting it sit for a few days, and revisiting it. +This will allow you to catch phrases or expressions that could be worded in a more straightforward and accessible way. Also, make sure to run a spellcheck before submitting a PR. -To ensure no one else submits a PR while working on a term, make sure to claim an issue (or create one) and that it is assigned to you. -More to that in the [How To Contribute](/contribute/) doc. +To ensure no one else submits a PR while working on a term, claim an issue (or create one) and request it be assigned to you. +More about that in the [How To Contribute](/contribute/) doc. -Before getting started, please read some of the published Glossary terms +Before getting started, please read some published Glossary terms to get a feeling for the level of detail and difficulty and when examples are appropriate. -## The review process: what to expect +## The review process: What to expect Please note that we are currently only three maintainers doing this in their spare time. -Occasionally, we'll be able to review terms quickly; on other occasions, it may take some time — we appreciate your patience. -If you have any questions, please get in touch with us in the #glossary Slack channel +Occasionally, we'll be able to review terms quickly; on other occasions, it may take some time—we appreciate your patience. +If you have any questions, please contact us in the #glossary Slack channel (for where and how to find it, please refer to our [How To Contribute](/contribute/) doc). Our goal is for the Glossary to be the best possible resource. Once you submit a PR, we may ask for one or more revisions. -Don't be frustrated — that is the case for many PRs. -Those backs and forth and our collaboration will ensure that your contribution becomes a truly useful definition read and referred to by readers all around the globe. +Don't get frustrated—that is the case for many PRs. +These back and forths and our collaboration will ensure that your contribution becomes a helpful definition read and referred to by readers all around the globe. ```site-reliability-engineering.md
cloud-computing.md
Diff in detail
```diff diff --git a/content/en/cloud-computing.md b/content/en/cloud-computing.md index 0fd673f..708c9b6 100644 --- a/content/en/cloud-computing.md +++ b/content/en/cloud-computing.md @@ -7,21 +7,17 @@ tags: ["infrastructure", "fundamental", ""] ## What it is -Cloud computing is a model that offers compute resources like CPU, network, and disk capabilities on-demand over the internet. -Cloud computing gives users the ability to access and use computing power in a remote physical location. -Cloud providers like AWS, GCP, Azure, DigitalOcean, and others all offer third parties -the ability to rent access to compute resources in multiple geographic locations. +Cloud computing offers compute resources like CPU, network, and disk capabilities on-demand over the internet, allowing users to access and use computing power in a remote physical location. +We generally differentiate between private and public cloud, depending on whether the cloud infrastructure is exclusively dedicated to an organization or shared for open public services. ## Problem it addresses -Organizations traditionally faced two main problems when attempting to expand their use of computing power. -They either acquire, support, design, and pay for facilities -to host their physical servers and network or expand and maintain those facilities. -Cloud computing allows organizations to outsource some portion of their computing needs to another organization. +Organizations traditionally faced two main challenges when attempting to expand computing power. +They could either acquire, support, and design (new) facilities to host their physical servers and network or expand and maintain existing ones. +Cloud computing solves that challenge by allowing organizations to outsource some of their computing needs. ## How it helps -Cloud providers offer organizations the ability to rent compute resources on-demand and pay for usage. -This allows for two major innovations: -Organizations can focus on their product or service without waiting, planning, and spending resources on new physical infrastructure. They can simply [scale](/scalability/) as needed and on-demand. +Cloud providers allow organizations to rent compute resources on-demand and pay for usage, delivering two key benefits. +First, organizations can focus on their product or service without waiting, planning, and spending resources on new physical infrastructure. And second, they can simply [scale](/scalability/) on-demand as needed. Cloud computing allows organizations to adopt as much or as little infrastructure as they need. ```virtual-machine.md
contribute/_index.md
Diff in detail
```diff diff --git a/content/en/contribute/_index.md b/content/en/contribute/_index.md index f788ad7..3e4eb81 100644 --- a/content/en/contribute/_index.md +++ b/content/en/contribute/_index.md @@ -84,7 +84,7 @@ Once you select a term to work on, comment on the issue.  Additionally, notify the maintainers on the [#glossary](https://cloud-native.slack.com/archives/C02TX20MQBB) channel of the CNCF Slack workspace and -tag _@Catherine Paganini_, _@Seokho Son_, _@Jihoon Seo_, and/or _@iamnoah_ to be sure they don't miss it. +tag _@iamnoah_, _@nate-double-u_, _@Seokho Son_, _@Jihoon Seo_, and/or _@castrojo_ to be sure they don't miss it. For the next steps, please refer to the [Submitting a new term (creating a PR)](#submitting-a-new-term) section. @@ -125,7 +125,7 @@ Next, the maintainers will triage the issue. That means they will assess if the term should be part of the Glossary. Not every term will be admitted. To be included in the Glossary, they should be established and widely-used cloud native concepts. -Please let the maintainers know that you've proposed a new term on Slack and tag _@Catherine Paganini_, _@Seokho Son_, _@Jihoon Seo_, and/or _@iamnoah_ so that hey don't miss it. +Please let the maintainers know that you've proposed a new term on Slack and tag _@iamnoah_, _@nate-double-u_, _@Seokho Son_, _@Jihoon Seo_, and/or _@castrojo_ so that they don't miss it. If you want to work on the definition, let the maintainers know and they'll assign it to you. ### Submitting a new term (creating a PR) {#submitting-a-new-term} ```containerization.md
idempotence.md
The end of report