Skip to content

Commit

Permalink
chore: Fix whitespace and a few trivial typos (#2250)
Browse files Browse the repository at this point in the history
* chore: Fix whitespace issues

Signed-off-by: Adam Harvey <aharvey00@gmail.com>

* fix: Typo with double word

Signed-off-by: Adam Harvey <aharvey00@gmail.com>

* chore: Typo in comment

Signed-off-by: Adam Harvey <aharvey00@gmail.com>

---------

Signed-off-by: Adam Harvey <aharvey00@gmail.com>
  • Loading branch information
adamdmharvey authored Jul 26, 2023
1 parent 17f5a02 commit a42311b
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ Below are the guidelines for how to contribute to the code that runs the CNCF Gl
## How can I contribute?

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.
2. **Fix a bug**. Find [an issue](https://github.com/cncf/glossary/issues) you want to fix and submit a PR for approval.
2. **Fix a bug**. Find [an issue](https://github.com/cncf/glossary/issues) you want to fix and submit a PR for approval.

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).
1 change: 1 addition & 0 deletions LOCALIZATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ If the team seems inactive (no response after several days), reach out to @Seokh
---

# Localization team guidelines

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:

1. Only terms with the status `Completed` in the English version are ready to be localized.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Committee (Business Value Subcommittee) and includes contributions
from [Catherine Paganini](https://www.linkedin.com/in/catherinepaganini/en/), [Chris Aniszczyk](https://www.linkedin.com/in/caniszczyk/),
[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).

## License
## License

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

Expand Down
2 changes: 1 addition & 1 deletion assets/json/offline-search-index.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{- $.Scratch.Add "offline-search-index" slice -}}
{{- range where .Site.AllPages ".Params.exclude_search" "!=" true -}}
{{/* We have to apply `htmlUnescape` again after `truncate` because `truncate` applies `html.EscapeString` if the argument is not HTML. */}}
{{/* 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). */}}
{{/* 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). */}}
{{- $.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)) -}}
{{- end -}}
{{- $.Scratch.Get "offline-search-index" | jsonify -}}
3 changes: 3 additions & 0 deletions content/en/container-orchestration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,19 @@ category: Concept
---

## What it is

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

## Problem it addresses

Managing [microservices](/microservices), security, and network communication at scale — and [distributed systems](/distributed-systems) in general — is hard, if not impossible, to manage manually.
Container orchestration allows users to automate all these management tasks.

## How it helps

Container orchestration tools allow users to determine a system's state.
First, they declare how it should look like (e.g., x containers, y pods, etc.).
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).
Expand Down
2 changes: 0 additions & 2 deletions content/en/edge-computing.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,3 @@ As described above, for edge devices to be useful, they must do at least part of
This is achieved by shifting some storage and processing resources from the data center to where the data is generated: the edge device.
Processed and unprocessed data is subsequently sent to the data center for further processing and storage.
In short, efficiency and speed are the primary drivers of edge computing.


3 changes: 1 addition & 2 deletions spin-new-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Complete your local dev setup using [these instructions](https://github.com/cncf

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

Replace favicons in in the `static/favicons` directory with your own.
Replace favicons in the `static/favicons` directory with your own.

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

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

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.


## Feedback buttons configuration

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).
Expand Down

0 comments on commit a42311b

Please sign in to comment.