Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change versioned documentation structure #236

Merged
merged 11 commits into from
Jun 8, 2020
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ vendor
.idea/

# Autogenerate by build
content/documentation/developer-api/index.html
content/documentation/*/developer-api/index.html

# Emacs
*~
Expand Down
34 changes: 20 additions & 14 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ relativeURLs = true
[[menu.main]]
identifier = "main_features"
name = "Features"
url = "/documentation/features"
url = "/documentation/latest/features"
weight = 1
[[menu.main]]
identifier = "main_news"
Expand All @@ -37,7 +37,7 @@ relativeURLs = true
[[menu.main]]
identifier = "main_gettingstarted"
name = "Getting Started"
url = "/documentation/getting-started"
url = "/documentation/latest/getting-started"
weight = 3
[[menu.main]]
identifier = "main_contribute"
Expand All @@ -52,75 +52,81 @@ relativeURLs = true
[[menu.main]]
identifier = "doc_features"
name = "Features"
url = "/documentation/features"
url = "/documentation/latest/features"
weight = 1
parent="main_doc"
[[menu.main]]
identifier = "validation"
name = "Validation"
url = "/documentation/validations"
url = "/documentation/latest/validations"
weight = 1
parent="doc_features"
[[menu.main]]
identifier = "doc_gettingstarted"
name = "Getting Started"
url = "/documentation/getting-started"
url = "/documentation/latest/getting-started"
weight = 2
parent="main_doc"
[[menu.main]]
identifier = "doc_architecture"
name = "Architecture"
url = "/documentation/architecture"
url = "/documentation/latest/architecture"
weight = 3
parent="main_doc"
[[menu.main]]
identifier = "doc_runtimes"
name = "Custom Dashboards"
url = "/documentation/runtimes-monitoring"
url = "/documentation/latest/runtimes-monitoring"
weight = 4
parent="main_doc"
[[menu.main]]
identifier = "doc_tracing"
name = "Distributed Tracing"
url = "/documentation/distributed-tracing"
url = "/documentation/latest/distributed-tracing"
weight = 5
parent="main_doc"
[[menu.main]]
identifier = "doc_extensions"
name = "Extensions"
url = "/documentation/extensions"
url = "/documentation/latest/extensions"
weight = 6
parent="main_doc"
[[menu.main]]
identifier = "doc_swagger"
name = "Developer API"
url = "/documentation/developer-api"
url = "/documentation/latest/developer-api"
weight = 7
parent="main_doc"
[[menu.main]]
identifier = "doc_glossary"
name = "Glossary"
url = "/documentation/glossary"
url = "/documentation/latest/glossary"
weight = 8
parent="main_doc"
[[menu.main]]
identifier = "concepts"
name = "Concepts"
url = "/documentation/glossary/concepts"
url = "/documentation/latest/glossary/concepts"
weight = 1
parent="doc_glossary"
[[menu.main]]
identifier = "observability"
name = "Observability"
url = "/documentation/glossary/observability"
url = "/documentation/latest/glossary/observability"
weight = 2
parent="doc_glossary"
[[menu.main]]
identifier = "networking"
name = "Networking"
url = "/documentation/glossary/networking"
url = "/documentation/latest/glossary/networking"
weight = 3
parent="doc_glossary"
[[menu.main]]
identifier = "doc_archive"
name = "Older Releases"
url = "/documentation"
weight = 9
parent="main_doc"
[[menu.main]]
identifier = "main_faq"
name = "FAQ"
Expand Down
17 changes: 14 additions & 3 deletions content/documentation/_index.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
---
title: "Documentation"
date: 2018-06-20T19:04:38+02:00
date: 2020-04-03T01:05:25-03:00
draft: false
type: "documentation"
---
indexTitle: "Older Releases"
---

Here you can find all the documentation for Kiali. You can see
the documentation for the latest released version link:/documentation/latest[here].

Check the link:/documentation/latest/getting-started[Getting
Started] section of the documentation to get up to speed. If you
are thinking of contributing, check our
link:https://github.com/kiali/kiali[Github repo]
for more information on how to setup your own machine and
contribute.

7 changes: 0 additions & 7 deletions content/documentation/archive/_index.adoc

This file was deleted.

6 changes: 6 additions & 0 deletions content/documentation/edge/_index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Edge"
date: 2018-06-20T19:04:38+02:00
draft: false
type: "documentation"
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Features"
aliases:
- /features/
- /documentation/overview/
- /documentation/edge/overview/
date: 2018-06-20T19:04:38+02:00
draft: false
type: "features"
Expand Down Expand Up @@ -186,7 +186,7 @@ Kiali comes with default dashboards for several runtimes, including Go, Node.js,
These dashboards are simple Kubernetes resources, so you can use your favorite tool to create, modify or delete them.
As they are defined as plain YAML or JSON files, so it's easy to keep them in source control like Git, track their changes, and share them.

Check out the link:/documentation/runtimes-monitoring/[documentation page, window=_blank] to learn more about it.
Check out the link:/documentation/edge/runtimes-monitoring/[documentation page, window=_blank] to learn more about it.
++++
<a class="image-popup-fit-height" href="/images/documentation/features/runtimes_monitoring.png" title="Runtimes Dashboards">
<img src="/images/documentation/features/runtimes_monitoring_thumb.png" style="display:block;margin: 0 auto;" />
Expand Down Expand Up @@ -219,7 +219,7 @@ Kiali performs a set of validations to the most common Istio Objects such as Des

Galley validations are mostly syntactic validations based on the object syntax analysis of Istio objects while Kiali validations are mostly semantic validations between different Istio objects. Kiali validations are based on the runtime status of your service mesh, Galley validations are static ones and doesn't take into account what is configured in the mesh.

Check the complete link:/documentation/validations/[list of validations] for further information.
Check the complete link:/documentation/edge/validations/[list of validations] for further information.

=== Istio Wizards
Kiali provides different actions to create, update and delete Istio configuration driven by wizards. These are located in the *Actions* menu on the Service Details page.
Expand Down Expand Up @@ -284,7 +284,7 @@ The following article https://medium.com/kialiproject/kiali-observability-in-act
== Multi-cluster support
Istio provides https://istio.io/docs/setup/install/multicluster/[installation instructions] for three different multi-cluster scenarios: replicated control planes, shared control plane with single-network, and shared control plane with multi-network.

Currently, Kiali only works with Istio's replicated control planes scenario. You will need to install Kiali aside each Istio's control plane; i.e. you will need one Kiali instance per Istio's control plane you want to monitor. Install instructions for Kiali are the same as for the single cluster scenario, so following the link:/documentation/getting-started/[Getting started guide] is enough. Kiali will let you observe the mesh portion that is managed by the adjacent control plane.
Currently, Kiali only works with Istio's replicated control planes scenario. You will need to install Kiali aside each Istio's control plane; i.e. you will need one Kiali instance per Istio's control plane you want to monitor. Install instructions for Kiali are the same as for the single cluster scenario, so following the link:/documentation/edge/getting-started/[Getting started guide] is enough. Kiali will let you observe the mesh portion that is managed by the adjacent control plane.

The shared control plane scenarios are currently not supported by Kiali.

Expand Down
1 change: 1 addition & 0 deletions content/documentation/latest
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Kiali comes with default dashboards for several runtimes, including Go, Node.js,
These dashboards are simple Kubernetes resources, so you can use your favorite tool to create, modify or delete them.
As they are defined as plain _yaml_ or _json_ files, it's a perfect fit for keeping under source control like GIT, track changes, share, etc.

Check out the link:/documentation/runtimes-monitoring/[documentation page, window=_blank] to learn more about it.
Check out the link:/documentation/v1.0/runtimes-monitoring/[documentation page, window=_blank] to learn more about it.
++++
<a class="image-popup-fit-height" href="/images/documentation/features/runtimes_monitoring.png" title="Runtimes Dashboards">
<img src="/images/documentation/features/runtimes_monitoring_thumb.png" style="display:block;margin: 0 auto;" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ icon:lightbulb[size=1x]{nbsp}For several commands listed on this page, the OpenS

== Installing Kiali

Kiali can be installed in an OpenShift or Kubernetes cluster environment. For OpenShift only, a minimal preparation is necessary. See link:/documentation/prerequisites[Prerequisites] for environment requirements.
Kiali can be installed in an OpenShift or Kubernetes cluster environment. For OpenShift only, a minimal preparation is necessary. See link:/documentation/v1.0/prerequisites[Prerequisites] for environment requirements.

=== OpenShift Preparation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Kiali comes with default dashboards for several runtimes, including Go, Node.js,
These dashboards are simple Kubernetes resources, so you can use your favorite tool to create, modify or delete them.
As they are defined as plain _yaml_ or _json_ files, it's a perfect fit for keeping under source control like GIT, track changes, share, etc.

Check out the link:/documentation/runtimes-monitoring/[documentation page, window=_blank] to learn more about it.
Check out the link:/documentation/v1.1/runtimes-monitoring/[documentation page, window=_blank] to learn more about it.
++++
<a class="image-popup-fit-height" href="/images/documentation/features/runtimes_monitoring.png" title="Runtimes Dashboards">
<img src="/images/documentation/features/runtimes_monitoring_thumb.png" style="display:block;margin: 0 auto;" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ icon:lightbulb[size=1x]{nbsp}For several commands listed on this page, the OpenS

== Installing Kiali

Kiali can be installed in an OpenShift or Kubernetes cluster environment. For OpenShift only, a minimal preparation is necessary. See link:/documentation/prerequisites[Prerequisites] for environment requirements.
Kiali can be installed in an OpenShift or Kubernetes cluster environment. For OpenShift only, a minimal preparation is necessary. See link:/documentation/v1.1/prerequisites[Prerequisites] for environment requirements.

=== OpenShift Preparation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Kiali comes with default dashboards for several runtimes, including Go, Node.js,
These dashboards are simple Kubernetes resources, so you can use your favorite tool to create, modify or delete them.
As they are defined as plain YAML or JSON files, so it's easy to keep them in source control like Git, track their changes, and share them.

Check out the link:/documentation/runtimes-monitoring/[documentation page, window=_blank] to learn more about it.
Check out the link:/documentation/v1.10/runtimes-monitoring/[documentation page, window=_blank] to learn more about it.
++++
<a class="image-popup-fit-height" href="/images/documentation/features/runtimes_monitoring.png" title="Runtimes Dashboards">
<img src="/images/documentation/features/runtimes_monitoring_thumb.png" style="display:block;margin: 0 auto;" />
Expand Down Expand Up @@ -222,7 +222,7 @@ Kiali performs a set of validations to the most common Istio Objects such as Des

Galley validations are mostly syntactic validations based on the object syntax analysis of Istio objects while Kiali validations are mostly semantic validations between different Istio objects. Kiali validations are based on the runtime status of your service mesh, Galley validations are static ones and doesn't take into account what is configured in the mesh.

Check the complete link:/documentation/validations/[list of validations] for further information.
Check the complete link:/documentation/v1.10/validations/[list of validations] for further information.

=== Istio Wizards
Kiali provides different actions to create, update and delete Istio configuration driven by wizards. These are located in the *Actions* menu on the Service Details page.
Expand Down Expand Up @@ -287,7 +287,7 @@ The following article https://medium.com/kialiproject/kiali-observability-in-act
== Multi-cluster support
Istio provides https://istio.io/docs/setup/install/multicluster/[installation instructions] for three different multi-cluster scenarios: replicated control planes, shared control plane with single-network, and shared control plane with multi-network.

Currently, Kiali only works with Istio's replicated control planes scenario. You will need to install Kiali aside each Istio's control plane; i.e. you will need one Kiali instance per Istio's control plane you want to monitor. Install instructions for Kiali are the same as for the single cluster scenario, so following the link:/documentation/getting-started/[Getting started guide] is enough. Kiali will let you observe the mesh portion that is managed by the adjacent control plane.
Currently, Kiali only works with Istio's replicated control planes scenario. You will need to install Kiali aside each Istio's control plane; i.e. you will need one Kiali instance per Istio's control plane you want to monitor. Install instructions for Kiali are the same as for the single cluster scenario, so following the link:/documentation/v1.10/getting-started/[Getting started guide] is enough. Kiali will let you observe the mesh portion that is managed by the adjacent control plane.

The shared control plane scenarios are currently not supported by Kiali.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Kiali comes with default dashboards for several runtimes, including Go, Node.js,
These dashboards are simple Kubernetes resources, so you can use your favorite tool to create, modify or delete them.
As they are defined as plain YAML or JSON files, so it's easy to keep them in source control like Git, track their changes, and share them.

Check out the link:/documentation/runtimes-monitoring/[documentation page, window=_blank] to learn more about it.
Check out the link:/documentation/v1.11/runtimes-monitoring/[documentation page, window=_blank] to learn more about it.
++++
<a class="image-popup-fit-height" href="/images/documentation/features/runtimes_monitoring.png" title="Runtimes Dashboards">
<img src="/images/documentation/features/runtimes_monitoring_thumb.png" style="display:block;margin: 0 auto;" />
Expand Down Expand Up @@ -222,7 +222,7 @@ Kiali performs a set of validations to the most common Istio Objects such as Des

Galley validations are mostly syntactic validations based on the object syntax analysis of Istio objects while Kiali validations are mostly semantic validations between different Istio objects. Kiali validations are based on the runtime status of your service mesh, Galley validations are static ones and doesn't take into account what is configured in the mesh.

Check the complete link:/documentation/validations/[list of validations] for further information.
Check the complete link:/documentation/v1.11/validations/[list of validations] for further information.

=== Istio Wizards
Kiali provides different actions to create, update and delete Istio configuration driven by wizards. These are located in the *Actions* menu on the Service Details page.
Expand Down Expand Up @@ -287,7 +287,7 @@ The following article https://medium.com/kialiproject/kiali-observability-in-act
== Multi-cluster support
Istio provides https://istio.io/docs/setup/install/multicluster/[installation instructions] for three different multi-cluster scenarios: replicated control planes, shared control plane with single-network, and shared control plane with multi-network.

Currently, Kiali only works with Istio's replicated control planes scenario. You will need to install Kiali aside each Istio's control plane; i.e. you will need one Kiali instance per Istio's control plane you want to monitor. Install instructions for Kiali are the same as for the single cluster scenario, so following the link:/documentation/getting-started/[Getting started guide] is enough. Kiali will let you observe the mesh portion that is managed by the adjacent control plane.
Currently, Kiali only works with Istio's replicated control planes scenario. You will need to install Kiali aside each Istio's control plane; i.e. you will need one Kiali instance per Istio's control plane you want to monitor. Install instructions for Kiali are the same as for the single cluster scenario, so following the link:/documentation/v1.11/getting-started/[Getting started guide] is enough. Kiali will let you observe the mesh portion that is managed by the adjacent control plane.

The shared control plane scenarios are currently not supported by Kiali.

Expand Down
Loading