Home • Explore • Blog • CI
☰



kubernetes
2nd chunk of `scripts/README.md`
f0ab418b0f4614f93c7e2eaece09bf1c793511501f7b9af100000001000009a6
  Find what changes occurred between two versions

  ex: ./upstream_changes.py content/fr/_index.html

Options:
  --reference TEXT  Specify the reference version of the file. Default to the
                    English one.
  --git-path TEXT   Specify git path
  --help            Show this message and exit.
```

## test_examples.sh

This script tests whether a change affects example files bundled in the website.

To install the dependencies:

    $ ./scripts/test_examples.sh install

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
Title: Kubernetes Documentation Development Scripts (Continued)
Summary
This section details the usage of several Kubernetes documentation development scripts. `upstream_changes.py` finds changes between versions, offering options for specifying a reference version and git path. `test_examples.sh` tests website example files and includes installation and run commands. `check-headers-file.sh` validates headers in a production environment. `diff_l10n_branches.py` compares localization branches to report outdated content. `hash-files.sh` outputs a hash for specified files. `linkchecker.py` is a link checker that identifies insecure or hardcoded links, and can update links in localized content (experimental).