Skip to content

Correct language tags on five non-YAML code examples - #45907

Open
SurefireStudios wants to merge 1 commit into
github:mainfrom
SurefireStudios:fix-nonyaml-language-tags
Open

SurefireStudios wants to merge 1 commit into
github:mainfrom
SurefireStudios:fix-nonyaml-language-tags

Conversation

@SurefireStudios

Copy link
Copy Markdown
Contributor

Why:

Closes:

No existing issue — found by parsing every fenced yaml block in content/.

Five code blocks in "Remove access to public registries" are tagged yaml copy, but none of them contain YAML. Each is a different package manager's own config format, so the syntax highlighter applies the wrong grammar:

Block Actual format
Yarn "Option 1" (x2) yarn.lock lockfile
Pip "Option 1" pip.conf (INI)
Pipenv "Option 1" Pipfile (TOML)
Poetry "Option 1" pyproject.toml (TOML)

The last two are self-evident from the surrounding prose, which names the file: "Add the private registry URL to the [[source]] section of the Pipfile file" and "Add the private registry url to the [[tool.poetry.source]] section of the pyproject.toml file".

What's being changed (if available, include any code snippets, screenshots, or gifs):

Retagged those five blocks from yaml copy to text copy.

I chose text over toml/ini deliberately: text is already used ~400 times across content/, while toml and ini appear nowhere, so this follows existing house style rather than introducing new tags. Happy to switch to toml for the Pipfile and pyproject.toml blocks if you'd prefer the more precise grammar.

The copy attribute is preserved on every block. The seven genuine dependabot.yml examples in this article are untouched, and I confirmed they all still parse as YAML.

No prose, content, or behavior changes.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Five blocks in "Remove access to public registries" are tagged `yaml copy`
but contain other formats: two yarn.lock excerpts, a pip.conf INI section,
a Pipfile TOML section, and a pyproject.toml TOML section. None parse as
YAML, and each is highlighted with the wrong grammar.

Retagged as `text`, which is already used elsewhere in content/ for
formats without a dedicated tag. The seven genuine dependabot.yml examples
in this article are unchanged.
Copilot AI balanced review requested due to automatic review settings September 15, 2026 15:24

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/remove-access-to-public-registries.md fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18 3.17
fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18 3.17

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Sep 15, 2026
@janiceilene

Copy link
Copy Markdown
Contributor

Thanks for the PR @SurefireStudios! It's helpful when you link to the article you're updating in the OP. It makes it easier to triage 💖 I'll send this over to the team.

@janiceilene janiceilene added driver persona and removed triage Do not begin working on this issue until triaged by the team labels Sep 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants