Specify ssh shell is required to enable dependency graph #538
Conversation
Specify that the command should be run within the administrative SSH shell, and link to the relevant document for access.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
| @@ -41,7 +41,7 @@ Before enabling {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data v | |||
| {% endif %} | |||
|
|
|||
| {% data reusables.enterprise_site_admin_settings.sign-in %} | |||
| 1. In the administrative shell, enable the {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.product_location_enterprise %}: | |||
| 1. In the [administrative SSH shell](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh#enabling-access-to-the-administrative-shell-via-ssh), enable the {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.product_location_enterprise %}: | |||
There was a problem hiding this comment.
I realize this is an in-line link which is not preferred, but it felt a bit long as a "For more information on SSH access:" type call out.
There was a problem hiding this comment.
👋 @djdefi Thanks so much for opening a PR! I agree that it'd be too long to use add a For more info into the procedural step, but we avoid inline links to help with localization, accessibility, and ensure users always understand what they're going to click on. What if, instead of using an inline link, you added a note after the shell command on line 47. Something like:
{{#note}}
**Note**: For more information about enabling access to the administrative shell via SSH, see "[Enabling alerts for vulnerable dependencies on GitHub Enterprise Server](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh#enabling-access-to-the-administrative-shell-via-ssh)."
{{/note}}
| @@ -41,7 +41,7 @@ Before enabling {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data v | |||
| {% endif %} | |||
|
|
|||
| {% data reusables.enterprise_site_admin_settings.sign-in %} | |||
| 1. In the administrative shell, enable the {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.product_location_enterprise %}: | |||
| 1. In the [administrative SSH shell](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh#enabling-access-to-the-administrative-shell-via-ssh), enable the {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.product_location_enterprise %}: | |||
There was a problem hiding this comment.
👋 @djdefi Thanks so much for opening a PR! I agree that it'd be too long to use add a For more info into the procedural step, but we avoid inline links to help with localization, accessibility, and ensure users always understand what they're going to click on. What if, instead of using an inline link, you added a note after the shell command on line 47. Something like:
{{#note}}
**Note**: For more information about enabling access to the administrative shell via SSH, see "[Enabling alerts for vulnerable dependencies on GitHub Enterprise Server](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh#enabling-access-to-the-administrative-shell-via-ssh)."
{{/note}}
janiceilene
added
content
...min/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md
Outdated
Show resolved
Hide resolved
…endencies-on-github-enterprise-server.md Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
...min/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md
Outdated
Show resolved
Hide resolved
I should have spotted this in my previous review, so I'm going to go ahead and apply this change.
|
@djdefi - Many thanks for raising this PR and helping to improve GitHub's documentation. 👍 |
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. |
Why:
Adds clarification that the
ghe-dep-graph-enablecommand needs to be run within the administrative SSH shell, and links to the relevant document for SSH access.What's being changed:
Calls out the requirement to run the
ghe-dep-graph-enablecommand via SSH and links to the relevant section for setting up SSH shell accessCheck off the following: