Repository navigation
Add a list style check, and fix lists to pass it - #2158
Open
marcleblanc2 wants to merge 4 commits into
Open
marcleblanc2 wants to merge 4 commits into
marcleblanc2 wants to merge 4 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Contributor
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| 1. Base64 [encode](https://www.base64encode.org) the ID with a "User:" prefix. For example, for Actor with ID 71 use `User:71`, which encodes to `VXNlcjo3MQ==` | ||
| 1. Navigate to Administration -> API Console and run the query below | ||
| 1. Find the corresponding user by searching the query results for the encoded ID from above | ||
| 2. Base64 [encode](https://www.base64encode.org) the ID with a "User:" prefix. For example, for Actor with ID 71 use `User:71`, which encodes to `VXNlcjo3MQ==` |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/admin/security-event-logs.mdx:122(100% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| 1. Configure the connection to AWS CodeCommit using the action buttons above the text field, and additional fields can be added using `Cmd/Ctrl+Space` for auto-completion. See the [configuration documentation below](#configuration). | ||
| 1. Press **Add repositories**. | ||
| 2. Select **AWS CodeCommit repositories**. | ||
| 3. Configure the connection to AWS CodeCommit using the action buttons above the text field, and additional fields can be added using `Cmd/Ctrl+Space` for auto-completion. See the [configuration documentation below](#configuration). |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/admin/code-hosts/other.mdx:14(72% similar)docs/admin/code-hosts/phabricator.mdx:16(79% similar)docs/admin/code-hosts/gitolite.mdx:17(74% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| 1. Configure the connection to generic Git host the action buttons above the text field, and additional fields can be added using `Cmd/Ctrl+Space` for auto-completion. See the [configuration documentation below](#configuration). | ||
| 1. Press **Add repositories**. | ||
| 2. Select **Generic Git host**. | ||
| 3. Configure the connection to generic Git host the action buttons above the text field, and additional fields can be added using `Cmd/Ctrl+Space` for auto-completion. See the [configuration documentation below](#configuration). |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/admin/code-hosts/aws-codecommit.mdx:14(72% similar)docs/admin/code-hosts/gitolite.mdx:17(69% similar)docs/admin/code-hosts/phabricator.mdx:16(74% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| 1. Configure the connection to Phabricator using the action buttons above the text field, and additional fields can be added using `Cmd/Ctrl+Space` for auto-completion. See the [configuration documentation below](#configuration). | ||
| 1. Press **Add repositories**. | ||
| 2. Select **Phabricator**. | ||
| 3. Configure the connection to Phabricator using the action buttons above the text field, and additional fields can be added using `Cmd/Ctrl+Space` for auto-completion. See the [configuration documentation below](#configuration). |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/admin/code-hosts/aws-codecommit.mdx:14(79% similar)docs/admin/code-hosts/gitolite.mdx:17(76% similar)docs/admin/code-hosts/other.mdx:14(74% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| 1. Press **Add repositories**. | ||
| 2. Go to **Administration > Manage code hosts > Add repositories** | ||
| 3. Select **Gitolite**. | ||
| 4. Configure the connection to Gitolite using the action buttons above the text field, and additional fields can be added using `Cmd/Ctrl+Space` for auto-completion. See the [configuration documentation below](#configuration). |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/admin/code-hosts/aws-codecommit.mdx:14(74% similar)docs/admin/code-hosts/other.mdx:14(69% similar)docs/admin/code-hosts/phabricator.mdx:16(76% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| # - ../../components/utils/migrate-to-nonprivileged # -- Component for migrating from privileged to non-privileged | ||
| # | ||
| ``` | ||
| ``` |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/self-hosted/deploy/kubernetes/upgrade.mdx:100-105(97% similar)docs/self-hosted/deploy/kubernetes/upgrade.mdx:175-179(97% similar)docs/self-hosted/postgresql-collation-version-mismatch-resolution.mdx:207-211(100% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| deploy: sourcegraph | ||
| name: redis-store-conf | ||
| ``` | ||
| ``` |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/self-hosted/how-to/redis-configmap.mdx:134-161(66% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| name: redis-store-conf | ||
|
|
||
| ``` | ||
| ``` |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/self-hosted/how-to/redis-configmap.mdx:68-95(66% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| 1. [Examine the error rates](#check-error-rates) for any anomalies. | ||
| 1. If you know the approximate time the issue occurred or if there is a spike in error rate around a | ||
| 4. [Examine the error rates](#check-error-rates) for any anomalies. | ||
| 5. If you know the approximate time the issue occurred or if there is a spike in error rate around a |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| 2. Are there spikes in latencies or error rate over time? | ||
| 3. Are there spikes in usage or traffic over time that correlate with when the issue is reported. | ||
| 4. Are there spikes in memory usage, CPU, or disk usage over time? | ||
| 5. If you know the approximate time the issue occurred or if there is a suspicious spike in metrics |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/self-hosted/observability/troubleshooting.mdx:89-90(50% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
Contributor
|
This comment has been minimized.
This comment has been minimized.
Contributor
|
marcleblanc2
force-pushed
the
marc/markdownlint-lists
branch
from
November 13, 2026 08:48
eebf3ed to
8388335
Compare
dev/check-markdownlint.mjs runs markdownlint on the docs pages a PR changes and comments the issues the base branch does not have, with a suggested change on each flagged line the PR adds. Like the other checks it is advisory and runs through .github/actions/pr-check. The rules, in .markdownlint-cli2.jsonc at the repository root where markdownlint-cli2 and editor markdownlint extensions find them: - MD004: bullets are dashes - MD007: nested bullets are indented 2 spaces - MD029: ordered lists are numbered 1, 2, 3 - MD030: one space after each list marker, which 2-space nesting needs prettier.config.js sets tabWidth 2 for Markdown and MDX, so Prettier writes the same layout, and VS Code recommends the markdownlint extension. markdownlint-cli2 is installed in the workflow only, like CSpell. The PR check takes the config from the merge commit, like dev/, so branches that predate it are checked with these rules. Generated pages are skipped; they are fixed upstream. Amp-Thread-ID: https://ampcode.com/threads/T-01a1d27a-2c0f-7493-8f9d-280d6e95a2b8 Co-authored-by: Amp <amp@ampcode.com>
Bullets are dashes with one space after the marker, nested lists start at their parent item's text (2 spaces under a bullet, 3 under `1.`), and ordered lists are numbered 1, 2, 3, as markdownlint rules MD004, MD007, MD029, and MD030 and Prettier with tabWidth 2 write them. Numbered lists that restarted after a code block, image, or note not indented under the step before it are joined back into one list, so procedures no longer show readers wrong step numbers. Two pages are fixed by hand: kubernetes/upgrade.mdx had a step inside a note's blockquote, and kustomize.mdx had cloud provider links meant to nest. Each list item's text, code blocks, and nested lists move with its marker. Apart from the joined lists and the kustomize nesting, every page's MDX syntax tree is unchanged, so they render the same. Amp-Thread-ID: https://ampcode.com/threads/T-01a1d27a-2c0f-7493-8f9d-280d6e95a2b8 Co-authored-by: Amp <amp@ampcode.com>
Reindenting the lists touched these lines, so the links check now checks them. Most replacements are the ones in the open draft #1999; the Auth0, EnterpriseDB, GitLab, and JetBrains links got their current URLs. Amp-Thread-ID: https://ampcode.com/threads/T-01a1d27a-2c0f-7493-8f9d-280d6e95a2b8 Co-authored-by: Amp <amp@ampcode.com>
Prettier wrote YAML with the global tabWidth 4; it now uses 2 for YAML, as for Markdown. Every workflow and action is reformatted to match. The changes are whitespace only, and each file parses to the same data. Amp-Thread-ID: https://ampcode.com/threads/T-01a1d27a-2c0f-7493-8f9d-280d6e95a2b8 Co-authored-by: Amp <amp@ampcode.com>
marcleblanc2
force-pushed
the
marc/markdownlint-lists
branch
from
November 13, 2026 08:49
8388335 to
d2889e0
Compare
| 1. Navigate to Administration -> API Console and run the query below | ||
| 1. Find the corresponding user by searching the query results for the encoded ID from above | ||
| 1. Grab the ID from the audit log | ||
| 2. Base64 [encode](https://www.base64encode.org) the ID with a "User:" prefix. For example, for Actor with ID 71 use `User:71`, which encodes to `VXNlcjo3MQ==` |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/admin/audit-log.mdx:221(100% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| - [`excludePersonalRepositories`](/admin/code-hosts/bitbucket-server#configuration) | ||
| - With this enabled, Sourcegraph will exclude any personal repositories from being imported, even if it has access to them. | ||
| - [`repos`](/admin/code-hosts/bitbucket-server#configuration) | ||
| - A list of repositories in `projectKey/repositorySlug` format. The order determines the order in which we sync repository metadata and is safe to change. |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/admin/code-hosts/github.mdx:325(67% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| - [`orgs`](/admin/code-hosts/github#orgs)A list of organizations (every repository belonging to the organization will be cloned). | ||
| - [`repositoryQuery`](/admin/code-hosts/github#repositoryQuery)A list of strings with four pre-defined options (`public`, `internal`, `affiliated`, `none`), and/or a [GitHub advanced search query](https://github.com/search/advanced). | ||
| - [`exclude`](/admin/code-hosts/github#exclude)A list of repositories to exclude which takes precedence over the `repos`, `orgs`, and `repositoryQuery` fields. | ||
| - [`repos`](/admin/code-hosts/github#repos)A list of repositories in `owner/name` format. The order determines the order in which we sync repository metadata and is safe to change. |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/admin/code-hosts/bitbucket-server.mdx:34(67% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| - `gitserver` CPU/memory resource allocations (allocate enough memory to hold your Git packed bare repositories) | ||
| - `sourcegraph-frontend` CPU/memory resource allocations | ||
| - `searcher` CPU/memory resource allocations (allocate enough memory to hold all non-binary files in your repositories) | ||
| - `indexedSearch` CPU/memory resource allocations (for the `zoekt-indexserver` pod, allocate enough memory to hold all non-binary files in your largest repository; for the `zoekt-webserver` pod, allocate enough memory to hold ~2.7x the size of all non-binary files in your repositories) |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/self-hosted/deploy/kubernetes/scale.mdx:39(100% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| - `gitserver` CPU/memory resource allocations (allocate enough memory to hold your Git packed bare repositories) | ||
| - `sourcegraph-frontend` CPU/memory resource allocations | ||
| - `searcher` CPU/memory resource allocations (allocate enough memory to hold all non-binary files in your repositories) | ||
| - `indexedSearch` CPU/memory resource allocations (for the `zoekt-indexserver` pod, allocate enough memory to hold all non-binary files in your largest repository; for the `zoekt-webserver` pod, allocate enough memory to hold ~2.7x the size of all non-binary files in your repositories) |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
docs/admin/how-to/monorepo-issues.mdx:11(100% similar)
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
|
|
||
| **Notes**: | ||
|
|
||
| - Successive invocations of this command will re-attempt the last failed or attempted (but incomplete) migration. This command run as if the `--ignore-single-{dirty,pending}-log` flags supplied by the commands `up`, `upto`, and `downto` were enabled. | ||
| - Successive invocations of this command may _cause_ database drift when partial progress is made. When making a subsequent downgrade attempt, invoke this command with `--skip-drift-check` ignore the failing startup check. | ||
| - Successive invocations of this command will re-attempt the last failed or attempted (but incomplete) migration. This command run as if the `--ignore-single-{dirty,pending}-log` flags supplied by the commands `up`, `upto`, and `downto` were enabled. |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| - Successive invocations of this command may _cause_ database drift when partial progress is made. When making a subsequent upgrade attempt, invoke this command with `--skip-drift-check` ignore the failing startup check. | ||
| - Successive invocations of this command will re-attempt the last failed or attempted (but incomplete) migration. This command run as if the `--ignore-single-{dirty,pending}-log` flags supplied by the commands `up`, `upto`, and `downto` were enabled. | ||
| - This command checks that the schema of the database is in the correct state for the current version, if schema drift is detected it must be resolved before completing the upgrade. [Learn more here.](/self-hosted/updates/migrator/schema-drift). | ||
| - Successive invocations of this command may _cause_ database drift when partial progress is made. When making a subsequent upgrade attempt, invoke this command with `--skip-drift-check` ignore the failing startup check. |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
| - Successive invocations of this command will re-attempt the last failed or attempted (but incomplete) migration. This command run as if the `--ignore-single-{dirty,pending}-log` flags supplied by the commands `up`, `upto`, and `downto` were enabled. | ||
| - Successive invocations of this command may _cause_ database drift when partial progress is made. When making a subsequent downgrade attempt, invoke this command with `--skip-drift-check` ignore the failing startup check. | ||
| - Successive invocations of this command will re-attempt the last failed or attempted (but incomplete) migration. This command run as if the `--ignore-single-{dirty,pending}-log` flags supplied by the commands `up`, `upto`, and `downto` were enabled. | ||
| - Successive invocations of this command may _cause_ database drift when partial progress is made. When making a subsequent downgrade attempt, invoke this command with `--skip-drift-check` ignore the failing startup check. |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
|
|
||
| **Notes**: | ||
|
|
||
| - If `DISABLE_CODE_INSIGHTS` is not set and the `codeinsights-db` is not available, then this command will fail with the default value for the `--db` flag. To resolve, supply `--db=frontend,codeintel` instead. | ||
| - If `DISABLE_CODE_INSIGHTS` is not set and the `codeinsights-db` is not available, then this command will fail with the default value for the `--db` flag. To resolve, supply `--db=frontend,codeintel` instead. |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
|
|
||
| **Notes**: | ||
|
|
||
| - If `DISABLE_CODE_INSIGHTS` is not set and the `codeinsights-db` is not available, then this command will fail with the default value for the `--db` flag. To resolve, supply `--db=frontend,codeintel` instead. | ||
| - If `DISABLE_CODE_INSIGHTS` is not set and the `codeinsights-db` is not available, then this command will fail with the default value for the `--db` flag. To resolve, supply `--db=frontend,codeintel` instead. |
Contributor
There was a problem hiding this comment.
This passage was already duplicated, and is now out of step with:
The passage you changed is also written somewhere else, so the two copies now disagree. Decide which page is the home for it, and replace the other copy with a link; or make the same change there too.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The standard
-1.,2.,3.- item,1. step)MD030 is what makes 2-space nesting work: with
- item, the item's text starts 4 columns in, so a bullet indented 2 spaces is its sibling, not its child.prettier.config.jssetstabWidth: 2for Markdown, MDX, and YAML, so Prettier (and VS Code's format on save) writes the same layout. Prettier 3 already writes one space after a marker, and nests every list at its parent item's text (3 spaces under1.).AGENTS.md already asked for sequential numbering. It now covers all four rules.
The check
.github/workflows/check-markdownlint.ymlrunsdev/check-markdownlint.mjsthrough.github/actions/pr-check, the same way the other checks work:suggestionon each flagged line the PR adds. When a numbered list restarts after a code block or image, the comment says to indent that block under the step instead of suggesting new numbers.markdownlint-cli2is installed in the workflow only, like CSpell, so it is not a site dependency. The rules live in.markdownlint-cli2.jsoncat the repository root, wheremarkdownlint-cli2and editor markdownlint extensions find them, so editors flag the same issues; VS Code now recommends the extension..github/actions/pr-checktakes this file from the merge commit, likedev/, so branches that predate this PR are still checked with these rules.To run it locally:
npm install --global markdownlint-cli2@0.24 markdownlint-cli2 # from the repository root; add --fix to fixThe fixes
Rebased on
mainas four commits:1 2 3 1 2 5in browser search engine shortcuts, and1 2 3 1 2 6 7 8 9 10in Redis ConfigMap. Those blocks are now indented under their step, so each procedure is one list again.markdownlint --fixwould renumber these lists instead, which keeps the wrong numbers.--fixmoves only the marker line and would strand the text under it.1. 1. 1.→1. 2. 3.) and*bullets.kubernetes/upgrade.mdxhad step 2 of the migrator procedure inside a> Noteblockquote;kustomize.mdxhad cloud provider links meant to nest under "You can optionally refer to…";perforce.mdxhad paragraphs indented past their bullet's text; and bullets inside blockquotes.Verification
markdownlint-cli2reports 0 issues acrossdocs/.main's, ignoring positions. 256 pages are identical. In the other 28, the text, code, and images are the same, in the same order; only which list item a block sits in changed, and every ordered list now starts at 1.SCHEMA_SYNCblocks.next dev.Heads-up
Reindenting blocks touches lines that the duplicated content check already flagged. Expect it to list about 29 pre-existing duplicate pairs on this PR; none are new.