From c4e5ae79d65f2f64c6048498ab71f5701ce4a5b2 Mon Sep 17 00:00:00 2001 From: thisisobate Date: Tue, 3 Mar 2026 18:16:06 +0000 Subject: [PATCH] chore: fix MDX related errors for vitess and knative analyses Signed-off-by: thisisobate --- analyses/2025/knative/analysis.md | 4 ++-- analyses/2025/vitess/analysis.md | 25 ++++++++++++++----------- 2 files changed, 16 insertions(+), 13 deletions(-) diff --git a/analyses/2025/knative/analysis.md b/analyses/2025/knative/analysis.md index ea6c3b0..106f390 100644 --- a/analyses/2025/knative/analysis.md +++ b/analyses/2025/knative/analysis.md @@ -60,8 +60,8 @@ is stored on the knative/docs GitHub repo. #### Out of scope -- Other Knative repos: https://github.com/knative/\, for any \ not - listed in "In scope". +- Other Knative repos: `https://github.com/knative/REPO_NAME`, for any + `REPO_NAME` not listed in "In scope". ### How this document is organized diff --git a/analyses/2025/vitess/analysis.md b/analyses/2025/vitess/analysis.md index 691e9ca..d721b18 100644 --- a/analyses/2025/vitess/analysis.md +++ b/analyses/2025/vitess/analysis.md @@ -51,15 +51,18 @@ code is stored in its own repository in the Vitess GitHub project. #### In scope -- Website: -- Documentation: -- Website repo: -- Project repo (for reference): +- Website: [https://vitess.io/](https://vitess.io/) +- Documentation: [https://vitess.io/docs/](https://vitess.io/docs/) +- Website repo: + [https://github.com/vitessio/website](https://github.com/vitessio/website) +- Project repo (for reference): + [https://github.com/vitessio](https://github.com/vitessio) #### Out of scope -- Other Vitess repos: (In general, other Vitess - code repos are out of scope) +- Other Vitess repos: + [https://github.com/vitessio/](https://github.com/vitessio/) (In general, + other Vitess code repos are out of scope) ### How this document is organized @@ -482,11 +485,11 @@ Also on the Global TopoServer page, by the way: > --topo_global_root=/vitess/global > ``` > -> To avoid repetition we will use in our examples to signify the +> To avoid repetition we will use `topo_flags` in our examples to signify the > above flags. -Remove this. The `` placeholder does not seem to have been -implemented. There are no mentions of `` elsewhere in the +Remove this. The `topo_flags` placeholder does not seem to have been +implemented. There are no mentions of `topo_flags` elsewhere in the documentation, and in any case each would have to refer back to this page. In the FAQ: Rename the questions into concise headings when you consolidate the @@ -546,8 +549,8 @@ Here's how I'd rewrite it, defining placeholders for the parameters: > > where: > -> - is the root directory of the server installation -> - is the IP address of the topo server +> - `root_dir` is the root directory of the server installation +> - `cell_topo_addr` is the IP address of the topo server (or whatever the actual descriptions of the parameters are.)