Simplify FAQ and Glossary pages

This commit is contained in:
Martin Taillefer 2017-04-25 13:09:57 -07:00
parent 957d3cb3d8
commit 291c0a80b5
7 changed files with 81 additions and 228 deletions

View File

@ -61,93 +61,41 @@ RDS Route Discovery Service -- See https://lyft.github.io/envoy/docs/configurati
-->
<div class="container">
<div class="row">
<div class="col-md-11 nofloat center-block">
<!-- Constrain readable sections to 9 unit wide columns for improved readability. -->
<div class="col-md-9 glossary-container">
<h5 class="glossary-title">Glossary</h5>
<ul class="list-unstyled">
# Glossary
<li class="submenu">
<h6 class="arrow-r">Envoy</h6>
<div id="envoy" class="submenu-content">
Envoy is the high-performance proxy that Istio uses to mediate all inbound and outbound traffic for all services in the service mesh.
Learn more about Envoy <a href="https://lyft.github.io/envoy/">here</a>.
</div>
</li>
- **Envoy**.
Envoy is the high-performance proxy that Istio uses to mediate all inbound and outbound traffic for all services in the service mesh.
Learn more about Envoy [here](https://lyft.github.io/envoy/).
<li class="submenu">
<h6 class="arrow-r">Istio-Auth</h6>
<div class="submenu-content">
Istio-Auth provides strong service-to-service and end-user authentication using mutual TLS, with built-in identity and
credential management. Learn more about Istio-Auth *TBD*.
</div>
</li>
- **Istio-Auth**.
Istio-Auth provides strong service-to-service and end-user authentication using mutual TLS, with built-in identity and
credential management. Learn more about Istio-Auth *TBD*.
<li class="submenu">
<h6 class="arrow-r">Istio-Manager</h6>
<div class="submenu-content">
Istio-Manager serves as an interface between the user and Istio, collecting and validating configuration and propagating it to the
various Istio components. It abstracts environment-specific implementation details from Mixer and Envoy, providing them with an
abstract representation of the users services
that is independent of the underlying platform.
</div>
</li>
- **Istio-Manager**.
Istio-Manager serves as an interface between the user and Istio, collecting and validating configuration and propagating it to the
various Istio components. It abstracts environment-specific implementation details from Mixer and Envoy, providing them with an
abstract representation of the users services
that is independent of the underlying platform.
<li class="submenu">
<h6 class="arrow-r">Microservice</h6>
<div class="submenu-content">
A lightweight service.
</div>
</li>
- **Microservice**.
A lightweight service.
<li class="submenu">
<h6 class="arrow-r">Mixer</h6>
<div class="submenu-content">
Mixer is an Istio component responsible for enforcing access control and usage policies across the service mesh and collecting telemetry data
from the Envoy proxy and other services. Learn more about Mixer <a href="/docs/concepts/mixer.html">here</a>.
</div>
</li>
- **Mixer**.
Mixer is an Istio component responsible for enforcing access control and usage policies across the service mesh and collecting telemetry data
from the Envoy proxy and other services. Learn more about Mixer [here](/docs/concepts/mixer.html).
<li class="submenu">
<h6 class="arrow-r">Service</h6>
<div class="submenu-content">
A well-known IP endpoint and port that implements a specific protocol.
</div>
</li>
- **Service**.
A well-known IP endpoint and port that implements a specific protocol.
<li class="submenu">
<h6 class="arrow-r">Service Consumer</h6>
<div class="submenu-content">
The agent that is using a service.
</div>
</li>
- **Service Consumer**.
The agent that is using a service.
<li class="submenu">
<h6 class="arrow-r">Service Mesh</h6>
<div class="submenu-content">
A collection of services interconnected through Istio's fleet of proxies.
</div>
</li>
- **Service Mesh**.
A collection of services interconnected through Istio's fleet of proxies.
<li class="submenu">
<h6 class="arrow-r">Service Operator</h6>
<div class="submenu-content">
The agent that deploys and manages a service by manipulating configuration state and
monitoring health via a variety of dashboards.
</div>
</li>
- **Service Operator**.
The agent that deploys and manages a service by manipulating configuration state and
monitoring health via a variety of dashboards.
<li class="submenu">
<h6 class="arrow-r">Service Producer</h6>
<div class="submenu-content">
The agent that creates a service by writing source code.
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
- **Service Producer**.
The agent that creates a service by writing source code.

View File

@ -1,5 +0,0 @@
---
title: faq
layout: default
bodyclass: faq
---

View File

@ -1,37 +1,17 @@
// FAQ page
.faq-container {
padding-bottom: 150px;
.faq {
padding-bottom: 150px;
.submenu-content p,li,ul{
font-size: 12px;
font-weight: 400;
}
h1 {
color: $mainBrandColor;
padding-left: 20px;
}
.lead,
.faq-title {
color: $titleColor;
}
h4 {
font-size: 110%;
padding-left: 20px;
}
.lead {
margin: 50px 0 40px 0;
}
.faq-title {
margin: 40px 0 0 0;
}
h6 {
font-size: .95rem;
letter-spacing: 1px;
}
h6.arrow-d,
h6.arrow-r {
margin: 30px 0 5px 0;
color: $black;
}
h6.arrow-d {
color: $black;
}
p {
padding-left: 30px;
}
}

View File

@ -1,38 +0,0 @@
// Glossary page
.glossary-container {
padding-bottom: 15px;
.submenu-content p,li,ul{
font-size: 12px;
font-weight: 400;
list-style: none;
}
.lead,
.glossary-title {
color: $titleColor;
}
.lead {
margin: 50px 0 40px 0;
}
.glossary-title {
margin: 40px 0 40px 0;
}
h6 {
font-size: .95rem;
letter-spacing: 1px;
}
h6.arrow-d,
h6.arrow-r {
margin: 0px 0 5px 0;
color: $black;
}
h6.arrow-d {
color: $black;
}
}

View File

@ -25,7 +25,6 @@
@import "pages/_blog";
@import "pages/_docs";
@import "pages/_faq";
@import "pages/_glossary";
@import "pages/_landing";
@import "pages/_about";
@import "pages/_community";

View File

@ -1,71 +0,0 @@
---
title: FAQ
layout: default
group: 'navigation'
bodyclass: faq
---
<div class="container">
<div class="row">
<div class="col-md-11 nofloat center-block">
<div class="col-md-9 faq-container">
<ul class="list-unstyled">
<li class="submenu">
<h6 class="arrow-r">What is Istio?</h6>
<div class="submenu-content">
<p>FILL ME.</p>
<!-- <p> Read the longer <a href="{{ site.baseurl }}/blog/principles">Motivation &amp; Design Principles</a> post for background on why we created gRPC.</p> -->
</div>
</li>
<li class="submenu">
<h6 class="arrow-r">Why would I want to use Istio?</h6>
<div class="submenu-content">
<p>
The main usage scenarios:
<ul>
<li>FILL ME.</li>
</ul>
</p>
</div>
</li>
<li class="submenu">
<h6 class="arrow-r">How do I get started using Istio?</h6>
<div class="submenu-content">
<p>You can start with installation of Istio by following instructions from <a href="/docs/tasks">here</a>.</p>
</div>
</li>
<li class="submenu">
<h6 class="arrow-r">What is the license?</h6>
<div class="submenu-content">
<p>Apache V2.</p>
</div>
</li>
<li class="submenu">
<h6 class="arrow-r">How can I contribute?</h6>
<div class="submenu-content">
<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>
</div>
</li>
<li class="submenu">
<h6 class="arrow-r">What is the roadmap?</h6>
<div class="submenu-content">
<p>See <a href="/docs/reference/release-roadmap.html">here</a> for info on our release roadmap.
</div>
</li>
</ul>
</div>
</div>
</div>
</div>

40
faq/index.md Normal file
View File

@ -0,0 +1,40 @@
---
title: FAQ
group: 'navigation'
bodyclass: faq
type: markdown
---
# Frequently Asked Questions
#### What is Istio?
TBD
#### Why would I want to use Istio?
TBD
#### How do I get started using Istio?
TBD
#### What is the license?
Apache V2.
#### How can I contribute?
Contributors are highly welcome and the repositories are hosted on GitHub.
We look forward to community feedback, additions and bugs.
Please see our [Contribution Guidelines](https://github.com/istio/istio/blob/master/CONTRIBUTING.md)
to learn how to contribute.
#### Where is the documentation?
Check out the [documentation](/docs) right here on istio.io.
#### What is the roadmap?
See [here](/docs/reference/release-roadmap.html) for info on our release roadmap.