Commit Graph

54 Commits

Author SHA1 Message Date
Martin Taillefer 0a5a870b02 Minor addition to style guide. 2017-05-17 10:32:19 -07:00
Laurent Demailly c084cf2bab Fixing remaining bad links and html errors (#236)
* Fixing most of remaining bad links

Still left :
#google.rpc.Code in reference/api/mixer/status

And the mixer-config-quota-bookinfo.yaml is missing in
https://github.com/istio/istio/tree/master/samples/apps/bookinfo

* Add html checking and ignore localhost urls

fixed typo in layouts/base found by html checking

* Fix duplicate id defined

Those anchors don’t seem used btw

* Adding back html proofer

got removed accidentally it seems

* Fix the last 2 errors
2017-05-16 15:09:03 -07:00
Shriram Rajagopalan d348a795a0 fix incorrect LB spec 2017-05-16 09:43:08 -04:00
Martin Taillefer bc3b899ccc Move everything back out of the src directory since its make GitHub Pages unhappy. 2017-05-15 21:53:10 -07:00
Martin Taillefer 065e7a5c71 Move site content into the src directory.
This clearly separates site content from other repo state.
2017-05-15 19:22:30 -07:00
Martin Taillefer 61be48cd78 Improve generate reference documentation overview text. 2017-05-10 07:07:17 -07:00
Martin Taillefer 5ed6ca9104 Move glossary words to the same plan as FAQ entries. 2017-05-10 05:36:57 -07:00
Douglas Reid 45fd2a2a60 Remove config and mixer from titles of docs (#145)
* Remove config and mixer from titles of docs

* attrgen -> attributes
2017-05-09 19:04:01 -07:00
Martin Taillefer 00b1aac198 Split the Configuration & API reference section in two parts. 2017-05-09 17:18:26 -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
Martin Taillefer e1af5e6001 Fix formatting of many <pre> blocks to not have extra spaces at the start of each line. 2017-05-09 13:03:14 -07:00
Martin Taillefer 61af61b5d8 Fix a bunch of formatting on non-docs pages. 2017-05-09 09:59:15 -07:00
mandarjog 3ef49a6ee0 fix description of source.user in the vocabulary. (#132) 2017-05-09 09:53:06 -07:00
Zack 34b88ab280 Update mixer proto generated docs (#129)
* Re-regenerate the protos

* Update the metric desc by hand for the pending fix to code snippets in its comments

* Add a file for the status proto's docs, refer to it everywhere and remove the embedded status docs generated everywhere they're used.

* remove mixer services's embedded status proto by hand
2017-05-08 18:04:53 -07:00
Martin Taillefer d4fe298cf8 Fix some formatting issues and get rid of some dead stuff. 2017-05-08 12:28:41 -07:00
Shriram Rajagopalan b691649b51 fix broken links 2017-05-08 10:20:10 -04:00
Shriram Rajagopalan 643014f824 cleaning up references into smaller sections 2017-05-07 22:36:41 -04:00
Hong Zhang a1224c5292 Avoid - in attribute name for user agent. (#116)
* Avoid - in attribute name.
* Update a few comments.
* Minor English change.
2017-05-06 19:00:39 -07:00
Shriram Rajagopalan 20fd6b39b8 cleanup generated proto docs 2017-05-06 16:20:52 -04:00
Shriram Rajagopalan 0a1e1b6a9d reversing previous commit 2017-05-05 20:30:18 -04:00
Shriram Rajagopalan bcc9606af0 clean up references 2017-05-05 20:21:42 -04:00
Zack b590cfa219 Just the proxy docs (#122) 2017-05-05 19:48:23 -04:00
Martin Taillefer ab01ebc976 Add a blurb in the footer about filing issues for incorrect web site content. 2017-05-04 21:00:08 -07:00
Martin Taillefer eeec41de34 Add guidance on how to create links within docs. 2017-05-04 20:35:53 -07:00
Martin Taillefer dc94161777 Fix broken links. 2017-05-04 18:15:02 -07:00
Liam White 124570bbc8 Swagger doc first pass (#113)
Signed-off-by: Liam White <liamwhite@uk.ibm.com>
2017-05-04 16:17:56 -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
Martin Taillefer 5a167da380 Move istioctl, mixc, and mixs into a Command subcategory. (#106) 2017-05-03 15:40:57 -07:00
Martin Taillefer 52e94ecc59 Update Style Guide to include terminology standards.
- Update various documents that didn't follow the style guide in various ways.
2017-05-03 11:26:45 -07:00
Martin Taillefer 25fabe16f9 Various fixes
- Fix a number of broken links when viewing on a github staging site.

- Updated highligthing of "Edit this Page" pencil to match what other
buttons use on the site.

- Fixed the rendering of buttons on the landing page to have the proper
rounded corners to match our style.

- Support documents which omit the order: front matter field. Instead
of mysterious failues, they are now processed correctly and an error
message is inserted in the generated HTML to let the author know to
add the missing info.
2017-05-03 05:52:39 -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 7c0c755075 Fix several broken links. 2017-05-02 11:35:58 -07:00
Shriram Rajagopalan 8d949d29cc assorted cleanups/nits 2017-05-02 01:03:46 -04:00
GregHanson bc7df6d0c3 update docs to use durations for time fields instead of floats (#83) 2017-05-01 10:51:36 -04:00
Martin Taillefer e0b9750ee4 Elimintate the need for the bodyclass: front matter field in docs. 2017-04-30 06:42:29 -07:00
Martin Taillefer 984dc7f8fc Clean up a lot of CSS stuff we inherited... 2017-04-29 22:47:50 -07:00
Martin Taillefer 183e3b6b30 Add search functionality. 2017-04-29 11:07:05 -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
Martin Taillefer 9a613ba637 Update glossary and HTML meta tags 2017-04-28 10:33:15 -07:00
Martin Taillefer b386fb1eed Temp improvement for istioctl auto-gen content. 2017-04-28 06:56:08 -07:00
Martin Taillefer c6ad2fca22 New nav tree model.
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.
2017-04-28 06:18:38 -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
Zack bff265422d Generated docs for our protos (#65)
* Generated docs for our protos.

Unfortunately this did require some manual touch-up, but nothing that'll
be impossible to automate I think. I still need to grab the mixer aspect
config protos, which is a bit harder because they live in the mixer
repo.

* Rename envoy-config to proxy-config, update document title and overview.
2017-04-26 13:05:11 -07:00
Martin Taillefer 291c0a80b5 Simplify FAQ and Glossary pages 2017-04-25 13:12:04 -07:00
Martin Taillefer 4974e84677 Auto-generate all the doc index pages. 2017-04-25 11:54:33 -07:00
Martin Taillefer 106c44fc3f Start working on the glossary. (#59)
- Also fixed a few things in the installation guide

- Update a few other docs along the way.
2017-04-25 08:56:12 -07:00
Ed Snible 2a17ee6a51 'list' is now 'get' (#58) 2017-04-25 09:45:52 -04:00
Ed Snible 9c151e299d Document all CLI options (#55) 2017-04-25 07:20:58 -04:00
Martin Taillefer e8cd5a4e1b Get rid of {{site.baseurl}}, we generally don't need this for links. 2017-04-22 15:36:35 -07:00
Martin Taillefer cdc0eee637 Few updates to the mixer docs. 2017-04-22 10:25:11 -07:00