Adjust markdown syntax of analyses pages (#302)

chalin · web-flow · commit 8ae5424b2251 · 2025-03-18T11:24:18.000-04:00
diff --git a/.markdown-link-check.json b/.markdown-link-check.json
@@ -11,6 +11,10 @@
     },
     {
       "pattern": "\\?no-link-check$"
+    },
+    {
+      "why": "Temporary: due to scheduled maintenance",
+      "pattern": "https://www.usenix.org"
     }
   ],
   "timeout": "3s",
diff --git a/analyses/0002-notary-project.md b/analyses/0002-notary-project.md
@@ -199,7 +199,7 @@ Criteria
   - Letting new users know where to get help
 
 - Complete the governance work started here:
-  <https://github.com/notaryproject/specifications/issues/55>
+  https://github.com/notaryproject/specifications/issues/55
   https://github.com/notaryproject/notaryproject/pull/78, and add it to a
   governance page (or section) on the website.
 
diff --git a/analyses/0005-fluxcd.md b/analyses/0005-fluxcd.md
@@ -5,7 +5,7 @@ cSpell:ignore: celestehorgan Horgan
 # Assessment template
 
 Prepared by: Celeste Horgan
-([@celestehorgan](https://github.com/cncf/techdocs))<br> Date: 2021-11-30
+([@celestehorgan](https://github.com/cncf/techdocs))<br/> Date: 2021-11-30
 
 ## Introduction
 
@@ -159,7 +159,7 @@ Scale:
 
 - [This file](https://github.com/fluxcd/website/blob/main/hack/import-flux2-assets.sh)
   is _very_ fragile, as it points to specific files at their
-  <https://github.com/fluxcd/website/blob/main/hack/import-flux2-assets.sh> and
+  https://github.com/fluxcd/website/blob/main/hack/import-flux2-assets.sh and
   seems to have the potential to make the site build succeed but with
   unpredictable results.
   - Consider implementing [Hugo Modules](https://gohugo.io/hugo-modules/) to
diff --git a/analyses/0006-gateway-api.md b/analyses/0006-gateway-api.md
@@ -5,7 +5,7 @@ cSpell:ignore: Meha Bhalodiya mehabhalodiya kubernetes
 # Assessment: Project Kubernetes Gateway API
 
 Prepared by: Meha Bhalodiya
-([@mehabhalodiya](https://github.com/mehabhalodiya))<br> Date: 2021-03-03
+([@mehabhalodiya](https://github.com/mehabhalodiya))<br/> Date: 2021-03-03
 
 ## Introduction
 
diff --git a/analyses/0007-porter.md b/analyses/0007-porter.md
@@ -16,11 +16,11 @@ Date: 2023-04-07
 Resources:
 
 - [Meeting notes](https://docs.google.com/document/d/12OGtSaUtlc7OA_iPnUvmVaiKg8yM7_QBzFnMgoHvnLw?no-link-check)
-- Website: <https://getporter.org>
+- Website: https://getporter.org
 - Repos:
-  - Main site: <https://github.com/getporter/porter>. Content is in `docs`.
+  - Main site: https://github.com/getporter/porter. Content is in `docs`.
   - [Operator site](https://getporter.org/operator):
-    <https://github.com/getporter/operator>
+    https://github.com/getporter/operator
 
 ## Introduction
 
@@ -69,8 +69,8 @@ Scale:
   difference between desired state and operator? maybe the operator one needs to
   be in Get Started)
 
-  - <https://getporter.org/quickstart/desired-state/>
-  - <https://getporter.org/operator/quickstart/>
+  - https://getporter.org/quickstart/desired-state/
+  - https://getporter.org/operator/quickstart/
 
 - Mixins & Plugins sections duplicated in sidebar (and could potentially be
   organized under Concepts?)
@@ -155,7 +155,7 @@ Scale:
 
 - Move the website sourcefile to a separate "website" directory. That way, we
   create a good separation of concern. A good example is
-  <https://github.com/thanos-io/thanos>.
+  https://github.com/thanos-io/thanos.
 - The porter's docs should be searchable.
 - Create a version picker (dropdown) to make search easily discoverable for
   users.
diff --git a/analyses/0008-backstage/README.md b/analyses/0008-backstage/README.md
@@ -1,6 +1,6 @@
 ---
 title: Backstage TechDocs Analysis
-tags: backstage
+tags: [backstage]
 ---
 
 - [Backstage Doc Analysis](backstage-analysis.md) - Analyzes the existing
diff --git a/analyses/0008-backstage/backstage-analysis.md b/analyses/0008-backstage/backstage-analysis.md
@@ -1,6 +1,6 @@
 ---
 title: Backstage Documentation Analysis
-tags: backstage
+tags: [backstage]
 created: 2023-09-01
 modified: 2023-11-28
 author: Dave Welsch (@dwelsch-esi)
diff --git a/analyses/0008-backstage/backstage-implementation.md b/analyses/0008-backstage/backstage-implementation.md
@@ -1,6 +1,6 @@
 ---
 title: Implementing Backstage Doc Improvements
-tags: backstage
+tags: [backstage]
 cSpell:ignore: rigeur runbooks toolkits
 ---
 
diff --git a/analyses/0009-in-toto/in-toto-implementation.md b/analyses/0009-in-toto/in-toto-implementation.md
@@ -89,9 +89,8 @@ following general plan.
    the website, as:
 
    - [System Overview](https://github.com/in-toto/docs/blob/master/in-toto-spec.md#2-system-overview)
-     (compare content to <https://in-toto.io/in-toto> and current website
-     About - create versions of increasing depth to address to specific
-     audiences)
+     (compare content to https://in-toto.io/in-toto and current website About -
+     create versions of increasing depth to address to specific audiences)
    - [Glossary](https://github.com/in-toto/docs/blob/master/in-toto-spec.md#17-terminology)
      (convert to alphabetized table)
    - [Workflow/Personas](https://github.com/in-toto/docs/blob/master/in-toto-spec.md#2-system-overview)
diff --git a/analyses/0010-etcd/README.md b/analyses/0010-etcd/README.md
@@ -1,6 +1,6 @@
 ---
 title: etcd TechDocs Analysis
-tags: etcd
+tags: [etcd]
 ---
 
 - [etcd Doc Analysis](etcd-analysis.md) - Analyzes the existing etcd
diff --git a/analyses/0010-etcd/etcd-analysis.md b/analyses/0010-etcd/etcd-analysis.md
@@ -1,6 +1,6 @@
 ---
 title: etcd Documentation Analysis
-tags: etcd
+tags: [etcd]
 created: 2023-09-01
 modified: 2024-01-08
 author: Dave Welsch (@dwelsch-esi)
diff --git a/analyses/0010-etcd/etcd-implementation.md b/analyses/0010-etcd/etcd-implementation.md
@@ -1,6 +1,6 @@
 ---
 title: Implementing etcd Doc Improvements
-tags: etcd
+tags: [etcd]
 ---
 
 # Introduction
diff --git a/analyses/0011-keda/README.md b/analyses/0011-keda/README.md
@@ -1,6 +1,6 @@
 ---
 title: KEDA TechDocs Analysis
-tags: KEDA
+tags: [KEDA]
 ---
 
 - [KEDA Doc Analysis](keda-analysis.md) - Analyzes the existing KEDA
diff --git a/analyses/0011-keda/keda-analysis.md b/analyses/0011-keda/keda-analysis.md
@@ -48,15 +48,15 @@ Netlify platform. The site's code is stored on the KEDA GitHub repo.
 
 **In scope:**
 
-- Website: <https://keda.sh>
-- Documentation: <https://keda.sh/docs>
-- Website repo: <https://github.com/kedacore/keda-docs>
-- Governance repo: <https://github.com/kedacore/governance>
-- Main project contributor info: <https://github.com/kedacore/keda>
+- Website: https://keda.sh
+- Documentation: https://keda.sh/docs
+- Website repo: https://github.com/kedacore/keda-docs
+- Governance repo: https://github.com/kedacore/governance
+- Main project contributor info: https://github.com/kedacore/keda
 
 **Out of scope:**
 
-- Other KEDA repos under <https://github.com/kedacore/>
+- Other KEDA repos under https://github.com/kedacore/
 
 ## How this document is organized
 
@@ -235,12 +235,12 @@ The documentation includes some examples of
 [**non-inclusive language**](https://inclusivenaming.org/). For example:
 
 - "easily", "simple", "simply", etc.
-  - <https://keda.sh/docs/2.13/deploy/>
-  - <https://keda.sh/docs/2.13/deploy/#uninstall-3>
-  - <https://keda.sh/docs/2.13/concepts/scaling-deployments/#triggers>
+  - https://keda.sh/docs/2.13/deploy/
+  - https://keda.sh/docs/2.13/deploy/#uninstall-3
+  - https://keda.sh/docs/2.13/concepts/scaling-deployments/#triggers
 - "master" node
-  - <https://keda.sh/docs/2.13/troubleshooting/#google-kubernetes-engine-gke>
-  - <https://keda.sh/docs/2.13/scalers/redis-sentinel-lists/#authentication-parameters>
+  - https://keda.sh/docs/2.13/troubleshooting/#google-kubernetes-engine-gke
+  - https://keda.sh/docs/2.13/scalers/redis-sentinel-lists/#authentication-parameters
 
 ## Recommendations
 
diff --git a/analyses/0011-keda/keda-implementation.md b/analyses/0011-keda/keda-implementation.md
@@ -77,7 +77,7 @@ Here is a proposed outline for the tech doc Table of Contents:
 - [Getting Started (New users start here!)](https://keda.sh/docs/2.13/) (rename
   current "KEDA Documentation" heading)
   - [Deploying KEDA](https://keda.sh/docs/2.13/deploy/)
-  - Prerequisites (<https://keda.sh/docs/2.13/operate/cluster/#requirements>)
+  - Prerequisites (https://keda.sh/docs/2.13/operate/cluster/#requirements)
   - [Deploying with Helm](?no-link-check#helm)
     - [Installing](?no-link-check#install)
     - [Uninstalling](?no-link-check#uninstall)
@@ -92,7 +92,7 @@ Here is a proposed outline for the tech doc Table of Contents:
     - [Uninstalling](?no-link-check#uninstall-3)
   - Hello, KEDA (write a procedure for a simplest-possible use case for users to
     get started on - something like
-    <https://github.com/kedacore/sample-hello-world-azure-functions>)
+    https://github.com/kedacore/sample-hello-world-azure-functions)
 - [Using KEDA or Operator Guide](https://keda.sh/docs/2.13/operate/) (rename
   current "Operate")
   - How to set up a scaler (a more detailed procedure than the example used in
@@ -103,13 +103,13 @@ Here is a proposed outline for the tech doc Table of Contents:
     - ... and so on.
   - [Admission Webhooks](https://keda.sh/docs/2.13/operate/admission-webhooks/)
   - Prevention Rules
-    (<https://keda.sh/docs/2.13/concepts/admission-webhooks/#prevention-rules>)
+    (https://keda.sh/docs/2.13/concepts/admission-webhooks/#prevention-rules)
   - Validation Enforcement
   - [Cluster](https://keda.sh/docs/2.13/operate/cluster/) - Except sections that
     are purely reference info, for example:
-  - <https://keda.sh/docs/2.13/operate/cluster/#kubernetes-compatibility>
-  - <https://keda.sh/docs/2.13/operate/cluster/#cluster-capacity>
-  - <https://keda.sh/docs/2.13/operate/cluster/#firewall>
+  - https://keda.sh/docs/2.13/operate/cluster/#kubernetes-compatibility
+  - https://keda.sh/docs/2.13/operate/cluster/#cluster-capacity
+  - https://keda.sh/docs/2.13/operate/cluster/#firewall
   - [Integrating with OpenTelemetry Collector (Experimental)](https://keda.sh/docs/2.13/integrations/opentelemetry/)
   - [Integrating with Prometheus](https://keda.sh/docs/2.13/integrations/prometheus/)
   - [Using the KEDA Metrics Server](https://keda.sh/docs/2.13/operate/metrics-server/)
@@ -119,11 +119,11 @@ Here is a proposed outline for the tech doc Table of Contents:
   - [Migrating to a new release](https://keda.sh/docs/2.13/migration/) (current
     "Migration Guide")
   - Caching Metrics
-    (<https://keda.sh/docs/2.13/concepts/scaling-deployments/#caching-metrics>)
+    (https://keda.sh/docs/2.13/concepts/scaling-deployments/#caching-metrics)
   - Pausing Autoscaling of deployments
-    (<https://keda.sh/docs/2.13/concepts/scaling-deployments/#pause-autoscaling>)
+    (https://keda.sh/docs/2.13/concepts/scaling-deployments/#pause-autoscaling)
   - Pausing Autoscaling of jobs
-    (<https://keda.sh/docs/2.13/concepts/scaling-jobs/#pause-autoscaling>)
+    (https://keda.sh/docs/2.13/concepts/scaling-jobs/#pause-autoscaling)
   - [Troubleshooting](https://keda.sh/docs/2.13/concepts/troubleshooting/),
     `/docs/2.13/troubleshooting/`
 - Reference
@@ -132,9 +132,9 @@ Here is a proposed outline for the tech doc Table of Contents:
     - ...
     - [Secret](https://keda.sh/docs/2.13/authentication-providers/secret/)
   - Scaled Object specification (from "Concepts";
-    <https://keda.sh/docs/2.13/concepts/scaling-deployments/#scaledobject-spec>)
+    https://keda.sh/docs/2.13/concepts/scaling-deployments/#scaledobject-spec)
   - ScaledJob specification
-    (<https://keda.sh/docs/2.13/concepts/scaling-jobs/#scaledjob-spec>)
+    (https://keda.sh/docs/2.13/concepts/scaling-jobs/#scaledjob-spec)
   - [Events](https://keda.sh/docs/2.13/operate/events/)
   - [Firewall requirements](https://keda.sh/docs/2.13/operate/cluster/#firewall)
   - ...
@@ -211,7 +211,7 @@ annotated to illustrate this point:
       - [Uninstalling](?no-link-check#uninstall-3)
   - Hello, KEDA (write a procedure for a simplest-possible use case for users to
     get started on - something like
-    <https://github.com/kedacore/sample-hello-world-azure-functions>) _analogous
+    https://github.com/kedacore/sample-hello-world-azure-functions) _analogous
     to a "Hello World" exercise in programming language or API guides_
 
 # Update the doc content creation instructions
diff --git a/analyses/0011-keda/keda-issues.md b/analyses/0011-keda/keda-issues.md
diff --git a/analyses/0012-TUF/analysis.md b/analyses/0012-TUF/analysis.md
diff --git a/analyses/0012-TUF/issues.md b/analyses/0012-TUF/issues.md
diff --git a/analyses/0013-litmuschaos/litmuschaos-analysis.md b/analyses/0013-litmuschaos/litmuschaos-analysis.md
diff --git a/analyses/0013-litmuschaos/litmuschaos-implementation.md b/analyses/0013-litmuschaos/litmuschaos-implementation.md
diff --git a/analyses/0013-litmuschaos/litmuschaos-issues.md b/analyses/0013-litmuschaos/litmuschaos-issues.md

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,10 @@`
`11`	`11`	`},`
`12`	`12`	`{`
`13`	`13`	`"pattern": "\\?no-link-check$"`
	`14`	`+ },`
	`15`	`+ {`
	`16`	`+ "why": "Temporary: due to scheduled maintenance",`
	`17`	`+ "pattern": "https://www.usenix.org"`
`14`	`18`	`}`
`15`	`19`	`],`
`16`	`20`	`"timeout": "3s",`