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.

Sign up for GitHub

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

Jump to bottom

Switch to reference style links #680

Merged
merged 6 commits into from
Sep 7, 2022
Merged

Switch to reference style links #680

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f472dc7
Switch to reference style links
wolf99 Apr 24, 2022
a1921d5
Remove Host Provider doc front matter
wolf99 Aug 27, 2022
eac1057
Convert prose ref links to snake-case
wolf99 Aug 27, 2022
56685b6
Fix azrepos link
wolf99 Aug 27, 2022
e727f49
Switch to ref style links
wolf99 Aug 27, 2022
a2c4b85
Add review suggestions
wolf99 Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ helpers on Windows.

### Cross-platform UI

We hope to be able to migrate the WPF/Windows only helpers to [Avalonia][]
We hope to be able to migrate the WPF/Windows only helpers to [Avalonia][avalonia]
in order to gain cross-platform graphical user interface support. See
[GCM issue 136][issue-136] for up-to-date progress on this effort.

Expand Down Expand Up @@ -161,7 +161,7 @@ The `Get|Store|EraseCommand`s consult the host provider registry for the most
appropriate host provider. The default registry implementation select the a host
provider by asking each registered provider in turn if they understand the
request. The provider selection can be overridden by the user via the
[`credential.provider`][] or [`GCM_PROVIDER`][]
[`credential.provider`][credential-provider] or [`GCM_PROVIDER`][gcm-provider]
configuration and environment variable respectively (3).

The `Get|Store|EraseCommand`s call the corresponding
Expand Down Expand Up @@ -279,8 +279,8 @@ to the trace object in most places of GCM.

