Skip to content

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

Closed
@docs-bot

Description

@docs-bot

Is this issue for a product update or release that is not yet available to customers?

No? Then please continue. Thank you!

What article(s) is affected?

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

Bug in docs-internal

{%- 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.

Describe the desired docs changes and the problem they solve for customers.

Check whether GHEC users are seeing the correct content where {%- is used.

Who does this affect?

Anyone looking at the GHEC docs

What is the impact to users?

Users will be confused if they're shown the wrong content. Without doing an audit, it's difficult to know what the actual impact is.

Are you willing to open a PR to make this fix? If not, do you know anyone (Hubber or not, we're open source!) who's willing to help write this documentation?

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedAnyone is welcome to open a pull request to fix this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions