Skip to content

Standardise markup for URLs in docs #8404

New issue
New issue
Closed
#10429
Closed
Standardise markup for URLs in docs#8404
#10429
Assignees
jtmcg
Labels
docsenhancementa request to improve CLIhelp wantedContributions welcome
@muzimuzhi

Description

@muzimuzhi
muzimuzhi
opened on Dec 2, 2023

Describe the feature or problem you’d like to solve

Something I realized over the course of this PR is that URLs formatted with < and > are the only variants that get turned into links on the CLI manual website.

Rather than extending this PR further, that might be a great follow up to review that behavior and align it.

Originally posted by @andyfeller in #8342 (comment)

Proposed solution

Another round of checking current manual webpages or markers in code base one by one.

Additional context

From my memory of proposing #8342, the most un-marked case is github.com, which is usually used to denote the HOST.

cli/pkg/cmd/extension/command.go

Lines 303 to 304 in b215d03

The repository argument can be specified in %[1]sOWNER/REPO%[1]s format as well as a full URL.
The URL format is useful when the repository is not hosted on github.com.

cli/pkg/cmd/search/code/code.go

Lines 42 to 44 in b215d03

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
are not yet available via the GitHub API.

cli/pkg/cmd/root/help_topic.go

Lines 45 to 47 in b215d03

%[1]sGH_TOKEN%[1]s, %[1]sGITHUB_TOKEN%[1]s (in order of precedence): an authentication token for github.com
API requests. Setting this avoids being prompted to authenticate and takes precedence over
previously stored credentials.

Metadata

Metadata

Assignees

Labels

docsenhancementa request to improve CLIhelp wantedContributions welcome

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions