Commit Graph

24 Commits

Author SHA1 Message Date
Martin Taillefer 2258d0b03b
Improve text blocks. (#3727)
- Add tests for the various text block features.

- Combine text_file and text_dynamic into text_import

- Add support for snippet extraction for text downloaded from a URL

- Add support for formatting output blocks in a different style for
content downloaded from a URL

- Report some errors when unable to fetch content from a URL.

- Fixed a few small bugs along the way.
2019-03-18 06:31:26 -07:00
Martin Taillefer 2a5108806b
Site improvements. (#3706)
- Added a test suite to test out the different compositions of
site features.

- Substantially improve the composability of site features
(callouts, tabs, text blocks, boilerplates, lists). You can
now more confidentally mix & match these in any combination
and have a pretty good chance it'll render correctly.
2019-03-15 09:53:58 -07:00
mtail 5c1c9ae630 Revert "Site improvements (#3696)"
This reverts commit e1ce0c36
2019-03-14 19:59:48 -07:00
Martin Taillefer e1ce0c3633 Site improvements (#3696)
- Add a test suite for various compositions of site features.

- Substantially improve composition of various site features to eliminate bad
interactions. It's not perfect yet, but it's much better. The one thing still
broken is "a text block inside a warning in a list in a tab". There's still
something funny going on there, but I have some ideas for later.

- Added a new linter check to detect misuse of https://preliminary.istio.io in docs,
and fixed one offending instance.
2019-03-14 17:20:38 -07:00
Martin Taillefer 1cc06a6e9c
Site improvements (#3677)
- Added call-to-action buttons in the 1.1 announcements. We can use the same
buttons in future release announcements.

- Fixed broken large warning icon on the 404 error page.

- Fix oerder of blog posts in the side bar.

- Add support to not expand @@ notations in text blocks and use
it for a text blocks that's currently triggering a build failure

- Fixed broken rendering of some text blocks when syntax coloring
is turned off via the menu.
2019-03-13 21:53:55 -07:00
Martin Taillefer 1e075ef7cd
Fix broken links (#3636)
- We haven't been checking external links for months now due to a script error
when someone added an option that didn't work as expected. I'm fixing a bunch
of resulting broken links. I can't turn on the link checker yet since there are
some bad links in reference docs which I have to address first.

- Add a bunch of links to yaml files in our code examples using the @@ syntax.
2019-03-11 22:05:18 -07:00
Martin Taillefer 4d20265c5c
Bunch of site improvements. (#3601)
- Work on keyboard navigation support. It's not totally done yet,
but its a lot better than it's ever been.

- Fix incorrect font use for code blocks. They were coming out way
smaller than intended.

- Improve the HTML in a variety of ways to make it better for
screen readers.
2019-03-09 07:31:29 -08:00
mtail efdae03b36 A few more fixes following the big cleanup. 2019-02-10 16:17:45 -08:00
Martin Taillefer d77ac74d81 Generalize handling of text blocks with <<EOF syntax. (#3136) 2019-01-24 17:17:18 -08:00
Martin Taillefer 777abf274a
Improve tab behavior. (#2923)
- Address rendering issue with text blocks nested in a tab that use
the magic @@ linking sequence.

- Made it so when selecting a tab in a particular tab set, other tabset
sharing the same cookie name on the current page will also switch to their
corresponding tab.
2018-11-27 07:25:15 -08:00
Martin Taillefer e4c547edc2
Use Hugo's errorf command instead of injecting magic error strings into the generated HTML. (#2922)
This produces better errors with source file & line info when shortcodes are misused by
markdown files.
2018-11-26 17:22:57 -08:00
Martin Taillefer 9540cd2d19
Site improvements. (#2742)
- Auto-generate tables of template->adapters and adapter->templates

- Make the "Edit this page on GitHub" menu option track the branch correctly instead of always pointing to master.

- Update the reference docs.
2018-10-05 11:15:26 -07:00
Vadim Eisenberg bb22b22308 Use kubectl with EOF instead of cat with pipe (#2620)
* handle kubectl create/apply -f - <<EOF

in the same way as "cat <<EOF | kubectl apply -f -"

* replace cat <<EOF | kubectl apply/create -f - with kubectl apply/create -f - <<EOF
2018-09-15 14:37:23 -07:00
Martin Taillefer 815aaaa72e
Finish implementing tab support. (#2492)
- Support cookies. Tab setting are now remembered across page visits. Set it, and forget it.

- Fix problems with nested text blocks.
2018-09-01 08:59:39 -07:00
Martin Taillefer 77a5540c04
Upgrade to Hugo 0.48 (#2471)
Take advantage of the simplified template syntax introduced in 0.48
in a bunch of places.
2018-08-30 07:24:52 -07:00
Martin Taillefer fd290dc73e
Improve linting (#2148)
- 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.
2018-08-04 08:44:06 -07:00
mtail 8db4fc5047 Fix $cat scanning to be more leniant 2018-07-12 16:45:41 -07:00
mtail 4bba186b81 Special case empty @@ in code blocks to be NOPs. 2018-07-10 12:15:21 -07:00
Martin Taillefer 072abae8ce
Improve name selection process for the new PRE block download feature. (#1693)
- 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.
2018-07-06 18:59:46 -07:00
Martin Taillefer 69c04f6401
Create hidden links for the special @@ references. (#1686)
This gives us link checking for the @@ code block references.
2018-07-06 07:31:31 -07:00
Martin Taillefer 512fdb5b61
Add download & print buttons to all PRE blocks. (#1680)
Also, replaced the text in the Copy button with an icon instead.
2018-07-06 05:30:35 -07:00
Martin Taillefer 07ed229051
Simplify linking to GitHub content. (#1669)
- 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.
2018-07-04 04:16:49 -07:00
Martin Taillefer 0541000be8
Switch from ``` to {{< text >}} to indicate text blocks. (#1644)
This fixes a number of cases of incorrect formatting of code blocks
throughout the site.
2018-06-30 07:11:21 -07:00
Martin Taillefer 5a1b090fbc
Improve handling for code blocks (#1580)
- 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.
2018-06-28 06:29:27 -07:00