[avalonia]: https://avaloniaui.net/
[core-program]: ../src/shared/Git-Credential-Manager/Program.cs
[`credential.provider`]: configuration.md#credentialprovider
[credential-provider]: configuration.md#credentialprovider
[issue-113]: https://github.com/GitCredentialManager/git-credential-manager/issues/113
[issue-136]: https://github.com/GitCredentialManager/git-credential-manager/issues/136
[`GCM_PROVIDER`]: environment.md#GCM_PROVIDER
[gcm-provider]: environment.md#GCM_PROVIDER
[msal]: https://github.com/AzureAD/microsoft-authentication-library-for-dotnet
18 changes: 9 additions & 9 deletions docs/autodetect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ received by Git. To avoid this network call, please [explicitly configure][expli
the host provider for your self-hosted instance.

After a successful detection of the host provider, GCM will automatically set
the [`credential.provider`][] configuration entry
the [`credential.provider`][credential-provider] configuration entry
for that remote to avoid needing to perform this expensive network call in
future requests.

### Timeout

You can control how long GCM will wait for a response to the remote network call
by setting the [`GCM_AUTODETECT_TIMEOUT`][]
environment variable, or the [`credential.autoDetectTimeout`][]
by setting the [`GCM_AUTODETECT_TIMEOUT`][gcm-autodetect-timeout]
environment variable, or the [`credential.autoDetectTimeout`][credential-autoDetectTimeout]
Git configuration setting to the maximum number of milliseconds to wait.

The default value is 2000 milliseconds (2 seconds). You can prevent the network
Expand All @@ -52,8 +52,8 @@ If the auto-detection mechanism fails to select the correct host provider, or
if the remote probing network call is causing performance issues, you can
configure GCM to always use a particular host provider, for a given remote URL.

You can either use the the [`GCM_PROVIDER`][]
environment variable, or the [`credential.provider`][]
You can either use the the [`GCM_PROVIDER`][gcm-provider]
environment variable, or the [`credential.provider`][credential-provider]
Git configuration setting for this purpose.

For example to tell GCM to always use the GitHub host provider for the
Expand All @@ -63,8 +63,8 @@ For example to tell GCM to always use the GitHub host provider for the
git config --global credential.ghe.example.com.provider github
```

[`credential.autoDetectTimeout`]: configuration.md#credentialautodetecttimeout
[`credential.provider`]: configuration.md#credentialprovider
[credential-autoDetectTimeout]: configuration.md#credentialautodetecttimeout
[credential-provider]: configuration.md#credentialprovider
[explicit-config]: #manual-configuration
[`GCM_AUTODETECT_TIMEOUT`]: environment.md#GCM_AUTODETECT_TIMEOUT
[`GCM_PROVIDER`]: environment.md#GCM_PROVIDER
[gcm-autodetect-timeout]: environment.md#GCM_AUTODETECT_TIMEOUT
[gcm-provider]: environment.md#GCM_PROVIDER
8 changes: 4 additions & 4 deletions docs/azrepos-users-and-tokens.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ The Azure Repos host provider supports creating multiple types of credential:
- Microsoft identity OAuth tokens

To select which type of credential the Azure Repos host provider will create
and use, you can set the [`credential.azreposCredentialType`][]
configuration entry (or [`GCM_AZREPOS_CREDENTIALTYPE`][]
and use, you can set the [`credential.azreposCredentialType`][credential-azreposCredentialType]
configuration entry (or [`GCM_AZREPOS_CREDENTIALTYPE`][gcm-azrepos-credential-type]
environment variable).

### Azure DevOps personal access tokens
Expand Down Expand Up @@ -219,7 +219,7 @@ fabrikam:
```

[azure-devops-pats]: https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page
[`credential.azreposCredentialType`]: configuration.md#credentialazreposcredentialtype
[`GCM_AZREPOS_CREDENTIALTYPE`]: environment.md#GCM_AZREPOS_CREDENTIALTYPE
[credential-azreposCredentialType]: configuration.md#credentialazreposcredentialtype
[gcm-azrepos-credential-type]: environment.md#GCM_AZREPOS_CREDENTIALTYPE
[azure-devops-api]: https://docs.microsoft.com/en-gb/rest/api/azure/devops/tokens/pats
[rfc3986-s321]: https://tools.ietf.org/html/rfc3986#section-3.2.1
10 changes: 5 additions & 5 deletions docs/bitbucket-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,26 +65,26 @@ The Access and Refresh Tokens will be stored against the username and the userna

## On-Premise Bitbucket

On-premise Bitbucket, more correctly known as Bitbucket Server or Bitbucket DC, has a number of differences compared to the cloud instance of Bitbucket, [bitbucket.org][].
On-premise Bitbucket, more correctly known as Bitbucket Server or Bitbucket DC, has a number of differences compared to the cloud instance of Bitbucket, [bitbucket.org][bitbucket].

As far as GCMC is concerned the main difference it doesn't support OAuth so only Basic Authentication is available.

It is possible to test with Bitbucket Server by running it locally using the following command from the Atlassian SDK:

❯ atlas-run-standalone --product bitbucket

See the developer documentation for [atlas-run-standalone][].
See the developer documentation for [atlas-run-standalone][atlas-run-standalone].

This will download and run a standalone instance of Bitbucket Server which can be accessed using the credentials `admin`/`admin` at

https://localhost:7990/bitbucket

Atlassian has [documentation][] on how to download and install their SDK.
Atlassian has [documentation][atlassian-sdk] on how to download and install their SDK.

[additional-info]:https://confluence.atlassian.com/display/BITBUCKET/App+passwords
[atlas-run-standalone]: https://developer.atlassian.com/server/framework/atlassian-sdk/atlas-run-standalone/
[bitbucket.org]: https://bitbucket.org
[bitbucket]: https://bitbucket.org
[2fa-impl]: https://confluence.atlassian.com/bitbucket/two-step-verification-777023203.html
[oauth-impl]: https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html
[documentation]: https://developer.atlassian.com/server/framework/atlassian-sdk/
[atlassian-sdk]: https://developer.atlassian.com/server/framework/atlassian-sdk/
[wincred-manager]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa374792(v=vs.85).aspx
Loading