- When displaying a "Changes" button, we now display a diff from the previous patch to the current
patch, instead of a diff from the base release to the current patch.
- Properly localize the release note buttons so these can be translated.
- Move some strings from the footer to the translation table so they can be translated.
- Use a custom search engine for the preliminary site, so the preliminary site can actually be searched.
- Improve a few shortcodes to improve how they work when nested in tabs.
- Move a few constants out of the layouts and into args.yml for cleanliness.
- Remove the release-specific wording on the main release note page and on the docs page. This
ends up being hard to keep correct and not really useful.
- Add a full_version variable in args.yml which contains the 3 part release version
such as 1.0.1. When we release a new patch, we need to update this number in the current
release branch.
- Apply the full_version variable to the download button on the home page. It will now say "DOWNLOAD 1.0.1".
- 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.
- 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.
- If an explicit downloadas filename is not supplied in markdown, it is
now derived from the document title, with a proper extension based on the
content syntax.
- Made things work correctly for PRE blocks introduced with normal markdown
``` instead of our magic {{< text >}} sequences.
- Add <github_file> <github_blob> and <github_tree> to make it simpler to link to the right
place on GitHub.
- Use these new sequences throughout the docs.
- Also, fix bad HTML generated for the TOC in certain cirsumstances.
- Fix extra blank line inserted at the bottom of indented code blocks.
- Workaround the fact some of the styles for code blocks were being overriden by
Bootstrap.
- Align table indent and code indent so things look nicer.
- Fix missing "sidebar button" when on mobile in the help and about sections. I forgot to set a
variable to trigger the thing to be present in those cases.
- Improve footer layout for mobile.
- Get a nicer looking light bulb icon.
- 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.
- 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.
- Within a code block, you can now surround a relative file path with @@. This will
cause the path to be rendered as a link to raw.githubusercontent.com/istio/istio/<path>.
This lets the user click on the link to see the content of the file, which is mighty
handy.
- Updated all code blocks to take advantage of the above.
- Introduce support for {{< branch_name >}} which returns the source code branch
name associated with the current doc site.
- Use {{< branch_name >}} in all our references to content in istio/istio on GitHub. This thus
pins our references to the correct version of the content in GitHub. This prevents errors from
gradually appearing in our doc set as content in GitHub starts to diverge from the expectation
in the site content.
- Remove some leftover toc:false front matter from a few pages. The site now generally
figures out automatically that a TOC is not necessary.
- Enable a Hugo feature that queries Git for a last modified date on files. As a result,
instead of having the site build date in the footer, we now have a "this page was last modified"
date.
- Move the landing page's content out of the layouts directory and into the content directory
where it belongs.
- Use Hugo shortcodes for our embedded icon imagery. And make those icons scale with the
font size rather than being fixed sizes.
- Enable support for emojis in our content. Just use ⛵
and you'll get a sailboat for example.
Vadim Eisenberg
Martin Taillefer
mtail