- 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.
When on mobile, the left sidebar is hidden by default. To make navigation easier, we allow the user to browse
the site entirely through the various index sections which provide links to all articles. This wasn't working
for the About and Blog links at the top of the page since they send you to a direct page instead of to the
relevant navigation page. So...
- Made the About link point to the about section's index page.
- Each blog page now contains a link to the next and previous blog post.
* 0.2.12 doc link should be to docs/ directly
+ note about shell security
* fix typo (for for)
* Revise wording and linking
Drop the double TOC (this page has very little traffic anyway)
The Google Crawl Engine reported a bunch of broken links pointing into istio.io.
This adds redirects so that these links work.
Add a hack such that the gear menu logic that lets you time travel through versions
of the site will insist that if a page existed in a given version, it must also exist
in subsequent versions. This will ensure we always create redirects when we move site
content, and thus avoid breaking links into the site. If a page is moved or removed,
this will lead to rake test errors when checking the content of archive.istio.io.
We now generate the test site into a subdirectory such that we can ensure all
links are correctly using {{home}}, which makes the site work correctly once
archived.
Fixed a bunch of broken cases.
* Fix a bunch of content errors.
- Replace links using https://istio.io and / with {{home}} so they work
on staging and archive versions of the site.
- Fix a bunch of preformatted blocks that has extra spaces or incorrect indent
- Replaced usage of "Further reading" with "What's next" to match our convention.
- Fix capitalization style of various headers to match our convention.
- Broke up some preformatted blocks to separate the command-line from the output
in order to make cut & paste easier, per our convention.
* Fix more links.
- 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.
Four major themes to this work:
* Performance. This new site is fast. It loads considerably faster, especially on mobile.
Every pixel is drawn exactly once. Clicking around doesn't result in things jiggling everywhere.
* Navigation. I wanted to make it easier to get around the site, especially on mobile. To that end, we now have:
- Sticky navigation elements. The top nav bar, the left sidebar and the right TOC are now sticky and remain
on screen even as page content is scrolled.
- Tabs in the Docs section have been removed and integrated as accordion items in the left sidebar.
* Layout. I moved a bit of content around to make it easier to find and give us some room to grow:
- The Help page is now replaced with a full Help section. This provides a home for the FAQ, glossary,
bug reporting, and troubleshooting pages.
- The About page is now replaced with a full About section. This provides a home for the release notes, roadmap, upcoming "in the news" section, etc.
* Design. I tried to improve consistency across the site and provide a slightly lighter feel by minimizing the impact of some design elements. Specifics:
- Font sizes are now consistent across the site.
- The site does a much better job at adjusting to different screen sizes which makes the mobile experience better.
- Accessibility is improved by adding many attributes for screen readers, and by ensuring the site scales properly based on user-selected fonts.
Martin Taillefer
Lin Sun
mtail
Laurent Demailly
Sakshi Goel
Limin Wang
Shriram Rajagopalan
Jason Young
Jasmine Jaksic
Ross Guarino
Nathan Mittler