Ensure hostnames are visible in CLI website
This commit changes <github.com> and <ghe.com> references to `github.com` and `ghe.com` so they are visible on the GitHub CLI marketing website. GitHub Pages will render URLs with a protocol as clickable links, however hostnames are treated as HTML elements and not rendered.
This commit is contained in:
parent
6049cce249
commit
313d20ba83
5 changed files with 10 additions and 10 deletions
|
|
@ -199,15 +199,15 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command
|
|||
[.[].data.viewer.repositories.nodes[]] as $r | count(select($r[].isFork))/count($r[])'
|
||||
`),
|
||||
Annotations: map[string]string{
|
||||
"help:environment": heredoc.Doc(`
|
||||
"help:environment": heredoc.Docf(`
|
||||
GH_TOKEN, GITHUB_TOKEN (in order of precedence): an authentication token for
|
||||
<github.com> API requests.
|
||||
%[1]sgithub.com%[1]s API requests.
|
||||
|
||||
GH_ENTERPRISE_TOKEN, GITHUB_ENTERPRISE_TOKEN (in order of precedence): an
|
||||
authentication token for API requests to GitHub Enterprise.
|
||||
|
||||
GH_HOST: make the request to a GitHub host other than <github.com>.
|
||||
`),
|
||||
GH_HOST: make the request to a GitHub host other than %[1]sgithub.com%[1]s.
|
||||
`, "`"),
|
||||
},
|
||||
Args: cobra.ExactArgs(1),
|
||||
PreRun: func(c *cobra.Command, args []string) {
|
||||
|
|
|
|||
|
|
@ -300,7 +300,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command {
|
|||
|
||||
For GitHub repositories, the repository argument can be specified in
|
||||
%[1]sOWNER/REPO%[1]s format or as a full repository URL.
|
||||
The URL format is useful when the repository is not hosted on <github.com>.
|
||||
The URL format is useful when the repository is not hosted on %[1]sgithub.com%[1]s.
|
||||
|
||||
For remote repositories, the GitHub CLI first looks for the release artifacts assuming
|
||||
that it's a binary extension i.e. prebuilt binaries provided as part of the release.
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ func NewCmdRename(f *cmdutil.Factory, runf func(*RenameOptions) error) *cobra.Co
|
|||
with %[1]s--repo%[1]s is renamed.
|
||||
|
||||
To transfer repository ownership to another user account or organization,
|
||||
you must follow additional steps on <github.com>.
|
||||
you must follow additional steps on %[1]sgithub.com%[1]s.
|
||||
|
||||
For more information on transferring repository ownership, see:
|
||||
<https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository>
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ var HelpTopics = []helpTopic{
|
|||
short: "Environment variables that can be used with gh",
|
||||
long: heredoc.Docf(`
|
||||
%[1]sGH_TOKEN%[1]s, %[1]sGITHUB_TOKEN%[1]s (in order of precedence): an authentication token that will be used when
|
||||
a command targets either <github.com> or a subdomain of <ghe.com>. Setting this avoids being prompted to
|
||||
a command targets either %[1]sgithub.com%[1]s or a subdomain of %[1]sghe.com%[1]s. Setting this avoids being prompted to
|
||||
authenticate and takes precedence over previously stored credentials.
|
||||
|
||||
%[1]sGH_ENTERPRISE_TOKEN%[1]s, %[1]sGITHUB_ENTERPRISE_TOKEN%[1]s (in order of precedence): an authentication
|
||||
|
|
|
|||
|
|
@ -33,16 +33,16 @@ func NewCmdCode(f *cmdutil.Factory, runF func(*CodeOptions) error) *cobra.Comman
|
|||
cmd := &cobra.Command{
|
||||
Use: "code <query>",
|
||||
Short: "Search within code",
|
||||
Long: heredoc.Doc(`
|
||||
Long: heredoc.Docf(`
|
||||
Search within code in GitHub repositories.
|
||||
|
||||
The search syntax is documented at:
|
||||
<https://docs.github.com/search-github/searching-on-github/searching-code>
|
||||
|
||||
Note that these search results are powered by what is now a legacy GitHub code search engine.
|
||||
The results might not match what is seen on <github.com>, and new features like regex search
|
||||
The results might not match what is seen on %[1]sgithub.com%[1]s, and new features like regex search
|
||||
are not yet available via the GitHub API.
|
||||
`),
|
||||
`, "`"),
|
||||
Example: heredoc.Doc(`
|
||||
# Search code matching "react" and "lifecycle"
|
||||
$ gh search code react lifecycle
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue