Skip to content

Commit fc8659d

Browse files
committed
docs: separate additional resources from README
In an effort to make our README more concise, move additional resources into a new docs/README.md file.
1 parent 86459c7 commit fc8659d

File tree

2 files changed

+28
-27
lines changed

2 files changed

+28
-27
lines changed

README.md

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,6 @@ fully-supported.
5757
- Fedora/CentOS/RHEL
5858
- Alpine
5959

60-
## Install
61-
62-
See [install.md](install) for installation instructions for your operating
63-
system.
64-
6560
## Supported Git versions
6661

6762
Git Credential Manager tries to be compatible with the broadest set of Git
@@ -99,18 +94,7 @@ See detailed information [here][gcm-http-proxy].
9994

10095
## Additional Resources
10196

102-
- [Frequently asked questions][gcm-faq]
103-
- [Development and debugging][gcm-dev]
104-
- [Command-line usage][gcm-usage]
105-
- [Configuration options][gcm-config]
106-
- [Environment variables][gcm-env]
107-
- [Enterprise configuration][gcm-enterprise-config]
108-
- [Network and HTTP configuration][gcm-net-config]
109-
- [Credential stores][gcm-credstores]
110-
- [Architectural overview][gcm-arch]
111-
- [Host provider specification][gcm-host-provider]
112-
- [Azure Repos OAuth tokens][gcm-azure-tokens]
113-
- [GitLab support][gcm-gitlab]
97+
See the [documentation index][docs-index] for links to additional resources.
11498

11599
## Experimental Features
116100

@@ -134,26 +118,17 @@ When using GitHub logos, please be sure to follow the
134118
[bitbucket]: https://bitbucket.org
135119
[bitbucket-ssh]: https://confluence.atlassian.com/bitbucket/ssh-keys-935365775.html
136120
[build-status-badge]: https://github.com/GitCredentialManager/git-credential-manager/actions/workflows/continuous-integration.yml/badge.svg
121+
[docs-index]: docs/README.md
137122
[dotnet]: https://dotnet.microsoft.com
138123
[gcm]: https://github.com/GitCredentialManager/git-credential-manager
139-
[gcm-arch]: docs/architecture.md
140-
[gcm-azure-tokens]: docs/azrepos-users-and-tokens.md
141124
[gcm-coc]: CODE_OF_CONDUCT.md
142125
[gcm-commit-12294990]: https://github.com/git/git/commit/12294990c90e043862be9eb7eb22c3784b526340
143-
[gcm-config]: docs/configuration.md
144126
[gcm-contributing]: CONTRIBUTING.md
145127
[gcm-credstores]: docs/credstores.md
146-
[gcm-dev]: docs/development.md
147-
[gcm-enterprise-config]: docs/enterprise-config.md
148-
[gcm-env]: docs/environment.md
149-
[gcm-faq]: docs/faq.md
150128
[gcm-for-mac-and-linux]: https://github.com/microsoft/Git-Credential-Manager-for-Mac-and-Linux
151129
[gcm-for-windows]: https://github.com/microsoft/Git-Credential-Manager-for-Windows
152-
[gcm-gitlab]: docs/gitlab.md
153-
[gcm-host-provider]: docs/hostprovider.md
154130
[gcm-http-proxy]: docs/netconfig.md#http-proxy
155131
[gcm-license]: LICENSE
156-
[gcm-net-config]: docs/netconfig.md
157132
[gcm-usage]: docs/usage.md
158133
[gcm-windows-broker]: docs/windows-broker.md
159134
[git-tools-credential-storage]: https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage

docs/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# User documentation
2+
3+
The following are links to GCM user support documentation:
4+
5+
- [Frequently asked questions][gcm-faq]
6+
- [Command-line usage][gcm-usage]
7+
- [Configuration options][gcm-config]
8+
- [Environment variables][gcm-env]
9+
- [Enterprise configuration][gcm-enterprise-config]
10+
- [Network and HTTP configuration][gcm-net-config]
11+
- [Credential stores][gcm-credstores]
12+
- [Host provider specification][gcm-host-provider]
13+
- [Azure Repos OAuth tokens][gcm-azure-tokens]
14+
- [GitLab support][gcm-gitlab]
15+
16+
[gcm-azure-tokens]: azrepos-users-and-tokens.md
17+
[gcm-config]: configuration.md
18+
[gcm-credstores]: credstores.md
19+
[gcm-dev]: development.md
20+
[gcm-enterprise-config]: enterprise-config.md
21+
[gcm-env]: environment.md
22+
[gcm-faq]: faq.md
23+
[gcm-gitlab]: gitlab.md
24+
[gcm-host-provider]: hostprovider.md
25+
[gcm-net-config]: netconfig.md
26+
[gcm-usage]: usage.md

0 commit comments

Comments
 (0)