Add title and description for each documentation page

traefik · Apr 22, 2022 · 1acf272 · 1acf272
1 parent a479ce2
commit 1acf272
Show file tree

Hide file tree

Showing 19 changed files with 121 additions and 6 deletions.
diff --git a/docs/.markdownlint.json b/docs/.markdownlint.json
@@ -4,6 +4,7 @@
     "MD009": false,
     "MD013": false,
     "MD024": false,
+    "MD025": false,
     "MD026": false,
     "MD033": false,
     "MD034": false,

diff --git a/docs/content/api.md b/docs/content/api.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh API"
+description: "Traefik Mesh includes a built-in API that can be used for debugging purposes. Read the documentation to learn more."
+---
+
 # API
 
 Traefik Mesh includes a built-in API that can be used for debugging purposes.

diff --git a/docs/content/compatibility.md b/docs/content/compatibility.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh Compatibility"
+description: "Traefik Mesh supports, similar to Kubernetes, at least the latest three minor versions of Kubernetes. Read the documentation to learn more."
+---
+
 # Compatibility
 
 Traefik Mesh supports, [similar to Kubernetes](https://kubernetes.io/docs/setup/release/version-skew-policy/#supported-versions), at least the latest three minor versions of Kubernetes, therefore currently:

diff --git a/docs/content/configuration.md b/docs/content/configuration.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh Configuration"
+description: "The configuration for Traefik Mesh is broken down into two parts: the static configuration, and the dynamic configuration. Read the docs to learn more."
+---
+
 # Configuration
 
 The configuration for Traefik Mesh is broken down into two parts: the static configuration, and the dynamic configuration.

diff --git a/docs/content/contributing/building-testing.md b/docs/content/contributing/building-testing.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh Building and Testing"
+description: "This documentation article explains how you can build your own Traefik Mesh binary from the sources."
+---
+
 # Building and Testing
 
 So you want to build your own Traefik Mesh binary from the sources? Let's see how.

diff --git a/docs/content/contributing/documentation.md b/docs/content/contributing/documentation.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh Documentation"
+description: "You've found something unclear in the documentation and want to give a try at explaining it better? Learn how you can do so in this article."
+---
+
 # Documentation
 
 You've found something unclear in the documentation and want to give a try at explaining it better?

diff --git a/docs/content/contributing/maintainers.md b/docs/content/contributing/maintainers.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh Maintainers"
+description: "In this article, you can find the list of Traefik Mesh maintainers."
+---
+
 # Maintainers
 
 - Daniel Tomcej [@dtomcej](https://github.com/dtomcej)

diff --git a/docs/content/contributing/submitting-issues.md b/docs/content/contributing/submitting-issues.md
@@ -1,3 +1,8 @@
+---
+title: "Submitting Issues in Traefik Mesh"
+description: "This documentation article describes the process of sorting and checking issues in Traefik Mesh."
+---
+
 # Submitting Issues
 
 We use the [GitHub issue tracker](https://github.com/traefik/mesh/issues) to keep track of Traefik Mesh issues. 
@@ -22,7 +27,7 @@ Explain in which context you encountered the issue.
 Remain clear and concise.
 
 Take time to polish the format of your message so we'll enjoy reading it and working on it. Help the readers focus on 
-what matters, and help them understand the structure of your message (see the [Github Markdown Syntax](https://help.github.com/articles/github-flavored-markdown)).
+what matters, and help them understand the structure of your message (see the [GitHub Markdown Syntax](https://docs.github.com/en/get-started/writing-on-github)).
 
 ## Feature Request
 

diff --git a/docs/content/contributing/submitting-pull-requests.md b/docs/content/contributing/submitting-pull-requests.md
@@ -1,3 +1,8 @@
+---
+title: "Submitting Pull Requests for Traefik Mesh"
+description: "This documentation article describes the process of submitting a pull request for Traefik Mesh."
+---
+
 # Submitting Pull Requests
 
 So you've decided to improve Traefik Mesh? Thank You! Now the last step is to submit your Pull Request in a way that makes sure 
@@ -20,7 +25,7 @@ a problem that you’re facing.
 Remain clear and concise.
 
 Take time to polish the format of your message so we'll enjoy reading it and working on it. Help the readers focus on 
-what matters, and help them understand the structure of your message (see the [Github Markdown Syntax](https://help.github.com/articles/github-flavored-markdown)).
+what matters, and help them understand the structure of your message (see the [GitHub Markdown Syntax](https://docs.github.com/en/get-started/writing-on-github)).
 
 ## Content
 

diff --git a/docs/content/contributing/thank-you.md b/docs/content/contributing/thank-you.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh Feedback and Contributions"
+description: "Traefik Mesh is an open-source project, your feedback and contributions are needed and always welcome! Read the docs to learn how you can contribute."
+---
+
 # Thank You!
 
 Traefik Mesh is an [open-source project](https://github.com/traefik/mesh/), your feedback and contributions are needed and 

diff --git a/docs/content/examples.md b/docs/content/examples.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh Documentation"
+description: "View some simple and ACL examples for how to deploy Traefik Mesh, a simple and lightweight service mesh, in your cluster. Read the technical documentation."
+---
+
 # Examples
 
 Here are some examples on how to easily deploy Traefik Mesh on your cluster.

diff --git a/docs/content/index.md b/docs/content/index.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh: Simpler Service Mesh"
+description: "Traefik Mesh is a lightweight and simpler service mesh designed from the ground up to be straightforward, easy to install and use. Read the docs to learn more."
+---
+
 # Traefik Mesh: Simpler Service Mesh
 
 <p align="center">

diff --git a/docs/content/install.md b/docs/content/install.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh Installation Documentation"
+description: "There are different ways you can install Traefik Mesh, a simple and lightweight service mesh, in your cluster. Read the technical documentation."
+---
+
 # Installation
 
 To install Traefik Mesh, the installation method is quite simple:

diff --git a/docs/content/migration/helm-chart.md b/docs/content/migration/helm-chart.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Helm Chart Documentation"
+description: "Migrate to the latest version of Traefik Mesh, a simple and lightweight service mesh, in your cluster's Helm chart. Read the technical documentation."
+---
+
 # Migrations
 
 Helm Chart

diff --git a/docs/content/migration/traefik-mesh-v1.md b/docs/content/migration/traefik-mesh-v1.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh Migrations Documentation"
+description: "Traefik Mesh v1.4 introduced a few key changes. Learn what those changes are and what actionable steps must be taken in the technical documentation."
+---
+
 # Minor Migrations
 
 Traefik Mesh v1

diff --git a/docs/content/quickstart.md b/docs/content/quickstart.md
@@ -1,3 +1,8 @@
+---
+title: "Traefik Mesh Documentation"
+description: "Traefik Mesh can be installed in your cluster using the Helm Chart, without affecting any running Services. Read the technical documentation."
+---
+
 # Quickstart
 
 Traefik Mesh can be installed in your cluster without affecting any running services.

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -40,6 +40,7 @@ plugins:
 # https://squidfunk.github.io/mkdocs-material/extensions/admonition/
 # https://facelessuser.github.io/pymdown-extensions/
 markdown_extensions:
+  - meta
   - attr_list
   - admonition
   - footnotes

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,43 @@
+appdirs==1.4.4
+CacheControl==0.12.10
+certifi==2020.12.5
+charset-normalizer==2.0.7
+click==8.1.2
+colorama==0.4.4
+contextlib2==21.6.0
+distlib==0.3.3
+distro==1.6.0
+ghp-import==2.0.2
+html5lib==1.1
+idna==3.3
+importlib-metadata==4.11.3
+Jinja2==3.0.0
+lockfile==0.12.2
+Markdown==3.3.6
+markdown-include==0.5.1
+MarkupSafe==2.1.1
+mergedeep==1.3.4
 mkdocs==1.2.2
-pymdown-extensions==7.0
 mkdocs-bootswatch==1.0
-mkdocs-traefiklabs>=100.0.7
-markdown-include==0.5.1
+mkdocs-material-extensions==1.0.3
+mkdocs-traefiklabs==100.0.10
+msgpack==1.0.2
+ordered-set==4.0.2
+packaging==20.9
+pep517==0.12.0
+progress==1.6
+Pygments==2.11.2
+pymdown-extensions==7.0
+pyparsing==2.4.7
+python-dateutil==2.8.2
+PyYAML==6.0
+pyyaml-env-tag==0.1
+requests==2.26.0
+retrying==1.3.3
+six==1.16.0
+toml==0.10.2
+tomli==1.2.2
+urllib3==1.26.7
+watchdog==2.1.7
+webencodings==0.5.1
+zipp==3.8.0
diff --git a/docs/scripts/verify.sh b/docs/scripts/verify.sh
@@ -21,7 +21,7 @@ find "${PATH_TO_SITE}" -type f -not -path "/app/site/theme/*" \
   --check_external_hash \
   --alt_ignore="/traefik-mesh-logo.svg/" \
   --http_status_ignore="0,500,501,503" \
-  --url_ignore="/fonts.gstatic.com/,/traefik-mesh/,/github.com\/traefik\/mesh\/edit*/,/pilot.traefik.io\/profile/,/traefik.io/,/doc.traefik.io/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/" \
+  --url_ignore="/fonts.gstatic.com/,/traefik-mesh/,/github.com\/traefik\/mesh\/edit*/,/pilot.traefik.io\/profile/,/traefik.io/,/doc.traefik.io/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/,/docs.github.com/" \
   '{}' 1>/dev/null
 ## HTML-proofer options at https://github.com/gjtorikian/html-proofer#configuration