Commit Graph

300 Commits

Author SHA1 Message Date
Martin Taillefer 597f7ce3b4
Enable more linting rules (#1824)
Fix feported linting errors.
2018-07-15 07:49:11 -07:00
Martin Taillefer a1b483a7f2
Update to latest Hugo (#1821) 2018-07-14 06:32:22 -07:00
Martin Taillefer 72f6f1353f
Update reference docs. (#1812) 2018-07-13 15:00:52 -07:00
Martin Taillefer f4a0656ab1 Add a lint check for incorrectly indented code blocks. (#1800)
Fixed a problem reported by the link check.
2018-07-13 07:26:36 -07:00
mtail 95ea76c737 Update reference docs. 2018-07-09 14:49:30 -07:00
Martin Taillefer 3d511f5a70
Various site fixes. (#1701)
- 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.
2018-07-08 17:12:12 -07:00
Steven Dake 9765bf65ca Generate Helm config options from values.md (#1694) 2018-07-06 07:12:12 -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
mtail 843bef8ddb Update reference docs. 2018-06-29 17:42:41 -07:00
mtail fa0a3fe408 Turn htmlproofer back on. 2018-06-28 07:53:34 -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
mtail 5296742475 First pass at refactoring file locations.
This also reenables html proofing, which I accidentally left
off in an earlier commit.
2018-06-26 23:29:47 -07:00
Martin Taillefer ac1cbc7730
Improve linting script (#1582)
- Add useful error messages so people can self-serve when they get linting errors.

- Run all linters even if one fails. This gives you all the linting errors in one shot.
2018-06-25 06:46:47 -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
Jimmy Song b9f7174e2b quick start doc translation (#1523)
* quick start doc translation

* fix the markdown style

* enable Chinese spell checker
2018-06-18 06:08:12 -07:00
Martin Taillefer 5ce2c7bb2d
Bunch 'o fixes (#1529)
- Make "make serve" actually work.

- Eliminate superfluous "scroll left nav into view" button on screens that don't have a sidebar
(community & search result). Only matters on mobile.

- Fix unpleasant wrapping in the footer when on mobile.
2018-06-15 20:38:36 -07:00
Martin Taillefer 857f86abad
Update Makefile for simplified Netlify scheme. (#1525) 2018-06-15 17:02:08 -07:00
mtail f8a5265efa Get all the bits in place to do docker-based build, generation, linting, and serving of the site. 2018-06-15 15:51:04 -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 401989fba6 Shuffle content around for the Hugo migration. 2018-05-25 19:27:39 -07:00
Martin Taillefer 3aaa9653d6
Make spell checking and style checking part of our doc checkin gate. (#1154) 2018-04-05 10:31:50 -07:00
mtail 7acb463af4 Finish fixing remaining lint errors 2018-04-05 07:47:20 -07:00
Martin Taillefer a6fae1b368
Setup for linting markdown files. (#1147)
- 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.
2018-04-04 22:22:14 -07:00
mtail 054ce6164c Update reference docs. 2018-03-26 22:02:39 -07:00
Martin Taillefer 3285d62b97
Delete some old stuff we don't need anymore.
* Delete some old stuff we don't need anymore.

* Fix problem preventing proper section indices in the "About" section of the site.
2018-03-26 15:38:03 -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
Laurent Demailly b300210e82
Update script header to indicate the new location (#841)
* Update script header to indicate the new location

* Typo
2018-01-05 15:37:43 -08:00
Yang Guan e6fe749a2c Document CLI options for istio_ca (#441)
* Generate documentation for istio_ca

* linter
2017-09-12 16:38:13 -07:00
Laurent Demailly 301d8407c0 Fixing bug : we were pushing the previous build (#408)
Had to run it twice to make it work: fixing

Need to move _site after the build, not before
2017-07-11 15:29:34 -07:00
Laurent Demailly 4eff4773bf Typo fix + updated gitignore + grafana url fix (#405)
Typo fix + updated gitignore + grafana url fix
2017-07-10 15:20:45 -07:00
mandarjog 61d0bce7df versioned docs: add build scripts to be driven thru jenkins (#368)
* add build scripts to be driven thru jenkins

* uniformly handle site.baseurl

* data-src should use full paths for now

* update build with version tag

* Add explanation re: CORS

* remove gitmodules
2017-06-12 09:23:11 -07:00
Jason Young e671aa6e02 Refresh auto-generated command line reference docs (#141)
* refresh command tool docs

* use relative paths in auto-generated docs

* fix links

* hide --istioNamespace and remove links to avoid future maintenance burden

* review comments
2017-05-09 18:15:03 -04:00
Zack 4fa6a66361 Rename the mixer CLI markdown generation script, update it to generate istioctl reference docs as a single file too. (#112) 2017-05-04 11:41:59 -07:00
Zack 32119f89a9 Automate generation of mixer CLI collateral docs (#99)
* Automate generation of mixer CLI collateral docs

* SEE ALSO -> See Also
2017-05-02 15:11:18 -07:00
Martin Taillefer e0b9750ee4 Elimintate the need for the bodyclass: front matter field in docs. 2017-04-30 06:42:29 -07:00
Jason Young 98f1d119a4 update istioctl docs auto-generation script (#79)
* update istioctl docs auto-generation script

* istioctl: fix example usage formatting
2017-04-28 13:32:33 -07:00
Jason Young b45f1b4485 Auto-generate reference documentation for istioctl. (#67)
* wip - auto-generate istioctl reference

* address review comments
2017-04-27 10:31:58 -07:00