-
Notifications
You must be signed in to change notification settings - Fork 60.5k
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
add note for installing the cli extension #30593
Conversation
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. |
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 changesYou 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.
fpt: Free, Pro, Team |
@nquinlan Thanks so much for opening a PR! I'll get this triaged for review ✨ |
content/copilot/github-copilot-in-the-cli/enabling-github-copilot-in-the-cli.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nquinlan - Many thanks for raising this PR.
Adding this will definitely improve this article. Thanks for the idea and proposing the change, using all the correct Markdown. Much appreciated.
I've suggested a slight change. If you agree, please apply the change and we'll get this merged.
Thanks again for contributing to our docs. 🙇
> Because this article is aimed at administrators who will enable Copilot in the CLI for people, rather than the people using it themselves, I think it would be better to talk about "users" rather than "you" here. Co-authored-by: hubwriter <hubwriter@github.com>
Thank you so much! I'm glad it was useful. Committed your suggested update. Excited to (soon) have landed my first change to GitHub Inc docs. 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great. Thanks again.
I'll get this merged/published.
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
While this page is about enabling the CLI extension, as a user it can be confusing to not be able to run
gh copilot
despite it being enabled. Without deeper knowledge of the GitHub CLI and extensions, it's hard to understand that there might be another step to get it working on your machine.What's being changed (if available, include any code snippets, screenshots, or gifs):
I added a
{% note %}
callout to your page on enabling GitHub Copilot CLI to highlight for users that they also need to install a CLI extension.Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.
data
directory.For content changes, I have completed the self-review checklist.
Based on the styleguide, I'm not sure two notes callouts are the right option here. Based on the styleguide, I'd suggest making the note on permissions simply inline, but I'm not the expert on your docs by any means. Please let me know what you'd like and I can update my PR.
Thanks!