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 #15730

Closed
docs-bot opened this issue Feb 22, 2022 · 1 comment
Labels
help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@docs-bot
Copy link
Collaborator

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?

@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
Copy link
Contributor

Closing the OP didn't have the content design plan

@ramyaparimi ramyaparimi removed the triage Do not begin working on this issue until triaged by the team label Feb 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

No branches or pull requests

2 participants