Skip to content

Commit

Permalink
Merge pull request #3249 from cncf/main
Browse files Browse the repository at this point in the history
[FR] Merge main into dev-fr
  • Loading branch information
seokho-son authored Jul 24, 2024
2 parents de14375 + 42a415a commit d0c5904
Show file tree
Hide file tree
Showing 432 changed files with 6,643 additions and 33,624 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/new-term.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ body:
required: true
- label: The term has not already been declined in the past. [(shift+click to check)](https://github.com/cncf/glossary/issues?q=is%3Aissue+is%3Aclosed+label%3A%22triage%2Fnot+accepted%22)
required: false
- label: The term does not already exist in the [glossary](https://glossary.cncf.io).
- label: The term does not already exist in the [glossary](https://glossary.cncf.io) as a completed term, nor does it exist in [this directory](https://github.com/cncf/glossary/tree/main/content/en) as an incomplete term. (If the status of the term is `Feedback Appreciated`, consider updating the term.)
required: true
- label: I understand that maintainers will assess if the term should be part of the Glossary. (Please be patient)
required: true
Expand Down
16 changes: 10 additions & 6 deletions .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,6 @@ collaborators:
- username: huats
permission: push

- username: fydrah
permission: push

- username: Krast76
permission: push

Expand All @@ -180,6 +177,9 @@ collaborators:
- username: guillaumebernard84
permission: push

- username: seb-835
permission: push

# l10n ur approvers
- username: Saim-Safdar
permission: push
Expand Down Expand Up @@ -210,14 +210,17 @@ collaborators:
- username: naonishijima
permission: push

- username: Okabe-Junya
permission: push

- username: yuichi-nakamura
permission: push

# l10n tr approvers
- username: aliok
permission: push

- username: halil-bugol
- username: symys
permission: push

- username: rwxdash
Expand Down Expand Up @@ -445,10 +448,10 @@ branches:
# fr approvers
users:
- huats
- fydrah
- Krast76
- sestegra
- guillaumebernard84
- seb-835
teams: []
enforce_admins: null
required_linear_history: null
Expand Down Expand Up @@ -503,6 +506,7 @@ branches:
- inductor
- kaitoii11
- naonishijima
- Okabe-Junya
- yuichi-nakamura
teams: []
enforce_admins: null
Expand All @@ -520,7 +524,7 @@ branches:
# tr approvers
users:
- aliok
- halil-bugol
- symys
- rwxdash
- eminalemdar
teams: []
Expand Down
18 changes: 18 additions & 0 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Links

on:
pull_request:

jobs:
build-and-check-links:
name: CHECK LINKS
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: package.json
- run: npm install --omit=optional
- run: npm run check:links
2 changes: 1 addition & 1 deletion .github/workflows/es-spellcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ jobs:
set -o errexit
diff content/es/.wordlist.txt <(LC_ALL= sort -f content/es/.wordlist.txt)
- name: GitHub Spellcheck Action
uses: rojopolis/spellcheck-github-actions@0.35.0
uses: rojopolis/spellcheck-github-actions@0.38.0
with:
config_path: content/es/.spellcheck.yml
4 changes: 2 additions & 2 deletions .github/workflows/post-outdated-content-report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
# - name: Download output
# uses: actions/download-artifact@v3
- name: Download output
uses: dawidd6/action-download-artifact@v3
uses: dawidd6/action-download-artifact@v6
with:
github_token: ${{secrets.GITHUB_TOKEN}}
workflow: check-outdated-content.yaml
Expand Down Expand Up @@ -144,7 +144,7 @@ jobs:
echo "The end of report" >> report.md
- name: Create an issue from the report
uses: peter-evans/create-issue-from-file@v4
uses: peter-evans/create-issue-from-file@v5
with:
title: "[${{ env.L10N_CODE }}] A report to track and reflect updates of English content"
content-filepath: report.md
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ jobs:
- uses: actions/checkout@v4

- name: GitHub Spellcheck Action
uses: rojopolis/spellcheck-github-actions@0.35.0
uses: rojopolis/spellcheck-github-actions@0.38.0
11 changes: 7 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@

public/
resources/
node_modules/
.hugo_build.lock
.DS_Store
.hugo_build.lock
/public
/resources
node_modules/
package-lock.json
pagefind
tmp/

# Local Netlify folder
.netlify
8 changes: 8 additions & 0 deletions .htmltest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# cSpell:ignore pagefind regexs
DirectoryPath: public
# IgnoreDirectoryMissingTrailingSlash: true # FIXME
IgnoreInternalEmptyHash: true # FIXME
IgnoreDirs:
- ^(bn|de|es|hi|it|ko|pt.*?|ru|tr|ur|zh.*?)/
IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^/pagefind
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
16 changes: 8 additions & 8 deletions CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@
/i18n/es.toml @raelga @ramrodo @electrocucaracha @krol3 @92nqb

# Approvers for French contents
/content/fr/ @huats @fydrah @Krast76 @sestegra @guillaumebernard84
/i18n/fr.toml @huats @fydrah @Krast76 @sestegra @guillaumebernard84
/content/fr/ @huats @Krast76 @sestegra @guillaumebernard84 @seb-835
/i18n/fr.toml @huats @Krast76 @sestegra @guillaumebernard84 @seb-835

# Approvers for Hindi contents
/content/hi/ @Garima-Negi @jayesh-srivastava @abhay-raj19 @aj11anuj @kumarankit999 @bishal7679
Expand All @@ -47,8 +47,8 @@
/i18n/it.toml @fsbaraglia @ugho16 @annalisag-spark @sistella

# Approvers for Japanese contents
/content/ja/ @inductor @naonishijima @kaitoii11 @yuichi-nakamura
/i18n/ja.toml @inductor @naonishijima @kaitoii11 @yuichi-nakamura
/content/ja/ @inductor @naonishijima @kaitoii11 @yuichi-nakamura @Okabe-Junya
/i18n/ja.toml @inductor @naonishijima @kaitoii11 @yuichi-nakamura @Okabe-Junya

# Approvers for Korean contents
/content/ko/ @seokho-son @jihoon-seo @yunkon-kim
Expand All @@ -63,8 +63,8 @@
/i18n/ru.toml @shurup @kirkonru @tym83

# Approvers for Turkish contents
/content/tr/ @aliok @halil-bugol @rwxdash @eminalemdar
/i18n/tr.toml @aliok @halil-bugol @rwxdash @eminalemdar
/content/tr/ @aliok @symys @rwxdash @eminalemdar
/i18n/tr.toml @aliok @symys @rwxdash @eminalemdar

# Approvers for Urdu contents
/content/ur/ @Saim-Safdar @waleed318
Expand All @@ -75,5 +75,5 @@
/i18n/zh-cn.toml @hanyuancheung @Jacob953 @Rocksnake @Submarinee

# Approvers for Traditional Chinese contents
/content/zh-tw/ @pichuang @ydFu @hwchiu @johnlinp
/i18n/zh-tw.toml @pichuang @ydFu @hwchiu @johnlinp
/content/zh-tw/ @tico88612 @ydFu @hwchiu @johnlinp
/i18n/zh-tw.toml @tico88612 @ydFu @hwchiu @johnlinp
23 changes: 14 additions & 9 deletions LOCALIZATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,26 +57,31 @@ Open a PR with the localization initiation following this example: https://githu

To add a new language to the site, modify [config.toml](https://github.com/cncf/glossary/blob/main/config.toml#L54) (Note: localization teams should use their assigned development branch for this).

The `[languages]` block of `config.toml` is used to set the language. For instance, `[languages.en]` stands for English and `[languages.ko]` for Korean language configuration. Go to the `[languages]` block in `config.toml` and add a new block for your language-specific configuration. For instance, the Korean localization team added its `[languages.ko]` block after the `[languages.en]` block.
The `[languages]` block of `config.toml` is used to set the language. For instance, `[languages.en]` stands for English and `[languages.ko]` for Korean language configuration. Go to the `[languages]` block in `config.toml` and find a place for your new localization:

- The English language always stays first.
- Other languages are sorted based on the alphabetized English translation of their names (see how currently existing localizations are ordered as an example).
- Each localization is written in its own language followed by the English translation in parentheses — e.g., `한국어 (Korean)`.
- The `weight` parameter in the config is used for sorting (`1` is for English, `2` is for the alphabetically first language, `3` is for the second one, and so on).

For instance, you're adding a new block for the Korean localization. You calculated its weight as 8. Find the language block with `weight = 7` and add your new block afterwards:

- Example of `New language block for /config.toml`
```diff
[languages]
[languages.en]
title = "Cloud Native Glossary"
description = "The CNCF Cloud Native Glossary Project is intended to be used as a reference for common terms used when talking about cloud native applications."
languageName ="English"
# Weight used for sorting.
weight = 1
...
weight = 7

+[languages.ko]
+title = "클라우드 네이티브(Cloud Native) 용어집"
+description = "CNCF 클라우드 네이티브 용어집 프로젝트는 클라우드 네이티브 애플리케이션에 대한 대화를 나눌 때 공통의 용어를 참조하여 사용하도록 하는 목적을 가지고 있다."
+languageName ="한국어(Korean)"
+languageName = "한국어 (Korean)"
+contentDir = "content/ko"
+weight = 2
+weight = 8
```

Since the `weight` values should always be kept consistent, please **remember to increment the weights** of all the languages following your newly added localization.

#### 3-2. Adding a file for site strings

`i18n/<localization>.toml` sets up language-specific site strings.
Expand Down
49 changes: 49 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
HTMLTEST_DIR=tmp
HTMLTEST?=htmltest # Specify as make arg if different
HTMLTEST_ARGS?=--skip-external

# Use $(HTMLTEST) in PATH, if available; otherwise, we'll get a copy
ifeq (, $(shell which $(HTMLTEST)))
override HTMLTEST=$(HTMLTEST_DIR)/bin/htmltest
ifeq (, $(shell which $(HTMLTEST)))
GET_LINK_CHECKER_IF_NEEDED=get-link-checker
endif
endif

check-links: $(GET_LINK_CHECKER_IF_NEEDED)
$(HTMLTEST) $(HTMLTEST_ARGS)

clean:
rm -rf $(HTMLTEST_DIR) public/* resources

get-link-checker:
rm -Rf $(HTMLTEST_DIR)/bin
curl https://htmltest.wjdp.uk | bash -s -- -b $(HTMLTEST_DIR)/bin

serve:
npx hugo server \
--disableFastRender \
--buildDrafts \
--buildFuture \
--ignoreCache
--printI18nWarnings \
--printMemoryUsage \
--printPathWarnings \
--printUnusedTemplates \
--templateMetrics \
--templateMetricsHints \
--gc

production-build:
npm run get:submodule
npx hugo --minify
npx -y pagefind --site public

preview-build:
git submodule update --init --recursive
npx hugo \
--baseURL $(DEPLOY_PRIME_URL) \
--buildDrafts \
--buildFuture \
--minify
npx -y pagefind --site public
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ If you'd like to help with the glossary we'd love to have your contributions! Pl
## Acknowledgements

The Cloud Native Glossary was initiated by the CNCF Marketing 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/),
[Mike Foster](https://www.linkedin.com/in/mfosterche/?originalSubdomain=ca),
and many more contributors.
(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/),
[Mike Foster](https://www.linkedin.com/in/mfosterche/?originalSubdomain=ca),
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
The Glossary is maintained by
[Seokho Son](https://www.linkedin.com/in/seokho-son/),
[Noah Ispas](https://www.linkedin.com/in/noah-ispas-0665b42a/),
[Noah Ispas](https://www.linkedin.com/in/noah-ispas-0665b42a/),
[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/).
Expand All @@ -43,13 +43,11 @@ All code contributions are under the Apache 2.0 license. Documentation is distri

To improve the Cloud Native Glossary site itself, install a local copy with these instructions. Note you must have [npm](https://www.npmjs.com/) and [Hugo](https://gohugo.io/) installed.

```
```sh
git clone https://github.com/cncf/glossary.git
cd glossary
git submodule update --init --recursive
npm install
```

You can then run the site using `npm run serve` (select "[Hugo]").
You can then run the site using `npm run serve` (select "[Hugo]"). To have the site run locally with a functioning local search, run `npm run serve:with-pagefind`.

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?repo=cncf/glossary)
43 changes: 43 additions & 0 deletions assets/js/search.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
Copyright 2018 Google LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

(function($) {

'use strict';

var Search = {
init: function() {
$(document).ready(function() {
$(document).on('keypress', '.td-search-input', function(e) {
if (e.keyCode !== 13) {
return
}

var query = $(this).val();
var searchPage = $(this).data('search-page') + "?q=" + query;
document.location = searchPage;

return false;
});

});
},
};

Search.init();


}(jQuery));
11 changes: 11 additions & 0 deletions assets/scss/_search.scss
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,14 @@
}

}

.pagefind-ui__result-link {
color: $link-color !important;
}
.pagefind-ui__search-clear {
padding-left: 20px !important;
padding-right: 20px !important;
}
#search {
margin-top: 40px;
}
Loading

0 comments on commit d0c5904

Please sign in to comment.