Skip to content

chore: fix MDX related errors for vitess and knative analyses #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nate-double-u merged 1 commit into from
Mar 3, 2026
Merged

chore: fix MDX related errors for vitess and knative analyses #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions analyses/2025/knative/analysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ is stored on the knative/docs GitHub repo.

#### Out of scope

- Other Knative repos: https://github.com/knative/\<repo\>, for any \<repo\> 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

Expand Down
25 changes: 14 additions & 11 deletions analyses/2025/vitess/analysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,18 @@ code is stored in its own repository in the Vitess GitHub project.

#### In scope

- Website: <https://vitess.io/>
- Documentation: <https://vitess.io/docs/>
- Website repo: <https://github.com/vitessio/website>
- Project repo (for reference): <https://github.com/vitessio>
- 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: <https://github.com/vitessio/*> (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

Expand Down Expand Up @@ -482,11 +485,11 @@ Also on the Global TopoServer page, by the way:
> --topo_global_root=/vitess/global
> ```
>
> To avoid repetition we will use <topo_flags> 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 `<topo_flags>` placeholder does not seem to have been
implemented. There are no mentions of `<topo_flags>` 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
Expand Down Expand Up @@ -546,8 +549,8 @@ Here's how I'd rewrite it, defining placeholders for the parameters:
>
> where:
>
> - <root_dir> is the root directory of the server installation
> - <cell_topo_addr> 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.)

Expand Down