From 7690711e8cc8e78b97f65f5e5d185bbeecfbbd7e Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Wed, 4 Jan 2017 20:49:00 +0200 Subject: [PATCH] Tweak docs. * fix a couple of links * use a relative link to LICENSE.txt * simplify a `mailto` link * escape characters in headers; pandoc's auto-id generation had issues with this --- Docs/Configuration.md | 2 +- Docs/CredentialManager.md | 4 ++-- Docs/Development.md | 4 ++-- README.md | 8 ++++---- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Docs/Configuration.md b/Docs/Configuration.md index 1a7eb48..2cb71ef 100644 --- a/Docs/Configuration.md +++ b/Docs/Configuration.md @@ -55,7 +55,7 @@ The value should the URL of the proxy server. Specifies an Azure Active Directory login hint. This is helpful in non-interactive scenarios requiring an authoritative domain apart from visualstudio.com. -Hints are typically of the form: "username@domain" or "domain" without quotes. +Hints are typically of the form: `username@domain` or `domain` without quotes. git config --global credential.microsoft.visualstudio.com.loginhint microsoft.com diff --git a/Docs/CredentialManager.md b/Docs/CredentialManager.md index 7fc4df6..7656ad7 100644 --- a/Docs/CredentialManager.md +++ b/Docs/CredentialManager.md @@ -16,7 +16,7 @@ Assuming the GCM has been installed, using your favorite Windows console (Comman Removes stored credentials for a given URL. Any future attempts to authenticate with the remote will require authentication steps to be completed again. -### deploy _[--path \] [--passive] [--force]_ +### deploy _\[--path \\] \[--passive\] \[--force\]_ Deploys the Git Credential Manager for Windows package and sets Git configuration to use the helper. @@ -36,7 +36,7 @@ Instructs the installer to proceed with deployment even if prerequisites are not When combined with *--passive* all output is eliminated; only the return code can be used to validate success. -### remove _[--path \] [--passive] [--force]_ +### remove _\[--path \\] \[--passive\] \[--force\]_ Removes the Git Credential Manager for Windows package and unsets Git configuration to no longer use the helper. diff --git a/Docs/Development.md b/Docs/Development.md index 49957d4..d1ea581 100644 --- a/Docs/Development.md +++ b/Docs/Development.md @@ -58,7 +58,7 @@ Only Microsoft can sign binaries with the Microsoft certificate. Therefore, whil ## Documents -The documentation is formatted using [markdown](https://daringfireball.net/projects/markdown/syntax) and generated using [Pandoc](http://http://pandoc.org/). +The documentation is formatted using [markdown](https://daringfireball.net/projects/markdown/syntax) and generated using [Pandoc](http://pandoc.org/). ## Logging @@ -86,7 +86,7 @@ Please submit a Contributor License Agreement (CLA) before submitting a pull req ### Code of Conduct -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact with any additional questions or comments. ## License diff --git a/README.md b/README.md index 5bf30d2..8894f1f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Git Credential Manager for Windows [![Build status](https://ci.appveyor.com/api/projects/status/jl6oe1thiwv5s52o/branch/master?svg=true)](https://ci.appveyor.com/project/whoisj/git-credential-manager-for-windows/branch/master) -The [Git Credential Manager for Windows](https://github.com/Microsoft/Git-Credential-Manager-for-Windows) (GCM) provides secure Git credential storage for Windows. It's the successor to the [Windows Credential Store for Git](https://gitcredentialstore.codeplex.com/) (git-credential-winstore), which is no longer maintained. Compared to Git's built-in credential storage for Windows ([wincred](https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage)), which provides single-factor authentication support working on any HTTP enabled Git repository, GCM provides multi-factor authentication support for [Visual Studio Team Services](https://www.visualstudio.com/), [Team Foundation Server](#q-i-thought-microsoft-was-maintaining-this-why-does-the-gcm-not-work-as-expected-with-tfs), and GitHub. +The [Git Credential Manager for Windows](https://github.com/Microsoft/Git-Credential-Manager-for-Windows) (GCM) provides secure Git credential storage for Windows. It's the successor to the [Windows Credential Store for Git](https://gitcredentialstore.codeplex.com/) (git-credential-winstore), which is no longer maintained. Compared to Git's built-in credential storage for Windows ([wincred](https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage)), which provides single-factor authentication support working on any HTTP enabled Git repository, GCM provides multi-factor authentication support for [Visual Studio Team Services](https://www.visualstudio.com/), [Team Foundation Server](Docs/Faq.md#q-i-thought-microsoft-was-maintaining-this-why-does-the-gcm-not-work-as-expected-with-tfs), and GitHub. This project includes: @@ -12,7 +12,7 @@ This project includes: * Kerberos authentication for Team Foundation Server ([see notes](Docs/Faq.md#q-i-thought-microsoft-was-maintaining-this-why-does-the-gcm-not-work-as-expected-with-tfs)) * Optional settings for [build agent optimization](Docs/Automation.md) -### Community +## Community This is a community project so feel free to contribute ideas, submit bugs, fix bugs, or code new features. For detailed information on how the GCM works go to the [wiki](https://github.com/Microsoft/Git-Credential-Manager-for-Windows/wiki/How-the-Git-Credential-Managers-works). @@ -61,8 +61,8 @@ Please submit a Contributor License Agreement (CLA) before submitting a pull req ## Code of Conduct -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact with any additional questions or comments. ## License -This project uses the [MIT License](https://github.com/Microsoft/Git-Credential-Manager-for-Windows/blob/master/LICENSE.txt). +This project uses the [MIT License](LICENSE.txt).