Commit Graph

43 Commits

Author SHA1 Message Date
mergify[bot] 6327b9c36c Fixing observability concept doc. (bp #4448) (#4550)
* Fixing observability concept doc. (#4448)

* fix(telemetry docs): replace p&t concept doc with observability doc

* Fixed broken links

* Fixed one internal and one external link

* Added links and fixed two typos

* Title and links changes

* Added Policies conceptual section

* Fixed broken links in commands reference and traffic mnanagement

(cherry picked from commit e260e3385e)

# Conflicts:
#	content/docs/reference/commands/galley/index.html
#	content/docs/reference/commands/istio_ca/index.html
#	content/docs/reference/commands/istioctl/index.html
#	content/docs/reference/commands/mixs/index.html
#	content/docs/reference/commands/pilot-discovery/index.html
#	content/docs/reference/config/policy-and-telemetry/metrics/index.md

* fix merge conflicts
2019-06-28 15:22:11 -04:00
Rigs Caballero c80985e5c8 Add new Traffic management concept as a single page (#4545)
* Add new Traffic management concept.

Improved based on review comments.

Signed-off-by: rcaballeromx <grca@google.com>

Fix Hugo front matter.

Signed-off-by: rcaballeromx <grca@google.com>

Fix false positives in links test.

Signed-off-by: rcaballeromx <grca@google.com>

Remove terms from exceptions file.

Signed-off-by: rcaballeromx <grca@google.com>

corrections

review comments

* Move old traffic-management SVGs to the Zh content.

Signed-off-by: rcaballeromx <grca@google.com>

* Apply final copy-edit.

Signed-off-by: rcaballeromx <grca@google.com>

* Flatten content structure.

Signed-off-by: rcaballeromx <grca@google.com>

* Fix links and blank lines.

Signed-off-by: rcaballeromx <grca@google.com>
2019-06-24 16:37:38 +00:00
Frank Budinsky 1c68d35259 Update apiVersion in blog (#4498) 2019-06-19 17:51:21 +00:00
Rigs Caballero a3b9755357 Reverts the new Traffic management concept due to Hugo bug (#4488)
* Add new Traffic management concept.

Wrote a new "Traffic management" concept to include the latest developments.
Organized the content into smaller pages to make it easier to consume. The new
structure improves visibility and each page includes keywords to improve the
"See Also" pieces of suggested content and SEO. The new concept includes
diagrams and examples. Each section starts with the larger picture and then
moves to explain the specifics.

Signed-off-by: rcaballeromx <grca@google.com>

* Improved based on review comments.

Signed-off-by: rcaballeromx <grca@google.com>

* Fix Hugo front matter.

Signed-off-by: rcaballeromx <grca@google.com>

* Fix false positives in links test.

Signed-off-by: rcaballeromx <grca@google.com>

* Remove terms from exceptions file.

Signed-off-by: rcaballeromx <grca@google.com>

* Revert "Add new Traffic management concept."

This reverts commit de9d0e0225.
2019-06-18 16:37:40 -07:00
Rigs Caballero c53a6c785d Add new Traffic management concept. (#4321)
* Add new Traffic management concept.

Wrote a new "Traffic management" concept to include the latest developments.
Organized the content into smaller pages to make it easier to consume. The new
structure improves visibility and each page includes keywords to improve the
"See Also" pieces of suggested content and SEO. The new concept includes
diagrams and examples. Each section starts with the larger picture and then
moves to explain the specifics.
2019-06-14 16:50:23 -07:00
mtail 92bc65af57 Update Slack logos.
Also, run SVG optimizer on all our images.
2019-03-07 16:10:05 -08:00
Martin Taillefer 7bf371365e
Optimize all our SVG files. (#3468) 2019-03-03 08:14:50 -08:00
Martin Taillefer b82d946d68
No need for weights in blog posts, they auto-sort by publication date. (#3241) 2019-02-12 13:52:09 -08:00
Martin Taillefer dd782b3d12
Improve the looks of warnings, info blobs, and tips. (#3181) 2019-01-31 12:11:53 -08:00
Martin Taillefer 1c1242ffc4
Fix spelling and grammar stuff throughtout the site. (#3114) 2019-01-21 09:35:38 -08:00
Martin Taillefer d7c4eb33f5
Switch to discuss.istio.io (#3071) 2019-01-10 07:11:00 -08:00
Martin Taillefer 51f878a914
Simplify use of the image shortcode. (#3021)
- The width value now defaults to 100%, so it doesn't need to be specified explicitly
in many cases.

- The ratio value can now be computed automatically for PNG and JPG files, so it doesn't need
to be specified explicitly.
2019-01-03 07:46:55 -08:00
Martin Taillefer a2026aab5e
Clean up a bunch of loose ends (#2745) 2018-10-05 22:21:56 -07:00
Martin Taillefer 7d150577ed
Add support for the last_update front-matter field. (#2690) 2018-09-25 15:24:14 -07:00
Martin Taillefer edfdf7d795
Site improvements. (#2663)
* Site improvements.

- For SVG images, authors no longer need to specify image ratios
(which is a constant source of errors)

- Move more icons into the new icons.svg file to further reduce
average page load times.

- Rationalize Istio logo file names.

- Improve underlining behavior for sidebar headers and the RSS feed
Subscribe link.

- Made the RSS feed subscribe link open in a new tab.

- Increase the constract ratio for some elements in dark mode
text blocks (namely, YAML field names)

- Reduce the "brightness" of the light bulb icon which helps it
not pop so much in dark mode.

- Optimize the fonts we load and the order we load them in so as to improve page load time and
reduce the initial render time.

* Sadly, embedding SVGs into the HTML results in duplicate element ids, which is invalid HTML :-(
2018-09-21 17:56:46 -07:00
Martin Taillefer 0a4264417f
Site improvements (#2633)
- Use a new approach to managing icons. This has two primary benefits:

  - It makes it possible to color the icons such that they look good in the
    dark theme. Previously, the icons were rendered in black on dark grey when
    using the dark theme.

  - The average payload size for our web pages is reduced and we better use the
    browser cache.

- The new icon approach makes it possible to remove our dependency on the fontawesome
  package, which further slims down our payload requirement

- Refresh our iconography for a slightly lighter look.

- Remove the extra thick left-hand border of text blocks to lighten the
look.

- Added a "NN minutes to read" indication on top of each page. This is
only displayed if the count is > 1 minute.

- Added a calendar icon next to the blog post date.

- Exposed a bunch of strings that were buried in CSS/JS to translation.

- Add the 'keywords:' front-matter fields to the Hugo archetypes.
2018-09-17 08:52:23 -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
Frank Budinsky 730f34784b Fix broken link (#2570) 2018-09-10 12:41:48 -07:00
Martin Taillefer 5e29d61ff2
Bunch of site fixes & improvements. (#2306)
- Correct the use of OpenGraph annotations. I used the wrong attribute name, so the
annotations were never recognized.

- Added support for Twitter cards to our site, improving the experience of referencing
the site from Twitter posts.

- Added support for the twitter: front matter field for use in blog posts. Specifying this
front-matter entry will show the author's twitter address on the blog post, and will
add a Twitter card entry to the page noting the author's address.

- Renamed the page_icon front matter field to just icon to be consistent with other
entries.

- Made it so the subtitle front matter field can be used anywhere, not just on blog posts.

- Added a lint check to ensure subtitles don't end with a period.

- We now insert an "author" metadata entry whenever the attribution: front matter
field is used.
2018-08-19 11:51:03 -07:00
Frank Budinsky beeb9c341d add DestinationRule to example (#2261) 2018-08-16 09:45:07 -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
Venil Noronha 5342ab2a80 Fix broken Mixer Adapter Dev Guide links (#2144)
Signed-off-by: Venil Noronha <veniln@vmware.com>
2018-08-03 16:32:56 -07:00
Martin Taillefer 1c300c99bd
Spelling improvements (#2037)
Remove a bunch of entries that shouldn't have been in the spelling dictionary
and correct content aoocrdingly.

I'm disabling the Chinese spell checking for now, since I'm not able to fix the
spelling errors that emerged there. Once this PR is in, I'll file an issue to get
those spelling errors addressed and checking reenabled.
2018-07-29 14:27:06 -07:00
Jason Young c27351268b use kubectl for managing Istio API resources (#2002)
* use kubectl consistently throughout for Istio API resource C.R.U.D operations

xref: https://github.com/istio/istio.github.io/issues/1843

* fix typo

* review comments

* remove unnecessary instructions to use `replace` instead of `create`

* fix linter in `zh` content
2018-07-27 10:57:41 -07:00
Martin Taillefer 9d56f3dbe7
Various design changes. (#1976)
- Increase the size of the Copy button in preformatted blocks to make it stand out since it is the
most common used button.

- Shift the copy/download/print buttons in PRE blocks towards the left so they don't overlap the
scroll bar in large text blocks.

- Switch to new fonts.

- Instead of underlining <H2> headers, we now draw a blue bar above them.

- Add an "up level" button at the top of pages.

- Streamline the appearance of the next/previous page links at the bottom of most pages.

- Remove the right pointing arrows from index pages and see also sections. They were just
confusing.

- Add icons to the main pages.

- Slightly change the layout of the glossary page, more to come here.
2018-07-26 06:14:32 -07:00
mtail 7797fd427d A few editorial fixes. 2018-07-25 09:57:55 -07:00
Martin Taillefer 5527dcbaf6
Switch uses of funny quotation marks to plain ones. (#1914)
- Use only standard quotation marks to avoid cut & paste stuff not working

- Put in a lint rule to prevent further use of non-plain quotation marks.
2018-07-22 08:48:03 -07:00
Frank Budinsky de49a21816
Fix references to bookinfo sample files (#1759)
* fix references to sample files

* fix mixer rule link
2018-07-11 09:41:15 -04:00
Isaiah Snell-Feikema f51f015108 Remove Eureka references (#1717) 2018-07-10 12:56:50 -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 1d355094cf Simplify the Concepts section. (#1649) 2018-07-02 06:32:04 -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
Jimmy Song 86c3c0f49a update URLs which have been moved to other places (#1607) 2018-06-28 05:59:08 -07:00
mtail e3c1f36859 Guides -> Examples
As agreed, in prep for the 1.0 launch.
2018-06-27 16:03:53 -07:00
mtail 77da9cccea Next batch of file refactorings. 2018-06-27 00:19:09 -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 9f3e980147
Add support for an auto-generated See Also section on every page. (#1364)
- We now automatically generate a See Also section on pages when possible.
The links are determined by a reverse index based on the keywords
assigned to each page in its front-matter.

- Do a pass to assign keywords to all our pages to populate the See Also
links.

- Leverage the keywords in the front-matter to generate a keyword metadata entry for each
generated page.
2018-06-11 15:07:32 -07:00
Martin Taillefer 1dcd301bd6
Introduce better linking support to github.com/istio/istio (#1443)
- Within a code block, you can now surround a relative file path with @@. This will
cause the path to be rendered as a link to raw.githubusercontent.com/istio/istio/<path>.
This lets the user click on the link to see the content of the file, which is mighty
handy.

- Updated all code blocks to take advantage of the above.

- Introduce support for {{< branch_name >}} which returns the source code branch
name associated with the current doc site.

- Use {{< branch_name >}} in all our references to content in istio/istio on GitHub. This thus
pins our references to the correct version of the content in GitHub. This prevents errors from
gradually appearing in our doc set as content in GitHub starts to diverge from the expectation
in the site content.
2018-06-06 08:21:18 -07:00
mtail fccf3688df Remove trailing space.
(cherry picked from commit e022dbc)
2018-06-02 07:58:40 -07:00
mtail d8619cb42f Fix bad formatting.
(cherry picked from commit 0c00b72)
2018-06-02 07:58:37 -07:00
Martin Taillefer d0f8fddfbf
Cleanup (#1363)
- Remove some leftover toc:false front matter from a few pages. The site now generally
figures out automatically that a TOC is not necessary.

- Enable a Hugo feature that queries Git for a last modified date on files. As a result,
instead of having the site build date in the footer, we now have a "this page was last modified"
date.

- Move the landing page's content out of the layouts directory and into the content directory
where it belongs.

- Use Hugo shortcodes for our embedded icon imagery. And make those icons scale with the
font size rather than being fixed sizes.

- Enable support for emojis in our content. Just use 
and you'll get a sailboat for example.
2018-05-26 08:28:14 -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