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

Update alias setup language to clarify usage #32377

Merged
merged 2 commits into from
Apr 5, 2024
Merged

Conversation

moriartyb
Copy link
Contributor

Why:

Current language makes it seem like you should add the lines provided into your config file rather than run the command once to append the generated alias to your profile for you.

Updated the language to make it clear you should run the command rather than append it.

Users who append by mistake will see things working but would add ~1sec to their powershell launch time, and would end up appending duplicate lines to their config file every time they launch their shell.

Closes:

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.

Current language makes it seem like you should add the lines provided into your config file rather than run the command once to append the generated alias to your profile for you. 

Updated the language to make it clear you should run the command rather than append it.

Users who append by mistake will see things working but would add ~1sec to their powershell launch time, and would end up appending duplicate lines to their config file every time they launch their shell.
Copy link

welcome bot commented Apr 4, 2024

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 Apr 4, 2024
Copy link
Contributor

github-actions bot commented Apr 4, 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
copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli.md fpt
ghec
fpt
ghec

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

@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 copilot Content related to GitHub Copilot and removed triage Do not begin working on this issue until triaged by the team labels Apr 4, 2024
@nguyenalex836
Copy link
Contributor

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

Copy link
Contributor

@subatoi subatoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for spotting this, and raising this fix!

@subatoi subatoi added this pull request to the merge queue Apr 5, 2024
Merged via the queue into github:main with commit b7985d0 Apr 5, 2024
70 checks passed
Copy link
Contributor

github-actions bot commented Apr 5, 2024

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

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 copilot Content related to GitHub Copilot 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.

3 participants