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

Fix Code security feature descriptions #35327

Closed
wants to merge 4 commits into from

Conversation

akordowski
Copy link
Contributor

Why:

Fix and unify the Code security feature description matching the current descriptions in the GitHub menu.

Closes: #35325

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

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 18, 2024
@akordowski
Copy link
Contributor Author

NOTE: There are still muliple occurrences of the text "code security and analysis" (mostly in the metadata), but I was unsure if to change them accordingly.

Copy link
Contributor

github-actions bot commented Nov 18, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-security-and-analysis-settings-for-your-personal-account.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
admin/configuring-settings/configuring-github-connect/enabling-dependabot-for-your-enterprise.md ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise.md ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/code-scanning/troubleshooting-code-scanning/default-setup-fails-with-a-language.md ghes@ 3.11 3.10
ghes@ 3.11 3.10
code-security/code-scanning/troubleshooting-code-scanning/enabling-default-setup-takes-too-long.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/code-scanning/troubleshooting-code-scanning/results-different-than-expected.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/dependabot/dependabot-auto-triage-rules/using-github-preset-rules-to-prioritize-dependabot-alerts.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12
code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/getting-started/adding-a-security-policy-to-your-repository.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/getting-started/dependabot-quickstart-guide.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/getting-started/quickstart-for-securing-your-organization.md ghes@ 3.14 3.13 3.12 3.11 3.10
ghes@ 3.14 3.13 3.12 3.11 3.10
code-security/getting-started/quickstart-for-securing-your-repository.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/secret-scanning/enabling-secret-scanning-features/enabling-push-protection-for-your-repository.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/secret-scanning/enabling-secret-scanning-features/enabling-secret-scanning-for-your-repository.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/enabling-delegated-bypass-for-push-protection.md [ghec](https://docs-35327-616184.preview.ghdocs.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated...*[Comment body truncated]*

@akordowski akordowski force-pushed the fix-descriptions branch 2 times, most recently from a05c2f0 to 481d068 Compare November 18, 2024 15:40
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team code security Content related to code security and removed triage Do not begin working on this issue until triaged by the team labels Nov 18, 2024
@akordowski akordowski closed this Nov 19, 2024
@akordowski akordowski deleted the fix-descriptions branch November 19, 2024 18:58
@akordowski akordowski restored the fix-descriptions branch November 19, 2024 19:00
@akordowski akordowski reopened this Nov 19, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 19, 2024
@nguyenalex836 nguyenalex836 removed the triage Do not begin working on this issue until triaged by the team label Nov 20, 2024
@subatoi
Copy link
Contributor

subatoi commented Nov 26, 2024

Hi @akordowski 👋 this turned out to be simpler than I initially thought. It transpires that all current GHES versions still use the "Code security and analysis" wording, but Dotcom (FPT and GHEC) versions use the new wording.

With that said, I'd be happy to accept this PR if the conflicts are fixed and versioning is applied appropriately. Before I fixed it myself internally, I wanted to give you that option.

The best way to handle versioning in this case would be to create a feature-based versioning file versioned for fpt and ghec only, so that we have the option to edit it later when it is changed for a future version of GHES. Then, all instances that you've changed here would need to be changed to say {% ifversion <FBV> %} "Code security" {% else %} "Code security and analysis" {% endif %}.

Let me know what you think—if you'd prefer not to do this, just let me know and I'll fix it internally and add you as co-committer.

Many thanks!

@akordowski
Copy link
Contributor Author

akordowski commented Nov 27, 2024

Hi @subatoi 👋

The best way to handle versioning in this case would be to create a feature-based versioning file versioned for fpt and ghec only, so that we have the option to edit it later when it is changed for a future version of GHES.

I am not familiar with the porcess how to do it, so I would leave it up to you.

As there are a lot of occurrences of Code security and analysis and this might be a subject to change, I would also suggest to create a reusable and replace all occurrences with it. That would make future changes even simpler as the change must be done in one file. What do you think?

If the versoning is done I could help you with the replacement. Let me know.

@subatoi
Copy link
Contributor

subatoi commented Nov 27, 2024

No problem @akordowski — I'll handle this internally 👍

As there are a lot of occurrences of Code security and analysis and this might be a subject to change, I would also suggest to create a reusable and replace all occurrences with it. That would make future changes even simpler as the change must be done in one file. What do you think?

We could certainly use a reusable if the language were the same, yes. For the moment, I'll handle the replacement without using a reusable, but we can revisit that idea afterwards (I'll come back to you when it's merged, though it's possible it won't be this week as we're going on a soft freeze for the US Thanksgiving week).

In the meantime I'm afraid we'll have to close this PR, but thank you again for your help! I'm still happy to add you as a co-committer, since this branch will be useful as a starting point for me.

@akordowski
Copy link
Contributor Author

@subatoi

In the meantime I'm afraid we'll have to close this PR.

No problem, if you need any help with the other changes feel free to reach out.

@subatoi subatoi closed this Nov 27, 2024
@akordowski akordowski deleted the fix-descriptions branch November 27, 2024 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code security Content related to code security content This issue or pull request belongs to the Docs Content team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wrong description of the Settings / Security / Code security feature
3 participants