From 560e36b50fa92c53026e5e11eac1595de49adcfe Mon Sep 17 00:00:00 2001 From: Piotr Icikowski Date: Sun, 6 Mar 2022 01:57:48 +0100 Subject: [PATCH] [Docs] Add page titles --- docs/changelog.md | 6 +++++- docs/devplans.md | 4 ++++ docs/examples/advanced.md | 4 ++++ docs/examples/index.md | 4 ++++ docs/examples/simple.md | 4 ++++ docs/index.md | 2 +- docs/installation/docker.md | 4 ++++ docs/installation/executables.md | 4 ++++ docs/installation/index.md | 4 ++++ docs/installation/k8s.md | 4 ++++ docs/usage/config.md | 4 ++++ docs/usage/default.md | 4 ++++ docs/usage/flags.md | 4 ++++ docs/usage/health.md | 4 ++++ docs/usage/index.md | 4 ++++ 15 files changed, 58 insertions(+), 2 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 3f5e2e7..6abedb9 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,7 @@ +--- +title: Changelog +--- + # Project changelog ## GPTS 0.7.2 @@ -7,7 +11,7 @@ - Changed default values of `failureThreshold` and `periodSeconds` of all probes - Added `overrides` section to override name, fullname, image repository, image name & image tag - Added reference for GPTS' documentation for charts' values - - Added metadata to Chart.yaml + - Added metadata to `Chart.yaml` - Added support for configurable configuration endpoint's address - Upgraded project's dependencies - Changed default handler's response structure diff --git a/docs/devplans.md b/docs/devplans.md index 4977546..dd2fea0 100644 --- a/docs/devplans.md +++ b/docs/devplans.md @@ -1,3 +1,7 @@ +--- +title: Development plans +--- + # Development plans | Goal | Importance | diff --git a/docs/examples/advanced.md b/docs/examples/advanced.md index 66b8505..2c1a9d6 100644 --- a/docs/examples/advanced.md +++ b/docs/examples/advanced.md @@ -1,3 +1,7 @@ +--- +title: Advanced usages +--- + # Advanced **GPTS** configuration examples ## HTML page with images diff --git a/docs/examples/index.md b/docs/examples/index.md index 5bbe3da..b6367c9 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -1,3 +1,7 @@ +--- +title: Examples +--- + # Configuration examples for **GPTS** In order to familiarize with **GPTS** declarative configuration and jump-start your adventure with using **GPTS**, please take a look at some examples. diff --git a/docs/examples/simple.md b/docs/examples/simple.md index 52c4994..1ffa7aa 100644 --- a/docs/examples/simple.md +++ b/docs/examples/simple.md @@ -1,3 +1,7 @@ +--- +title: Simple usages +--- + # Simple **GPTS** configuration examples ## Single JSON response on every URI diff --git a/docs/index.md b/docs/index.md index 7048030..389ab04 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,5 @@ --- -title: 'About project' +title: About project --- # **GPTS** / General Purpose Test Service diff --git a/docs/installation/docker.md b/docs/installation/docker.md index debe147..3fdc718 100644 --- a/docs/installation/docker.md +++ b/docs/installation/docker.md @@ -1,3 +1,7 @@ +--- +title: Docker +--- + # Deploying **GPTS** in Docker !!! important "Prerequisites" diff --git a/docs/installation/executables.md b/docs/installation/executables.md index 173d8f4..44cd50f 100644 --- a/docs/installation/executables.md +++ b/docs/installation/executables.md @@ -1,3 +1,7 @@ +--- +title: Executable files +--- + # Running **GPTS** directly from executables ## Using prebuilt binaries diff --git a/docs/installation/index.md b/docs/installation/index.md index 8727ee8..f60429d 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -1,3 +1,7 @@ +--- +title: Installation guide +--- + # Installation guide **GPTS** can be deployed in various environments, therefore multiple deployment methods have been prepared. diff --git a/docs/installation/k8s.md b/docs/installation/k8s.md index 08439fa..5803a75 100644 --- a/docs/installation/k8s.md +++ b/docs/installation/k8s.md @@ -1,3 +1,7 @@ +--- +title: Kubernetes (via Helm) +--- + # Deploying **GPTS** on Kubernetes cluster via Helm !!! important "Prerequisites" diff --git a/docs/usage/config.md b/docs/usage/config.md index 6b797c6..4862ba3 100644 --- a/docs/usage/config.md +++ b/docs/usage/config.md @@ -1,3 +1,7 @@ +--- +title: Configuring endpoints +--- + # Configuring **GPTS** endpoints **GPTS** uses declarative configuration which can be fetched or applied using `/config` endpoint. diff --git a/docs/usage/default.md b/docs/usage/default.md index 3b0c72f..2a8f483 100644 --- a/docs/usage/default.md +++ b/docs/usage/default.md @@ -1,3 +1,7 @@ +--- +title: Default response +--- + # **GPTS**' default response for unconfigured routes If user is attempting to send a request for unconfigured route, the application will respond with a predefined response, which consists of following fields: diff --git a/docs/usage/flags.md b/docs/usage/flags.md index 19bc585..42f2be3 100644 --- a/docs/usage/flags.md +++ b/docs/usage/flags.md @@ -1,3 +1,7 @@ +--- +title: Flags & environment variables +--- + # Controlling **GPTS** setting with CLI flags/environment variables There are four configurable **GPTS** settings which can be controlled using listed flags and/or environment variables: diff --git a/docs/usage/health.md b/docs/usage/health.md index 75cf00d..6caef51 100644 --- a/docs/usage/health.md +++ b/docs/usage/health.md @@ -1,3 +1,7 @@ +--- +title: Liveness & readiness probes +--- + # Accessing **GPTS** liveness & readiness endpoints Liveness and readiness probe are the way that **GPTS** uses to inform other components about its health. Those are primarily used by Kubernetes, but can be also checked manually. diff --git a/docs/usage/index.md b/docs/usage/index.md index 189a544..2a818a2 100644 --- a/docs/usage/index.md +++ b/docs/usage/index.md @@ -1,3 +1,7 @@ +--- +title: User guide +--- + # User guide **GPTS** has relatively simple configuration, which can be controlled using [flags and environment variables](flags.md).