Skip to content

Commit a42311b

Browse files
authored
chore: Fix whitespace and a few trivial typos (cncf#2250)
* chore: Fix whitespace issues Signed-off-by: Adam Harvey <[email protected]> * fix: Typo with double word Signed-off-by: Adam Harvey <[email protected]> * chore: Typo in comment Signed-off-by: Adam Harvey <[email protected]> --------- Signed-off-by: Adam Harvey <[email protected]>
1 parent 17f5a02 commit a42311b

7 files changed

+8
-7
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ Below are the guidelines for how to contribute to the code that runs the CNCF Gl
99
## How can I contribute?
1010

1111
1. **Report a bug**. If you see a technical issue with the CNCF Glossary site or something that doesn't look right, search [the existing issues](https://github.com/cncf/glossary/issues) to see if it has been reported already. If not, please [create a new issue](https://github.com/cncf/glossary/issues/new) describing the bug. Please provide all steps necessary to reproduce the bug and screenshots if applicable.
12-
2. **Fix a bug**. Find [an issue](https://github.com/cncf/glossary/issues) you want to fix and submit a PR for approval.
12+
2. **Fix a bug**. Find [an issue](https://github.com/cncf/glossary/issues) you want to fix and submit a PR for approval.
1313

1414
Read [more about the code that runs the Glossary site](https://github.com/cncf/glossary/blob/main/spin-new-glossary.md) and [how to set up your own local development instance](https://github.com/cncf/glossary#setting-up-a-local-instance). To connect with our community and ask questions, please join [the #glossary channel on the CNCF slack](https://cloud-native.slack.com/archives/C02TX20MQBB).

LOCALIZATION.md

+1
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ If the team seems inactive (no response after several days), reach out to @Seokh
138138
---
139139

140140
# Localization team guidelines
141+
141142
Every localization team may have its own process of working on localizing terms. However, here are some guidelines that are common for all localization teams:
142143

143144
1. Only terms with the status `Completed` in the English version are ready to be localized.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Committee (Business Value Subcommittee) and includes contributions
1717
from [Catherine Paganini](https://www.linkedin.com/in/catherinepaganini/en/), [Chris Aniszczyk](https://www.linkedin.com/in/caniszczyk/),
1818
[Daniel Jones](https://www.linkedin.com/in/danieljoneseb/?originalSubdomain=uk), [Jason Morgan](https://www.linkedin.com/in/jasonmorgan2/), [Katelin Ramer](https://www.linkedin.com/in/katelinramer/) and [Mike Foster](https://www.linkedin.com/in/mfosterche/?originalSubdomain=ca).
1919

20-
## License
20+
## License
2121

2222
All code contributions are under the Apache 2.0 license. Documentation is distributed under CC BY 4.0.
2323

assets/json/offline-search-index.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{{- $.Scratch.Add "offline-search-index" slice -}}
22
{{- range where .Site.AllPages ".Params.exclude_search" "!=" true -}}
33
{{/* We have to apply `htmlUnescape` again after `truncate` because `truncate` applies `html.EscapeString` if the argument is not HTML. */}}
4-
{{/* Indvidual taxonomies can be added in the next line by add '"taxonomy-name" (.Params.taxonomy-name | default "")' to the dict (as seen for categories and tags). */}}
4+
{{/* Individual taxonomies can be added in the next line by add '"taxonomy-name" (.Params.taxonomy-name | default "")' to the dict (as seen for categories and tags). */}}
55
{{- $.Scratch.Add "offline-search-index" (dict "ref" .RelPermalink "title" .Title "status" (.Params.status | default "") "body" (.Plain | htmlUnescape) "excerpt" ((.Description | default .Plain) | htmlUnescape | truncate (.Site.Params.offlineSearchSummaryLength | default 70) | htmlUnescape)) -}}
66
{{- end -}}
77
{{- $.Scratch.Get "offline-search-index" | jsonify -}}

content/en/container-orchestration.md

+3
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,19 @@ category: Concept
55
---
66

77
## What it is
8+
89
[Container](/container/) orchestration refers to managing and automating the lifecycle of containerized applications in dynamic environments.
910
It's executed through a container orchestrator (in most cases, [Kubernetes](/kubernetes)), which enables deployments, (auto)scaling, auto-healing, and monitoring.
1011
Orchestration is a metaphor:
1112
The orchestration tool conducts containers like a music conductor, ensuring every container (or musician) does what it should.
1213

1314
## Problem it addresses
15+
1416
Managing [microservices](/microservices), security, and network communication at scale — and [distributed systems](/distributed-systems) in general — is hard, if not impossible, to manage manually.
1517
Container orchestration allows users to automate all these management tasks.
1618

1719
## How it helps
20+
1821
Container orchestration tools allow users to determine a system's state.
1922
First, they declare how it should look like (e.g., x containers, y pods, etc.).
2023
The orchestration tool will then automatically monitor the infrastructure and correct it if its state deviates from the declared one (e.g., spin up a new container if one crashes).

content/en/edge-computing.md

-2
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,3 @@ As described above, for edge devices to be useful, they must do at least part of
2727
This is achieved by shifting some storage and processing resources from the data center to where the data is generated: the edge device.
2828
Processed and unprocessed data is subsequently sent to the data center for further processing and storage.
2929
In short, efficiency and speed are the primary drivers of edge computing.
30-
31-

spin-new-glossary.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Complete your local dev setup using [these instructions](https://github.com/cncf
3131

3232
Edit `config.toml` to set title, Google Analytics, languages, copyright, social image, social links, and various other settings.
3333

34-
Replace favicons in in the `static/favicons` directory with your own.
34+
Replace favicons in the `static/favicons` directory with your own.
3535

3636
Replace `assets/icons/logo.svg` with your own logo.
3737

@@ -43,7 +43,6 @@ Edit various static copy in the `layouts` folder as needed.
4343

4444
Replace all content in the `content/en` folder with your own glossary terms. Create a language folder for each of the translation languages you will support. Note that terms will only be listed on the site when `status: Completed` in the header of the term file.
4545

46-
4746
## Feedback buttons configuration
4847

4948
You can configure the feedback buttons at the bottom of each page to post to your Google Analytics account. See [the instructions here](https://www.docsy.dev/docs/adding-content/feedback/#user-feedback).

0 commit comments

Comments
 (0)