Cleanup (#427)

* - update releases to, for now, master and pre-v.41 - for consistency and simplicity, migrate from html anchors to markdown image syntax - add some top and bottom margin to img styling so that we can remove a bunch of inline "<br />". - update remaining "</br>" to recommended "<br />" * - Remove remaining .adoc (that somehow was hiding, thanks for finding Edgar) - Update README - disable build-archive.sh with an early exit, we will need to update it * Update README.md Co-authored-by: John Mazzitelli <mazz@redhat.com> * DORP! * Update README.md Co-authored-by: John Mazzitelli <mazz@redhat.com> * pr feedback, edgar: - remove obsolete scripts - jam the Netlify badge onto the page Co-authored-by: John Mazzitelli <mazz@redhat.com>
kiali · Oct 13, 2021 · 5c4806e · 5c4806e
1 parent a111840
commit 5c4806e
Show file tree

Hide file tree

Showing 29 changed files with 222 additions and 841 deletions.
diff --git a/README.adoc b/README.adoc
diff --git a/README.md b/README.md
@@ -0,0 +1,85 @@
+
+# Kiali.io
+
+[![title="Netlify Status"](https://api.netlify.com/api/v1/badges/05b3eed1-6ea2-41a1-8b64-c76bda241be6/deploy-status)](https://app.netlify.com/sites/kiali/deploys)
+
+This repository contains the source code for the [http://kiali.io](http://kiali.io) website.
+
+The website is written using markdown, the [Docsy](https://www.docsy.dev/) theme, and generated using [Hugo](https://gohugo.io). It is hosted on Github and deployed using netlify.
+
+
+## Requirements
+
+To run the website locally, you will need:
+
+* [Podman](https://podman.io) or [Docker](https://docker.io)
+* https://www.gnu.org/software/make/[GNU Make]
+
+Generally `podman` is easier to setup.
+
+
+## Configuring and Running
+
+Hugo has a command to run a small, self-contained web server locally, so you can test the website without having to upload/deploy it anywhere. The server supports live-reload, so changes to the content will reflect into the browser as they happen.
+
+To run the server, you need to run the following on a terminal:
+
+```
+make serve
+```
+
+> :warning: 
+> If you are using Docker, you need to set `DORP` when starting the server; e.g:
+> ```
+> make -e DORP=docker make serve
+> ```
+
+If everything is working as expected, you should see something like this:
+
+```
+                   |  EN
++------------------+------+
+  Pages            | 1353
+  Paginator pages  |    0
+  Non-page files   |    0
+  Static files     |  119
+  Processed images |    0
+  Aliases          |  155
+  Sitemaps         |    1
+  Cleaned          |    0
+
+Total in 15304 ms
+Watching for changes in /site/{content,data,layouts,static,themes}
+Watching for config changes in /site/config.toml
+Environment: "development"
+Serving pages from memory
+Web Server is available at http://localhost:1313/ (bind address 0.0.0.0)
+Press Ctrl+C to stop
+```
+
+The server should be available on [http://localhost:1313](http://localhost:1313). Some files might not be supported for live reload. If, for some reason, you are not seeing your changes appearing you may need to restart the server.
+
+
+## Documentation Versioning
+
+The documentation is versioned using a branch strategy.  The `master` branch holds all new content.  On each Kiali release `master` will be captured in a versioned branch.  This typically happens every three weeks.
+
+The versioning/release script can be found on `scripts/build-archive.sh`.
+
+## Production Deployment
+
+Deployment is done automatically when a pull request is merged, and preview deployments are also done for each PR, so you can verify that your changes will work in production before actually deploying.
+
+## Directory Structure
+
+The directory structure is typical for projects using the [Docsy](https://www.docsy.dev/) theme.  A couple of notes:
+
+* The site only supports English and as such, all content is under `content/en`.
+* The site minimizes customization but custom CSS is found in `assets/scss`.
+* The site keeps consolidates static content under `static`.
+  * e.g. images are under `static\images`
+
+
+## License and Code of Conduct
+
+The kiali.io website, like the other kiali-related projects are licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). It also follows the [Kiali Community Code of Conduct](https://github.com/kiali/kiali/blob/master/CODE_OF_CONDUCT.md).
diff --git a/assets/scss/_content.scss b/assets/scss/_content.scss
@@ -107,6 +107,8 @@
 }
 
 img {
+  margin-bottom: 1rem;
+  margin-top: 1rem;
   margin-left: 5%;
   max-width: 90%;
 }
diff --git a/config.toml b/config.toml
@@ -222,10 +222,6 @@ enable = false
   url = "https://kiali.io"
 
 [[params.versions]]
-  version = "latest"
-  url = "localhost:1313"
-
-[[params.versions]]
-  version = "archive"
-  url = "https://kiali.io"
+  version = "pre-v1.41"
+  url = "https://pre-v1-41.kiali.io"
 
diff --git a/content/en/_index.html b/content/en/_index.html
@@ -68,4 +68,7 @@
   {{< videos >}}
 {{< /blocks/section >}}
 
+<a href="https://www.netlify.com">
+  <img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" align="right" />
+</a>
 
diff --git a/content/en/docs/Architecture/terminology/_index.adoc b/content/en/docs/Architecture/terminology/_index.adoc
diff --git a/content/en/docs/Architecture/terminology/_index.md b/content/en/docs/Architecture/terminology/_index.md
@@ -0,0 +1,4 @@
+---
+title: "Terminology"
+weight: 9
+---
diff --git a/content/en/docs/FAQ/general.md b/content/en/docs/FAQ/general.md
@@ -112,7 +112,7 @@ Kiali currently requires the following metrics and attributes (note, this assume
 |istio_tcp_received_bytes_total              |used in metrics displays   |
 |istio_tcp_sent_bytes_total                  |used throughout Kiali and the primary metric for tcp traffic graph generation   |
 
-</br>
+<br />
 
 |Attribute      |Metric                               |Notes|
 |---------------|-------------------------------------|-----|

diff --git a/content/en/docs/FAQ/graph.md b/content/en/docs/FAQ/graph.md
@@ -41,7 +41,6 @@ In some situations you can see a lot of connections from an "Unknown" node to yo
 From the Graph page, you can filter them out by typing `node = unknown` in the _Graph Hide_ input box.
 
 ![Graph Hide](/images/documentation/faq/graph/graph-hide.png)
-</br>
 
 For a more definitive solution, there are several ways to prevent Istio from gathering this kind of telemetry.
 

diff --git a/content/en/docs/Features/configuration.md b/content/en/docs/Features/configuration.md
@@ -10,13 +10,7 @@ Kiali is more than observability, it also helps you to configure, update and val
 The Istio configuration view provides advanced filtering and navigation for Istio configuration objects such as Virtual Services and Gateways.
 Kiali provides inline config edition and powerful semantic validation for Istio resources.
 
-<div style="display: flex;">
- <span style="margin: 0 auto;">
-  <a class="image-popup-fit-height" href="/images/documentation/features/config-list-v1.22.0.png" title="Istio Config List">
-   <img src="/images/documentation/features/config-list-v1.22.0.png" style="width: 1333px;display:inline;margin: 0 auto;" />
-  </a>
- </span>
-</div>
+![Istio Config List](/images/documentation/features/config-list-v1.22.0.png "Istio Config List")
 
 ## Validations
 
@@ -26,15 +20,7 @@ Galley validations are mostly syntactic validations based on the object syntax a
 
 Check the complete [list of validations](#validations) for further information.
 
-
-<div style="display: flex;">
- <span style="margin: 0 auto;">
-  <a class="image-popup-fit-height" href="/images/documentation/features/config-validation-v1.22.0.png" title="Istio Config Validation">
-   <img src="/images/documentation/features/config-validation-v1.22.0.png" style="width: 1333px;display:inline;margin: 0 auto;" />
-  </a>
- </span>
-</div>
-
+![Istio Config Validation](/images/documentation/features/config-validation-v1.22.0.png "Istio Config Validation")
 
 ## Istio Forms
 
@@ -43,81 +29,35 @@ Kiali also offers actions to create Istio Config for Gateways and Security scena
 
 These actions are located under the Istio Config page.
 
-<div style="display: flex;">
- <span style="margin: 0 auto;">
-  <a class="image-popup-fit-height" href="/images/documentation/features/create-istio-config-v1.32.0.png" title="Create Istio Config">
-   <img src="/images/documentation/features/create-istio-config-v1.32.0.png" style="width: 1333px;display:inline;margin: 0 auto;" />
-  </a>
- </span>
-</div>
+![Create Istio Config](/images/documentation/features/create-istio-config-v1.32.0.png "Create Istio Config")
 
 ### Istio Security Forms
 
 Kiali allows creation of Istio AuthorizationPolicy resources:
 
-<div style="display: flex;">
- <span style="margin: 0 auto;">
-  <a class="image-popup-fit-height" href="/images/documentation/features/form-authorization-policy-v1.32.0.png" title="AuthorizationPolicy">
-   <img src="/images/documentation/features/form-authorization-policy-v1.32.0.png" style="width: 1333px;display:inline;margin: 0 auto;" />
-  </a>
- </span>
-</div>
-</br>
+![AuthorizationPolicy](/images/documentation/features/form-authorization-policy-v1.32.0.png "AuthorizationPolicy")
 
 Istio PeerAuthentication resources:
 
-<div style="display: flex;">
-    <span style="margin: 0 auto;">
-      <a class="image-popup-fit-height" href="/images/documentation/features/form-peer-authentication-v1.32.0.png" title="PeerAuthentication">
-          <img src="/images/documentation/features/form-peer-authentication-v1.32.0.png" style="width: 1333px; display:inline;margin: 0 auto;" />
-      </a>
-    </span>
-</div>
-</br>
+![PeerAuthentication](/images/documentation/features/form-peer-authentication-v1.32.0.png "PeerAuthentication")
 
 Istio RequestAuthentication resources:
 
-<div style="display: flex;">
-    <span style="margin: 0 auto;">
-      <a class="image-popup-fit-height" href="/images/documentation/features/form-request-authentication-v1.32.0.png" title="RequestAuthentication">
-          <img src="/images/documentation/features/form-request-authentication-v1.32.0.png" style="width: 1333px; display:inline;margin: 0 auto;" />
-      </a>
-    </span>
-</div>
+![RequestAuthentication](/images/documentation/features/form-request-authentication-v1.32.0.png "RequestAuthentication")
 
 ### Istio Traffic Forms
 
 Kiali uses Istio Wizards to generate Istio Traffic config for a specific Service, but Kiali also allows creation of Gateway, ServiceEntry and Sidecar Istio resources for more generic scenarios.
 
 Istio Gateway resources:
 
-<div style="display: flex;">
-    <span style="margin: 0 auto;">
-      <a class="image-popup-fit-height" href="/images/documentation/features/form-gateway-v1.32.0.png" title="Gateway">
-          <img src="/images/documentation/features/form-gateway-v1.32.0.png" style="width: 1333px; display:inline;margin: 0 auto;" />
-      </a>
-    </span>
-</div>
-</br>
+![Gateway](/images/documentation/features/form-gateway-v1.32.0.png "Gateway")
 
 Istio ServiceEntry resources:
 
-<div style="display: flex;">
-    <span style="margin: 0 auto;">
-      <a class="image-popup-fit-height" href="/images/documentation/features/form-serviceentry-v1.32.0.png" title="ServiceEntry">
-          <img src="/images/documentation/features/form-serviceentry-v1.32.0.png" style="width: 1333px; display:inline;margin: 0 auto;" />
-      </a>
-    </span>
-</div>
-</br>
+![ServiceEntry](/images/documentation/features/form-serviceentry-v1.32.0.png "ServiceEntry")
 
 Istio Sidecar resources:
 
-<div style="display: flex;">
-    <span style="margin: 0 auto;">
-      <a class="image-popup-fit-height" href="/images/documentation/features/form-sidecar-v1.32.0.png" title="Sidecar">
-          <img src="/images/documentation/features/form-sidecar-v1.32.0.png" style="width: 1333px; display:inline;margin: 0 auto;" />
-      </a>
-    </span>
-</div>
+![Sidecar](/images/documentation/features/form-sidecar-v1.32.0.png "Sidecar")