text stringlengths 0 59.1k |
|---|
To run the examples: |
$ ./scripts/test_examples.sh run |
## check-headers-file.sh |
This script checks the headers if you are in a production environment. |
./scripts/check-headers-file.sh |
## diff_l10n_branches.py |
``` |
$ scripts/diff_l10n_branches.py --help |
Usage: diff_l10n_branches.py [OPTIONS] L10N_LANG L_COMMIT R_COMMIT |
This script generates a report of outdated contents in `content/<l10n- |
lang>` directory by comparing two l10n team milestone branches. |
L10n team owners can open a GitHub issue with the report generated by this |
script when they start a new team milestone. |
ex: `scripts/diff_l10n_branches.py ko dev-1.15-ko.3 dev-1.15-ko.4` |
Options: |
--src-lang TEXT Source language |
--help Show this message and exit. |
``` |
## hash-files.sh |
This script emits as hash for the files listed in $@. |
$ ./scripts/hash-files.sh |
## linkchecker.py |
This a link checker for Kubernetes documentation website. |
- If the language for the files scanned is not English (`en`), we check if you |
are actually using the localized links. For example, if you specify a filter |
similar to as `content/zh-cn/docs/**/*.md`, we check if the English version |
exists AND if the Chinese version exists as well. A checking record is |
produced if the link can use the localized version. |
- If the language specified is not English (`en`), a checking record is produced, |
and the `-w` switch is used, the script will perform in-place substitutions |
for links that have the format `/docs` and currently have a localized version |
available. This is an experimental feature and aims to reduce the amount of |
work required to update links to point to localized content. It currently |
works for Markdown files only. |
``` |
Usage: linkchecker.py -h |
Cases handled: |
- [foo](#bar) : ignored currently |
+ [foo](http://bar) : insecure links to external site |
+ [foo](https://k8s.io/website/...) : hardcoded site domain name |
+ [foo](/<lang>/docs/bar/...) : where <lang> is not 'en' |
+ /<lang>/docs/bar : contains shortcode, so ignore, or |
+ /<lang>/docs/bar : is a image link (ignore currently), or |
+ /<lang>/docs/bar : points to shared (non-localized) page, or |
+ /<lang>/docs/bar.md : exists for current lang, or |
+ /<lang>/docs/bar/_index.md : exists for current lang, or |
+ /<lang>/docs/bar/ : is a redirect entry, or |
+ /<lang>/docs/bar : is something we don't understand, then ERR |
+ [foo](/docs/bar/...) |
+ /docs/bar : contains shortcode, so ignore, or |
+ /docs/bar : is a image link (ignore currently), or |
+ /docs/bar : points to a shared (non-localized) page, or |
+ /docs/bar.md : exists for current lang, or |
+ /docs/bar/_index.md : exists for current lang, or |
+ /docs/bar : is a redirect entry, or |
+ /docs/bar : is something we don't understand |
+ [foo](<lang>/docs/bar/...) : leading slash missing for absolute path |
+ [foo](docs/bar/...) : leading slash missing for absolute path |
``` |
## lsync.sh |
This script checks if the English version of some localized contents have changed |
since a localized version has been committed. |
The following example checks a single file: |
./scripts/lsync.sh content/zh-cn/docs/concepts/_index.md |
The following command checks a subdirectory: |
./scripts/lsync.sh content/zh-cn/docs/concepts/ |
## check-ctrlcode.py |
This script finds control-code(0x00-0x1f) in text files. |
It will display illegal character in browser. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.