- Fix another issue with my arch-nemesis, the Copy button. My last fix for Copy button issues
resulted in screen flickering upon page loading. This is now fixed.
- Pin the size of the gear and magnifying glass icons in the header to avoid flicker as the
fonts for those renders a few ms too late and lead to flickering on page load.
- Cleaned up the site's JavaScript for clarity, and include minimized versions in the
site for improved perf.
- 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.
- The latest_blog_post variable is now computed instead of
needing to be set explicitly when a new post is added.
- FAQ categories are now specified in a much denser format directly
in the FAQ markdown rather than with a bunch of files.
- We no longer have a redirect from the top-nav Blog link to the
current latest blog post, which looks nicer.
- Added a link to our team drive to the community page.
- Upgrade a few icons from PNG to SVG
- Reintroduce content compression which I accidentally left turned off previously.
- Reintroduce the RSS icon on blog posts which disappeared in last week's great blog
page redesign.
- Update doc contribution guide to cover blog posts and setup pages.
- Add templates for setup topics and blog posts.
- Compress our SVG files for faster loading.
- The blog page now has a sidebar showing all blog posts.
- Blog entries now cleanly display the publication date, attribution, and subtitle
- Sidebar entries, both for blog posts and for docs now show tooltips when hovering the mouse over the entry.
This finally gives a home to oddball things like the FAQ, Glossary,
Release notes, and Contributing to the Docs stuff.
Took the opportunity to do a bit of tidying up in the directory structure
of the site by removing useless subdirectories.
- The FAQ page now has categories to make the page more scalable.
- Removed the FAQ pages that were added a little while ago and integrate
their content into the main site FAQ page.
- Stop computing sitemap.xml since there's a Jekyll plugin that does that
for us.
* Setup the html check in circleci
as jenkins is broken I've setup the rake test in circle ci
it's super fast thanks to caching the bundle install results
* Simplify and make reproducible the website setup
We still need to make an image so it doesn’t take forever but at least
this is reproducible and working
* Fix for liquid exception
Liquid Exceptions: No repo name found. Specify using PAGES_REPO_NWO
environment variables
* added info about faster subsequent starts by reusing the image
* typo
- Enable compression options to shrink our HTML file sizes. I didn't realize the
compressor had options when I added it a few weeks ago. Tweaking the options
lets us get rid of more spaces, comments, and sundry other things.
- Fix font weight of all table content on the site. Whereas normal page content
has a weight of 300, table content was at 400 making it all look a little bolded.
Now it's all 300.
- Made the PRE block Copy button be on a solid blue background to stand out more and
avoid looking bad when it overlaps text from the PRE block.
- Trim the margin around the right-hand TOC. It's now slimmer and even around all edges.
- Disable the Jekyll syntax highlighter since we're now using PrismJS for that instead.
The directory structure of the input web site now controls directory the layout of the
doc hierarchy. This simplifies authoring documents and enriches the UI we generate.
This also fixes the broken link problem with the GitHub staging sites. Most links work
now.
Our sitemap.xml now contains all that it should, and excludes stuff that it shouldn't contain.
Martin Taillefer