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 installing-the-github-copilot-extension-in-your-environment.md #33955

Merged
merged 3 commits into from
Jul 17, 2024

Conversation

sammyhori
Copy link
Contributor

@sammyhori sammyhori commented Jul 12, 2024

Why:

  • If someone was installing copilot on Neovim, they would reasonably come across the vim section, follow the instructions and then realise, as they scroll down, they did it incorrectly,
  • On the other hand, if someone was installing it on vim, they would be much less likely to read the Neovim part and believe it was for them.

Also, the two sections are very difficult to tell apart when you first come across them, due to the differences in them being minor.

Closes:

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

Switched the Neovim and Vim install instructions around.

To further emphasise the difference between the sections, I put vim and neovim in italics in the subheadings.

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.

Switched the Neovim and Vim install instructions around.

This is as:
- If someone was installing copilot on Neovim, they would reasonably come across the vim section, follow the instructions and then realise, as they scroll down, they did it incorrectly,
- On the other hand, if someone was installing it on vim, they would be much less likely to read the Neovim part and believe it was for them.

To further emphasise the difference between the sections, as they are hard to tell apart, I put vim and neovim in italics in the subheadings.
Copy link

welcome bot commented Jul 12, 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 Jul 12, 2024
Copy link
Contributor

github-actions bot commented Jul 12, 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/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.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 Jul 12, 2024
@nguyenalex836
Copy link
Contributor

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

jules-p
jules-p previously approved these changes Jul 17, 2024
Copy link
Contributor

@jules-p jules-p left a comment

Choose a reason for hiding this comment

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

Hi @sammyhori 👋 thank you for taking the time to contribute to our docs, we really appreciate it. The combination of italics and bold goes against our style guide, so I've removed that, but I'll move forward with the reordering as you suggested. Thank you again ✨

@jules-p jules-p added this pull request to the merge queue Jul 17, 2024
Merged via the queue into github:main with commit bf2b162 Jul 17, 2024
44 checks passed
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

@sammyhori sammyhori deleted the patch-1 branch July 18, 2024 12:24
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.

None yet

3 participants