restructure readme for better ghes ghec visibility#1210
Conversation
There was a problem hiding this comment.
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 or learn 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. |
There was a problem hiding this comment.
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.
tonytrg
force-pushed
the
tonytrg/update-docs
branch
from
fa12d2f to
a81cb61
Compare
omgitsads
left a comment
omgitsads
left a comment
There was a problem hiding this comment.
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.
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.
There was a problem hiding this comment.
i want to clearly seperate it - so its clear these settings are client agnostic.
I will do a later review of the whole readme structure, as we keep getting complaints about settings/questions which are already in the readme docs.
* restructure readme for better ghes ghec visibility * adding readme
3 participants
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.