Commit Graph

70 Commits

Author SHA1 Message Date
mtail 95ea76c737 Update reference docs. 2018-07-09 14:49:30 -07:00
mtail 843bef8ddb Update reference docs. 2018-06-29 17:42:41 -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
mtail 5cd535e05a Final round of file renames. 2018-06-27 07:21:21 -07:00
Martin Taillefer 8c0cb431ce
Add support for snippets and file content insertion. (#1567)
- 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.
2018-06-21 09:56:22 -07:00
Jason Young e0d5cee035 update galley references docs to istio.io (#1556) 2018-06-20 06:24:57 -07:00
Jason Young 5a25251d28 make reference generation work with golang vendor directory (#1557) 2018-06-19 16:50:54 -07:00
mtail 75b550307c Update reference docs. 2018-06-12 11:34:01 -07:00
mtail 5bfc6bafea Update reference docs 2018-06-11 22:29:34 -07:00
Martin Taillefer 80d948d44c
Update reference docs. (#1385) 2018-05-30 10:32:00 -07:00
mtail 951a8ed9f4 Switch from Jekyll to Hugo. 2018-05-25 20:02:32 -07:00
mtail 054ce6164c Update reference docs. 2018-03-26 22:02:39 -07:00
mtail 3f07330cc8 Update reference docs. 2018-03-20 13:20:37 -07:00
Jason Young aacdcfc159 update document generation for istioctl (#1047) 2018-03-02 17:29:59 -08:00
Martin Taillefer 8ec8e250da
Update reference docs. (#942)
* Update reference docs.

- We now replace instances of https://istio.io with {{site.baseurl}} in imported
reference docs such that the generated site will work properly for staging and for
archive.istio.io

* Fix a bad link.
2018-02-06 20:48:33 -08:00
Martin Taillefer 428af2c847
Update reference docs. (#937) 2018-02-06 09:48:31 -08:00
Martin Taillefer e795a779c4
Regenerate docs with latest tooling. (#926) 2018-02-01 21:04:37 -08:00
Shriram Rajagopalan 9a0cdae6a9
fix v1alpha2 docs (#919)
* doc fix

* nit
2018-02-01 16:23:48 -05:00
Martin Taillefer 5291eb1682
Update CLI docs and create reproducible process to update these docs. (#916) 2018-02-01 09:33:56 -08:00
Martin Taillefer 23b47d9983
Prepare for new generated reference content. (#889)
- 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.
2018-01-29 06:44:07 -08:00