- 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.
- Prevent See Also sections from showing up on index pages.
- Clean up and simplify some JavaScript & CSS.
- Set a height for the idea and warning icons in order to prevent
screen flicker when loading pages with these icons.
- 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.
- You can now use {{< file_content >}} to pull in files from the doc repo
into generated documentation. If you include the `snippet` attribute, you can
pull in only pieces of the file instead. This makes it possible to annotate
scripts and yaml files and extract those annotated bits and pieces into the
docs. This should let us have fully tested examples which are then incorporated
into the docs
- The previous {{< file_content >}} feature that lets you dynamically pull
content from a URL has been renamed to {{< fetch_content >}} instead.
- Make "make serve" actually work.
- Eliminate superfluous "scroll left nav into view" button on screens that don't have a sidebar
(community & search result). Only matters on mobile.
- Fix unpleasant wrapping in the footer when on mobile.
- linters.sh will run spell-checking and a style checker on
markdown files.
- Fix a whole bunch of typos and bad markdown content throughout. There are many more fixes
to come before we can enable the linters as a checkin gate, but this takes care of a majority
of items. More to come later.
* Update reference docs.
- We now replace instances of https://istio.io with {{site.baseurl}} in imported
reference docs such that the generated site will work properly for staging and for
archive.istio.io
* Fix a bad link.
- Stop using the prism functionality for syntax highlighting since
it doesn't handle embedded links in <pre> blocks, which prevents
cross-linking to type names properly. We now roll our own PRE block
handling.
- Stop drawing a box around inline code elements which substantially improves
the visuals, especially in tables.
- Improve appearance of tables to be a bit cleaner.
* add build scripts to be driven thru jenkins
* uniformly handle site.baseurl
* data-src should use full paths for now
* update build with version tag
* Add explanation re: CORS
* remove gitmodules
Jimmy Song
mtail
Martin Taillefer
Steven Dake
Yossi Mesika
Jason Young
Shriram Rajagopalan
Laurent Demailly
Yang Guan
mandarjog
Zack