* Site improvements.
- For SVG images, authors no longer need to specify image ratios
(which is a constant source of errors)
- Move more icons into the new icons.svg file to further reduce
average page load times.
- Rationalize Istio logo file names.
- Improve underlining behavior for sidebar headers and the RSS feed
Subscribe link.
- Made the RSS feed subscribe link open in a new tab.
- Increase the constract ratio for some elements in dark mode
text blocks (namely, YAML field names)
- Reduce the "brightness" of the light bulb icon which helps it
not pop so much in dark mode.
- Optimize the fonts we load and the order we load them in so as to improve page load time and
reduce the initial render time.
* Sadly, embedding SVGs into the HTML results in duplicate element ids, which is invalid HTML :-(
- Use a new approach to managing icons. This has two primary benefits:
- It makes it possible to color the icons such that they look good in the
dark theme. Previously, the icons were rendered in black on dark grey when
using the dark theme.
- The average payload size for our web pages is reduced and we better use the
browser cache.
- The new icon approach makes it possible to remove our dependency on the fontawesome
package, which further slims down our payload requirement
- Refresh our iconography for a slightly lighter look.
- Remove the extra thick left-hand border of text blocks to lighten the
look.
- Added a "NN minutes to read" indication on top of each page. This is
only displayed if the count is > 1 minute.
- Added a calendar icon next to the blog post date.
- Exposed a bunch of strings that were buried in CSS/JS to translation.
- Add the 'keywords:' front-matter fields to the Hugo archetypes.
- Fix background color of text areas not being applied correctly for extra-wide blocks.
- Incressed padding around text areas in mobile to make selection easier.
- Removed the right-hand side indent of text areas and block quotas when in mobile.
- Reduced the left-hand side indent of block quotas on mobile.
- Correct the use of OpenGraph annotations. I used the wrong attribute name, so the
annotations were never recognized.
- Added support for Twitter cards to our site, improving the experience of referencing
the site from Twitter posts.
- Added support for the twitter: front matter field for use in blog posts. Specifying this
front-matter entry will show the author's twitter address on the blog post, and will
add a Twitter card entry to the page noting the author's address.
- Renamed the page_icon front matter field to just icon to be consistent with other
entries.
- Made it so the subtitle front matter field can be used anywhere, not just on blog posts.
- Added a lint check to ensure subtitles don't end with a period.
- We now insert an "author" metadata entry whenever the attribution: front matter
field is used.
Improve long-standing hack that makes link anchors and a sticky nav header
work together. The improved hack deals correctly with varying font sizes,
removing the need for custom hackery for the FAQ and Glossary pages.
Fixes a slight rendering discrepency when printing pages.
- Increase the size of the Copy button in preformatted blocks to make it stand out since it is the
most common used button.
- Shift the copy/download/print buttons in PRE blocks towards the left so they don't overlap the
scroll bar in large text blocks.
- Switch to new fonts.
- Instead of underlining <H2> headers, we now draw a blue bar above them.
- Add an "up level" button at the top of pages.
- Streamline the appearance of the next/previous page links at the bottom of most pages.
- Remove the right pointing arrows from index pages and see also sections. They were just
confusing.
- Add icons to the main pages.
- Slightly change the layout of the glossary page, more to come here.
- 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.
- 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.
- Make "See also" show up in the TOC.
- When inlining the TOC at the top of a page, surround it with a pair of <hr> tags to get a line on the screen
- Fix rendering bug with TOC when specific characters showed up in section titles.
- Fix extra indent in the TOC in certain cases.
- Rename "See Also" to "See also" to follow our naming guidelines.
- 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.
- Include JSON syntax coloring support in PrismJS. This prevents
JavaScript crashes when trying to format output that's marked as JSON.
This was happening on the tasks/traffic-management/mirroring.md page.
- Properly escape strings raw output strings before inserting them into the
document. This bug was causing strange things to happen if any of the content
contained stuff that looked like HTML, such as the word <none>.
- Fixed syntax highlighting of code blocks with multiple commands.
Each command is now run through the syntax highlighter separately, instead
of mushing all commands into one go. The leading $ is also excluded which
helps the highlighter.
- Fixed the CSS source maps which couldn't be found due to a path problem. Running with Firefox
alerted me to that.
- Add missing JS source maps while I was there.
- The privacy link in the footer is now actually visible and uses the same coloring as the rest of the
text in the footer.
- The gear menu in the top right now actually looks like a real menu instead of a panel of links. Highlights behave as expected and
visuals are cleaner.
- The :before hack to cause proper scrolling in the face of our header is now more selective. It's only applied to
header items instead of all items that have an id attribute. This is more surgical in nature and avoids
potential issues such as was worked around by a counter-hack for tables. The counter hack is no longer
needed.
- Don't show the Edit This Pages on GitHub menu items for pages that are generated outside of the main doc process
(reference pages mainly). This won't kick in until I regenerate the reference docs, at which point they'll
gain the 'generated' front-matter entry, which will trigger the removal of the menu item.
- Apply a number of script improvements suggested by my editor.
Martin Taillefer
mtail
Frank Budinsky
Shriram Rajagopalan