add metadata to docs and reorder them

cloudfoundry · Sep 30, 2024 · af178fa · af178fa
1 parent 7475a2f
commit af178fa
Show file tree

Hide file tree

Showing 18 changed files with 88 additions and 102 deletions.
diff --git a/docs/metrics.md → docs/010-metrics.md b/docs/metrics.md → docs/010-metrics.md
@@ -1,3 +1,9 @@
+---
+title: Diego Metrics
+expires_at : never
+tags: [diego-release]
+---
+
 # Diego Metrics
 
 A list of component-level metrics emitted by Diego. Contributors interested in adding new metrics should visit our [contributor doc](contributing.md#Metrics) for a list of code conventions we follow.

diff --git a/docs/container-metrics.md → docs/011-container-metrics.md b/docs/container-metrics.md → docs/011-container-metrics.md
@@ -1,3 +1,9 @@
+---
+title: Container Metrics
+expires_at: never
+tags: [diego-release]
+---
+
 # Container Metrics
 
 A list of container metrics emitted by Diego. Each metric is a separate value in an envelope. Some metrics are separated into different envelopes to ensure Loggregator v1 subscribers can still receive these metrics.

diff --git a/docs/troubleshooting-error-responses.md → docs/020-troubleshooting-error-responses.md b/docs/troubleshooting-error-responses.md → docs/020-troubleshooting-error-responses.md
@@ -1,3 +1,9 @@
+---
+title: Troubleshooting error responses
+expires_at: never
+tags: [diego-release]
+---
+
 # Troubleshooting error responses
 
 ## Components exiting due to Locket Lock Request Failures

diff --git a/docs/cf-push-diego-logs.md → docs/021-cf-push-diego-logs.md b/docs/cf-push-diego-logs.md → docs/021-cf-push-diego-logs.md
@@ -1,3 +1,9 @@
+---
+title: Understanding Diego Logs for Pushing an Application
+expires_at: never
+tags: [diego-release]
+---
+
 # Understanding Diego Logs for Pushing an Application
 
 The goal of this tutorial is to provide a framework to help the reader debug issues encountered by the many components that make up Diego.

diff --git a/docs/logging-format.md → docs/022-logging-format.md b/docs/logging-format.md → docs/022-logging-format.md
@@ -1,3 +1,9 @@
+---
+title: Diego Logging Format 
+expires_at : never
+tags: [diego-release]
+---
+
 # Diego Logging Format
 
 Diego components log using a JSON format provided by the [lager](https://github.com/cloudfoundry/lager) library.

diff --git a/docs/scaling-and-performance-tuning.md → docs/030-scaling-and-performance-tuning.md b/docs/scaling-and-performance-tuning.md → docs/030-scaling-and-performance-tuning.md
@@ -1,3 +1,9 @@
+---
+title: Scaling and Performance Tuning Recommendations
+expires_at : never
+tags: [diego-release]
+---
+
 # Scaling and Performance Tuning Recommendations
 
 This document describes recommendations for performance tuning of the Diego

diff --git a/docs/cfdot-setup.md → docs/040-cfdot-setup.md b/docs/cfdot-setup.md → docs/040-cfdot-setup.md
@@ -1,3 +1,9 @@
+---
+title: Setting up the cfdot CLI tool
+expires_at: never
+tags: [diego-release]
+---
+
 # Setting up the `cfdot` CLI tool
 
 The BOSH release for Diego contains a `cfdot` job template that deploys `cfdot` and `jq` binaries as well as a `setup` script to make them easy to invoke. If you deploy Diego with cf-deployment, `cfdot` is already available on the Diego VMs. To use it:

diff --git a/docs/data-stores.md → docs/050-data-stores.md b/docs/data-stores.md → docs/050-data-stores.md
@@ -1,3 +1,9 @@
+---
+title: Data Stores
+expires_at: never
+tags: [diego-release]
+---
+
 # Data Stores for Diego
 
 This document describes the different types of data store supported by Diego across its different versions.

diff --git a/docs/data-store-encryption.md → docs/051-data-store-encryption.md b/docs/data-store-encryption.md → docs/051-data-store-encryption.md
@@ -1,3 +1,9 @@
+---
+title: Data Store Encryption
+expires_at: never
+tags: [diego-release]
+---
+
 ## Data Store Encryption
 
 Check out the docs on [BBS Data Store Encryption](https://docs.cloudfoundry.org/adminguide/bbs-encryption-keys.html)
diff --git a/docs/envoy-proxy-configuration.md → docs/060-envoy-proxy-configuration.md b/docs/envoy-proxy-configuration.md → docs/060-envoy-proxy-configuration.md
@@ -1,3 +1,9 @@
+---
+title: Envoy Proxy Configuration
+expires_at : never
+tags: [diego-release]
+---
+
 # Envoy Proxy Configuration
 
 This document describes how to enable the per-container [Envoy proxy](https://github.com/envoyproxy/envoy) on Linux Diego cells, how its ports are configured to proxy incoming TCP traffic, and how operators can configure an additional memory allocation for each container to compensate for its memory usage. 

diff --git a/docs/tls-configuration.md → docs/070-tls-configuration.md b/docs/tls-configuration.md → docs/070-tls-configuration.md
@@ -1,3 +1,9 @@
+---
+title: TLS Configuration
+expires_at: never
+tags: [diego-release]
+---
+
 ## <a name="tls-configuration"></a>TLS Configuration
 
 TLS with mutual authentication has to be enabled (as of version 2.0) for

diff --git a/...ating-instance-identity-ca-certificate.md → ...ating-instance-identity-ca-certificate.md b/...ating-instance-identity-ca-certificate.md → ...ating-instance-identity-ca-certificate.md
@@ -1,3 +1,9 @@
+---
+title: Rotating Instance Identity CA Certificates
+expires_at : never
+tags: [diego-release]
+---
+
 # Rotating Instance Identity CA Certificates
 
 Instance identity certificate provides each application with PEM encoded

diff --git a/docs/deployment-constraints.md → docs/080-deployment-constraints.md b/docs/deployment-constraints.md → docs/080-deployment-constraints.md
@@ -1,3 +1,9 @@
+---
+title: Deployment Constraints
+expires_at : never
+tags: [diego-release]
+---
+
 # Deployment Constraints
 
 ## <a name="required-dependencies"></a>Required Dependencies

diff --git a/docs/deprecations.md → docs/081-deprecations.md b/docs/deprecations.md → docs/081-deprecations.md
@@ -1,3 +1,13 @@
+---
+title: Deployment Constraints
+expires_at : 2025-09-30
+tags: [diego-release]
+---
+<!---
+deprecate this doc if it hasn't been updated in 3 years.
+-->
+
+
 # <a name="deprecations"></a>Deprecations
 
 This document lists deprecated properties of the job templates in this BOSH release, metrics for Diego components, and API fields and endpoints.

diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/migrating-from-consul-to-sql-locks.md b/docs/migrating-from-consul-to-sql-locks.md
diff --git a/docs/release-compatibility.md b/docs/release-compatibility.md
diff --git a/docs/required-dependency-versions.md b/docs/required-dependency-versions.md