From 1911b52c6be9f950626deb02fa1652cee21beed6 Mon Sep 17 00:00:00 2001
From: James Nord <jnord+github@cloudbees.com>
Date: Thu, 31 Jan 2019 18:26:10 +0000
Subject: [PATCH] Add documentation for the new GitHub useLoginAsId option

---
 Documentation/connectors/github.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/connectors/github.md b/Documentation/connectors/github.md
index 78f7def4..b669e25e 100644
--- a/Documentation/connectors/github.md
+++ b/Documentation/connectors/github.md
@@ -67,6 +67,9 @@ connectors:
     #   - ['acme:site-reliability-engineers'] for 'slug'
     #   - ['acme:Site Reliability Engineers', 'acme:site-reliability-engineers'] for 'both'
     teamNameField: slug
+    # flag which will switch from using the internal GitHub id to the users handle (@mention) as the user id.
+    # It is possible for a user to change their own user name but it is very rare for them to do so
+    useLoginAsId: false
 ```
 
 ## GitHub Enterprise
-- 
GitLab