mirror of https://github.com/istio/istio.io.git
Various content fixes.
This commit is contained in:
Martin Taillefer
parent
f52f1242c2
commit
5c0ddb2956
|
|
@ -1,4 +1,5 @@
|
|||
<ul class="doc-side-nav doc-side-nav-tasks">
|
||||
{% assign current = page.url | downcase | split: '/' %}
|
||||
<li><h5 class="doc-side-nav-title">Tasks</h5></li>
|
||||
<li class="doc-side-nav-list-item"><a href="{{ site.baseurl }}/docs/tasks/getting-started.html" {% if current[3] == 'getting-started.html' %}class='current'{% endif %}>Getting Started</a></li>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -7,3 +7,7 @@ type: markdown
|
|||
sidenav: doc-side-concepts-nav.html
|
||||
---
|
||||
|
||||
# Concepts
|
||||
|
||||
The Concepts section helps you learn about the different parts
|
||||
of the Istio system and the abstractions it uses.
|
||||
|
|
|
|||
|
|
@ -7,12 +7,14 @@ layout: docs
|
|||
type: markdown
|
||||
---
|
||||
|
||||
Individual topics are built using page templates which provide some consistent
|
||||
formatting and style to all pages within Istio documentation.
|
||||
These page templates are available for writers who would like to contribute new topics to the Istio docs:
|
||||
|
||||
- [Concept](#concept_template)
|
||||
- [Task](#task_tempplate)
|
||||
- [Tutorial](#tutorial_template)
|
||||
- [Sample](#sample-template)
|
||||
- [Concept template](#concept-template)
|
||||
- [Task template](#task-tempplate)
|
||||
- [Tutorial template](#tutorial-template)
|
||||
- [Sample template](#sample-template)
|
||||
|
||||
The page templates are in the [_include/templates](https://github.com/istio/istio.github.io/tree/master/_includes/templates)
|
||||
directory of the [istio.github.io](https://github.com/istio/istio.github.io) repository.
|
||||
|
|
|
|||
|
|
@ -6,19 +6,16 @@ bodyclass: docs
|
|||
layout: docs
|
||||
type: markdown
|
||||
---
|
||||
|
||||
Welcome to Istio's documentation home page. From here you can learn all about Istio by following
|
||||
the links below:
|
||||
|
||||
- [Concepts]({{site.bareurl}}/docs/concepts). Concepts explain some significant aspect of Istio. This
|
||||
is where you can learn about what Istio does and how it does it.
|
||||
|
||||
- [Tasks]({{site.bareurl}}/docs/tasks). Tasks show you how to do a single directed activity with Istio.
|
||||
|
||||
- [Tutorials]({{site.bareurl}}/docs/tutorials). Tutorials are more involved, composing many individual tasks together
|
||||
to show you how to perform more complex activities.
|
||||
|
||||
- [Samples]({{site.bareurl}}/docs/samples). Samples are fully working stand-alone examples
|
||||
intended to highlight a particular set of Istio's features.
|
||||
|
||||
- [Reference]({{site.bareurl}}/docs/reference). Detailed exhaustive list of
|
||||
command-line options, configuration options, and API definitions.
|
||||
|
|
|
|||
|
|
@ -6,3 +6,9 @@ title: Reference
|
|||
type: markdown
|
||||
sidenav: doc-side-reference-nav.html
|
||||
---
|
||||
|
||||
# Reference
|
||||
|
||||
The Reference section contains detailed authoritative reference
|
||||
material such as command-line options, configuration options,
|
||||
and API calling parameters.
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ bodyclass: docs
|
|||
layout: docs
|
||||
type: markdown
|
||||
---
|
||||
# Samples
|
||||
|
||||
Take the walkthroughs in this section to get a high-level idea of Istio's features. The samples are currently targeted towards
|
||||
Kubernetes users. We are working on adding support for other platforms.
|
||||
The Samples section contains pages that present a variety of fully working
|
||||
example uses for Istio that you can experiment with.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
title: Getting Started
|
||||
headline: Getting Started with Istio
|
||||
sidenav: doc-side-tasks-nav.html
|
||||
bodyclass: docs
|
||||
layout: docs
|
||||
type: markdown
|
||||
---
|
||||
{% capture overview %}
|
||||
This page shows how to get started using Istio in a Kubernetes cluster. You'll learn
|
||||
how to install Istio and get it initially configured and running.
|
||||
{% endcapture %}
|
||||
|
||||
{% capture prerequisites %}
|
||||
* Do this.
|
||||
* Do this too.
|
||||
{% endcapture %}
|
||||
|
||||
{% capture steps %}
|
||||
## Doing ...
|
||||
|
||||
1. Do this.
|
||||
1. Do this next. Possibly read this [related explanation](...).
|
||||
{% endcapture %}
|
||||
|
||||
{% capture discussion %}
|
||||
## Understanding ...
|
||||
|
||||
Here's an interesting thing to know about the steps you just did.
|
||||
{% endcapture %}
|
||||
|
||||
{% capture whatsnext %}
|
||||
* Learn more about [this](...).
|
||||
* See this [related task](...).
|
||||
{% endcapture %}
|
||||
|
||||
{% include templates/task.md %}
|
||||
|
|
@ -2,9 +2,11 @@
|
|||
title: Tasks
|
||||
headline: Tasks
|
||||
sidenav: doc-side-tasks-nav.html
|
||||
Fbodyclass: docs
|
||||
bodyclass: docs
|
||||
layout: docs
|
||||
type: markdown
|
||||
---
|
||||
# Tasks
|
||||
|
||||
TBD
|
||||
The Tasks section contains pages that each show how to do a single specific and reasonably targeted
|
||||
activity with the Istio system.
|
||||
|
|
|
|||
|
|
@ -6,12 +6,8 @@ bodyclass: docs
|
|||
layout: docs
|
||||
type: markdown
|
||||
---
|
||||
<p class="lead">
|
||||
Get started with Istio
|
||||
</p>
|
||||
|
||||
<div id="toc" class="toc mobile-toc"></div>
|
||||
|
||||
These pages show you how to get up and running as quickly as possible with Istio,
|
||||
including installing all the tools you’ll need.
|
||||
# Tutorials
|
||||
|
||||
The Tutorials section contains pages that show how to accomplish specific reasonably significant goals within Istio.
|
||||
Typically a tutorial has several sections, each of which has a sequence of steps.
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: FAQ
|
||||
headline: 'Frequently Asked Questions'
|
||||
layout: default
|
||||
group: 'navigation'
|
||||
title: FAQ
|
||||
bodyclass: faq
|
||||
headline: 'Frequently Asked Questions'
|
||||
---
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
|
|
@ -49,20 +49,23 @@ headline: 'Frequently Asked Questions'
|
|||
<li class="submenu">
|
||||
<h6 class="arrow-r">How can I contribute?</h6>
|
||||
<div class="submenu-content">
|
||||
<p><a href="/contribute/">Contributors</a> are highly welcome and the repositories are hosted on GitHub. We look forward to community feedback, additions and bugs. Both individual contributors and corporate contributors need to sign our CLA. If you have ideas for a project around gRPC, please read guidelines and submit <a href="https://github.com/istio/istio/blob/master/CONTRIBUTING.md">here</a>.</p>
|
||||
<p>Contributors are highly welcome and the repositories are hosted on GitHub.
|
||||
We look forward to community feedback, additions and bugs.
|
||||
Please see our <a href="https://github.com/istio/istio/blob/master/CONTRIBUTING.md">Contribution Guidelines</a>
|
||||
to learn how to contribute.</p>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
<li class="submenu">
|
||||
<h6 class="arrow-r">Where is the documentation?</h6>
|
||||
<div class="submenu-content">
|
||||
<p>Check out the <a href="/docs/">documentation</a> right here on istio.io.</p>
|
||||
<p>Check out the <a href="/docs/">documentation</a> right here on istio.io.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li class="submenu">
|
||||
<h6 class="arrow-r">What is the roadmap?</h6>
|
||||
<div class="submenu-content">
|
||||
<p>The roadmap is being tracked in GitHub <a target="_blank" href="{{ site.data.config.milestones_link }}">milestones</a>. Please refer to the respective milestones in the manager and mixer repositories under the GitHub Istio org.</p>
|
||||
<p>See <a href="{{site.baseurl}}/docs/home/roadmap.html">here</a> for info on our release roadmap.
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
Loading…
Reference in New Issue