Skip to content
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.

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

[Improvement]: Audit all {%- versioning to check whether GHEC versioning is correct #15731

Closed
Tracked by #34542
docs-bot opened this issue Feb 22, 2022 · 4 comments
Closed
Tracked by #34542
Labels
content This issue or pull request belongs to the Docs Content team MLH fellowship This issue is reserved for the MLH Fellowship program

Comments

@docs-bot
Copy link
Collaborator

docs-bot commented Feb 22, 2022

This issue is reserved for MLH fellow program

What article(s) is affected?

We have quite a few scripts that we run to modify versioning in the docs. There is a bug which suggested that some of them don't account for versioning of the form: {%- ifversion.

{%- ifversion fpt or ghes > 3.0 or ghae %}
"[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)."
{%- else %}
"[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)."
{% endif %}

It looks as if add-ghec-to-fpt.js failed to add ghec versioning to this condition. This bug means that when users look at the GHEC article they see the wrong link because it's covered by else. They should not see a link to the CodeQL runner docs in the first paragraph here: Configuring code scanning

It may be that this is the only article affected, but we should probably check all instances of {%- versioning to confirm.

Content design plan

To close this issue, please review each line of output below. In each line, you'll see a file path and a line number or range of lines. In that file and at that line number, there will be at least one Liquid conditional that does not include ghec versioning, but should. (Usually this is a line that includes fpt—in most cases a feature or UI element that's visible for Free, Team, and Pro plans is also visible for GitHub Enterprise Cloud.)

content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md:46-61
content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md:47
content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md:83
content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md:80
content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md:32-38  # Check with @felicitymay and/or @stevecat for the conditions for this note... the body currently links to GitHub Enterprise Cloud documentation from the GitHub Enterprise Server and GitHub AE versions, and I can't tell if that's intended
content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md:171
content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md:55
content/rest/reference/permissions-required-for-github-apps.md:43
content/rest/reference/permissions-required-for-github-apps.md:127
content/rest/reference/permissions-required-for-github-apps.md:155
content/rest/reference/permissions-required-for-github-apps.md:159
content/rest/reference/permissions-required-for-github-apps.md:162
content/rest/reference/permissions-required-for-github-apps.md:166
content/rest/reference/permissions-required-for-github-apps.md:169
content/rest/reference/permissions-required-for-github-apps.md:172
content/rest/reference/permissions-required-for-github-apps.md:175
content/rest/reference/permissions-required-for-github-apps.md:178
content/rest/reference/permissions-required-for-github-apps.md:183
content/rest/reference/permissions-required-for-github-apps.md:186
content/rest/reference/permissions-required-for-github-apps.md:189
content/rest/reference/permissions-required-for-github-apps.md:225
content/rest/reference/permissions-required-for-github-apps.md:283
content/rest/reference/permissions-required-for-github-apps.md:286
content/rest/reference/permissions-required-for-github-apps.md:289
content/rest/reference/permissions-required-for-github-apps.md:292
content/rest/reference/permissions-required-for-github-apps.md:295
content/rest/reference/permissions-required-for-github-apps.md:298
content/rest/reference/permissions-required-for-github-apps.md:301
content/rest/reference/permissions-required-for-github-apps.md:304
content/rest/reference/permissions-required-for-github-apps.md:307
content/rest/reference/permissions-required-for-github-apps.md:310
content/rest/reference/permissions-required-for-github-apps.md:313
content/rest/reference/permissions-required-for-github-apps.md:316
content/rest/reference/permissions-required-for-github-apps.md:319
content/rest/reference/permissions-required-for-github-apps.md:322
content/rest/reference/permissions-required-for-github-apps.md:325
content/rest/reference/permissions-required-for-github-apps.md:328
content/rest/reference/permissions-required-for-github-apps.md:331
content/rest/reference/permissions-required-for-github-apps.md:334
content/rest/reference/permissions-required-for-github-apps.md:337
content/rest/reference/permissions-required-for-github-apps.md:340
content/rest/reference/permissions-required-for-github-apps.md:343
content/rest/reference/permissions-required-for-github-apps.md:358
content/rest/reference/permissions-required-for-github-apps.md:373
content/rest/reference/permissions-required-for-github-apps.md:412
content/rest/reference/permissions-required-for-github-apps.md:417
content/rest/reference/permissions-required-for-github-apps.md:444
content/rest/reference/permissions-required-for-github-apps.md:454
content/rest/reference/permissions-required-for-github-apps.md:543
content/rest/reference/permissions-required-for-github-apps.md:565
content/rest/reference/permissions-required-for-github-apps.md:568
content/rest/reference/permissions-required-for-github-apps.md:574
content/rest/reference/permissions-required-for-github-apps.md:578
content/rest/reference/permissions-required-for-github-apps.md:581
content/rest/reference/permissions-required-for-github-apps.md:584
content/rest/reference/permissions-required-for-github-apps.md:587
content/rest/reference/permissions-required-for-github-apps.md:590
content/rest/reference/permissions-required-for-github-apps.md:593
content/rest/reference/permissions-required-for-github-apps.md:628
content/rest/reference/permissions-required-for-github-apps.md:643
content/rest/reference/permissions-required-for-github-apps.md:646
content/rest/reference/permissions-required-for-github-apps.md:649
content/rest/reference/permissions-required-for-github-apps.md:717
content/rest/reference/permissions-required-for-github-apps.md:786
content/rest/reference/permissions-required-for-github-apps.md:910
content/rest/reference/permissions-required-for-github-apps.md:914
content/rest/reference/permissions-required-for-github-apps.md:917
content/rest/reference/permissions-required-for-github-apps.md:921
data/reusables/notifications-v2/custom-notification-types.md:1
@docs-bot docs-bot added the help wanted Anyone is welcome to open a pull request to fix this issue label Feb 22, 2022
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 22, 2022
@ramyaparimi ramyaparimi removed the triage Do not begin working on this issue until triaged by the team label Feb 22, 2022
@Azizciss6

This comment was marked as spam.

@MTGITTI

This comment was marked as spam.

@janiceilene janiceilene added MLH fellowship This issue is reserved for the MLH Fellowship program content This issue or pull request belongs to the Docs Content team and removed help wanted Anyone is welcome to open a pull request to fix this issue labels Mar 17, 2022
@github-project-automation github-project-automation bot moved this to Weeks 4-6 in MLH Fellowship Aug 8, 2024
@Khalilheyrani6367

This comment was marked as spam.

@Kinkyliah

This comment was marked as spam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team MLH fellowship This issue is reserved for the MLH Fellowship program
Projects
Status: Weeks 4-6
Development

No branches or pull requests

10 participants