- Notifications
You must be signed in to change notification settings - Fork2.7k
restructure readme for better ghes ghec visibility#1210
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Conversation
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.
Pull Request Overview
This PR restructures the README by moving the GitHub Enterprise Server and Enterprise Cloud configuration section from the bottom of the document to a more prominent position near the top, improving visibility for enterprise users.
- Moved GHES/GHEC configuration section to appear earlier in the document
- Updated the hostname example for GitHub Enterprise Cloud with data residency to use the correct API endpoint format
- Maintained the same configuration examples and explanations
Tip: Customize your code reviews with copilot-instructions.md.Create the file orlearn how to get started.
README.md Outdated
| the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency. | ||
| - For GitHub Enterprise Server, prefix the hostname with the`https://` URI scheme, as it otherwise defaults to`http://`, which GitHub Enterprise Server does not support. | ||
| - For GitHub Enterprise Cloud with data residency, use`https://copilot-api.YOURSUBDOMAIN.ghe.com` as the hostname. |
CopilotAIOct 13, 2025
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.
The hostname format for GitHub Enterprise Cloud with data residency appears to have been updated to include 'copilot-api.' prefix, but this change should be verified against the official documentation to ensure accuracy.
Copilot uses AI. Check for mistakes.
fa12d2f toa81cb61CompareREADME.md Outdated
| the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency. | ||
| - For GitHub Enterprise Server, prefix the hostname with the`https://` URI scheme, as it otherwise defaults to`http://`, which GitHub Enterprise Server does not support. | ||
| - For GitHub Enterprise Cloud with data residency, use`https://copilot-api.YOURSUBDOMAIN.ghe.com` as the hostname. |
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.
This should not becopilot-api right? justapi.YOURSUBDOMAIN.ghe.com?
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.
Or not evenapi.?
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.
fixed
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.
api is not needed we infer all paths from the url, so we just check for the ghe.com pattern.
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.
Looks good to me, just some thoughts about location
| </details> | ||
| ###GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com) |
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.
Should this be moved under VSCode? The config is specifically for VSCode. Also if we're going to use${input:github_token} perhaps that also needs to be provided in the config, though it's somewhat redundant doing it everywhere.
Uh oh!
There was an error while loading.Please reload this page.
We had multiple complaints that the docs were lacking ghes ghec documentation. This refactor highlights their configuration and fixes a error in the example url.