- Ensure that references to GitHub content use the proper annotations so
we get links to the correct branches.
- Added a check to make sure content is not using blockquotes (instead of
{{< warning >}}, {{< tip >}}, and {{< idea >}}. This check is currently
disabled, pending the Chinese content being updated.
- Fix a few violations of these new checks.
* Delete special chars and turn on HTML checking
- Refer to #2289 and issue #2290
- Delete the special chars in Chinese content
- Turn on HTML checking to highlight problems
* delete the redundant period
- We now detect text blocks that are incorrectly indented.
- We now detect image captions that end in a period.
- We now detect page descriptions that don't end in a period.
- CircleCi now runs linting without minifying HTML first, improving perf and
improving error output.
- In CircleCi, we now have a per-build cache for HTML proofer output. This
helps reduce the frequency of link timeout errors.
- Fix errors flagged by the above new lint checks.
* Chinese: about/contribute/github/index.md
- translate working with GitHub
- translate contributing to docs index
* Chinese: add two indexes for policy and telemetry
- add policy and telemetry index
- add adapters index
* modify translation
* Fix Chinese spelling errors
- enable Chinese spelling checks
- fix spelling errors
- refer to #2038
Remove a bunch of entries that shouldn't have been in the spelling dictionary
and correct content aoocrdingly.
I'm disabling the Chinese spell checking for now, since I'm not able to fix the
spelling errors that emerged there. Once this PR is in, I'll file an issue to get
those spelling errors addressed and checking reenabled.
- Add the {{< text >}} shortcode as a way to declare code blocks. This shortcode
is intended to hide the subtleties around code blocks. More specifically, it
provides a transparent workaround for the Hugo bug around converting indented
code blocks with lines starting with dashes. It also deals with the special
formatting case we have around command-lines that start with `cat <<EOF`.
- Rename the {{< file_content >}} shortcode to {{< text_file >}} and the
{{< fetch_content >}} shortcode to {{< text_dynamic >}} for consistency in naming.
- Add useful error messages so people can self-serve when they get linting errors.
- Run all linters even if one fails. This gives you all the linting errors in one shot.
Martin Taillefer
Vincent
Jimmy Song
mtail