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

add note for installing the cli extension #30593

Merged
merged 4 commits into from
Dec 14, 2023
Merged

Conversation

nquinlan
Copy link
Contributor

@nquinlan nquinlan commented Dec 11, 2023

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.

    • 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.


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!

Copy link

welcome bot commented Dec 11, 2023

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 11, 2023
Copy link
Contributor

github-actions bot commented Dec 11, 2023

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
copilot/github-copilot-in-the-cli/enabling-github-copilot-in-the-cli.md fpt
ghec
fpt
ghec

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@nguyenalex836
Copy link
Contributor

@nquinlan Thanks so much for opening a PR! I'll get this triaged for review ✨

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review github cli Content related to GitHub CLI and removed triage Do not begin working on this issue until triaged by the team labels Dec 12, 2023
Copy link
Contributor

@hubwriter hubwriter left a 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>
@nquinlan
Copy link
Contributor Author

nquinlan commented Dec 13, 2023

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. 😄

@hubwriter hubwriter enabled auto-merge December 14, 2023 12:46
Copy link
Contributor

@hubwriter hubwriter left a 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.

@hubwriter hubwriter added this pull request to the merge queue Dec 14, 2023
Merged via the queue into github:main with commit 7c5c7f1 Dec 14, 2023
Copy link
Contributor

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

CASABECI

This comment was marked as spam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team github cli Content related to GitHub CLI waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants