Skip to content

Commit 92852e5

Browse files
committed
remove, redirect faq-github-authentication
1 parent d7e39ba commit 92852e5

File tree

10 files changed

+45
-71
lines changed

10 files changed

+45
-71
lines changed

.openpublishing.redirection.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -451,8 +451,12 @@
451451
"redirect_url": "/azure/devops/organizations/accounts/faq-user-and-permissions-management"
452452
},
453453
{
454-
"source_path": "docs/organizations/organizations/security/remove-users-prohibit-access.md",
454+
"source_path": "docs/organizations/security/remove-users-prohibit-access.md",
455455
"redirect_url": "/azure/active-directory/add-users-azure-active-directory#delete-a-user"
456+
},
457+
{
458+
"source_path": "docs/organizations/security/faq-github-authentication.yml",
459+
"redirect_url": "/azure/boards/github/connect-to-github#faqs"
456460
}
457461
]
458462
}

docs/boards/get-started/sign-up-invite-teammates.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,7 @@ If you have a GitHub account, follow these steps to sign up for Azure Boards.
190190
191191
![Authorize Microsoft](../../media/authorize-Microsoft-corp.png)
192192
193-
For more information about GitHub authentication, see [FAQs](../../organizations/security/faq-github-authentication.yml).
194-
195-
1. Choose **Continue**.
193+
2. Choose **Continue**.
196194
197195
![Choose Continue to sign up for Azure DevOps](../../media/sign-up-azure-devops.png)
198196
@@ -204,7 +202,7 @@ If you have a GitHub account, follow these steps to sign up for Azure Boards.
204202
205203
You can change the organization name as indicated in [Change organization or project settings](#change-settings) later in this article.
206204
207-
1. To complete your sign-up process, go to [create a project](#create-project).
205+
3. To complete your sign-up process, go to [create a project](#create-project).
208206
209207
<a id="create-project"></a>
210208

docs/boards/github/connect-to-github.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Connect an Azure Boards or Azure DevOps project to a GitHub repository
33
titleSuffix: Azure Boards
4-
description: Configure one or more GitHub repositories to integrate with Azure Boards
4+
description: Configure one or more GitHub repositories to integrate with Azure Boards.
55
ms.service: azure-devops-boards
66
ms.topic: how-to
77
ms.author: chcomley
88
author: chcomley
99
monikerRange: 'azure-devops'
10-
ms.date: 07/03/2023
10+
ms.date: 05/07/2024
1111
---
1212

1313
# Connect Azure Boards to GitHub (cloud)
@@ -76,11 +76,11 @@ You can connect up to 500 GitHub repositories to an Azure Boards project.
7676

7777
2. Choose the GitHub account or organization that you want to connect. Only those organizations that you own or are an administrator for are listed.
7878

79-
If all repositories for an organization have already been connected to Azure Boards, you see the following message.
79+
If all repositories for an organization are already connected to Azure Boards, you see the following message.
8080

8181
:::image type="content" source="media/connect-cloud/message-all-repositories-already-connected.png" alt-text="Screenshot of message where no more repositories exist to connect.":::
8282

83-
3. Enter your GitHub credentials. If you have two-factor authentication enabled, enter the authentication code that GitHub sent you and choose **Verify**. Otherwise, the system automatically recognizes your GitHub organization as your GitHub account has previously been associated with your Azure DevOps Services account.
83+
3. Enter your GitHub credentials. If you have two-factor authentication enabled, enter the authentication code that GitHub sent you and choose **Verify**. Otherwise, the system automatically recognizes your GitHub organization as your GitHub account is associated with your Azure DevOps Services account.
8484

8585
<a id="choose-repositories"></a>
8686

@@ -159,10 +159,10 @@ If you plan to use OAuth to connect Azure DevOps with your GitHub Enterprise Ser
159159

160160
:::image type="content" source="media/github-ent/ghe-settings-dev-oauth.png" alt-text="Screenshot showing sequence for New OAuth App.":::
161161

162-
3. Enter information to register your application.
162+
3. Enter registration information.
163163

164-
For the <strong>Homepage URL</strong>, specify the <strong>Organization URL</strong> of your organization.
165-
For the <strong>Authorization callback URL</strong>, use the following pattern to construct the URL.
164+
For the **Homepage URL**, specify the **Organization URL** of your organization.
165+
For the **Authorization callback URL**, use the following pattern to construct the URL.
166166

167167
`{Azure DevOps Services Organization URL}/_admin/oauth2/callback`
168168

@@ -313,14 +313,14 @@ The following authentication options are supported based on the GitHub platform
313313

314314
#### Grant Azure Boards organization access
315315

316-
If the integration between Azure Boards and GitHub isn't working as expected, verify you've granted organization access.
316+
If the integration between Azure Boards and GitHub isn't working as expected, verify that you granted organization access.
317317

318318
1. From GitHub web portal, open **Settings** from your profile menu.
319319
:::image type="content" source="media/troubleshoot/choose-settings.png" alt-text="Screenshot of open profile, choose Settings.":::
320320

321321
2. Select **Applications** under **Integrations** > **Authorized OAuth Apps** > **Azure Boards**.
322322

323-
3. Under **Organization access**, resolve any issues that may appear. Select **Grant** to grant access to any organizations that show as having an **Access request pending**.
323+
3. Under **Organization access**, resolve any issues that might appear. Select **Grant** to grant access to any organizations that show as having an **Access request pending**.
324324

325325
:::image type="content" source="media/troubleshoot/organization-access-issues.png" alt-text="Screenshot of Organization access with organizations without access.":::
326326

@@ -341,30 +341,30 @@ To resolve this issue, consider the following items:
341341
Delete and recreate the connection to the GitHub repository. This recreated connection causes GitHub to prompt to reauthorize Azure Boards.
342342

343343
- **If the connection is using a PAT:**
344-
- The PAT may have been revoked or the required permission scopes changed and are insufficient.
345-
- The user may have lost admin permissions on the GitHub repo.
344+
- The PAT might be revoked or the required permission scopes changed and are insufficient.
345+
- The user might not have admin permissions on the GitHub repo.
346346

347347
Recreate the PAT and ensure the scope for the token includes the required permissions: `repo, read:user, user:email, admin:repo_hook`.
348348

349349
<a id="ghe-dataimport"></a>
350350

351351
#### Resolve broken GitHub Enterprise Server connection
352352

353-
If you've migrated from Azure DevOps Server to Azure DevOps Services with an existing GitHub Enterprise Server connection, your existing connection won't work as expected. Work item mentions within GitHub may be delayed or never show up in Azure DevOps Services. This problem occurs because the callback url associated with GitHub is no longer valid.
353+
If you migrated from Azure DevOps Server to Azure DevOps Services with an existing GitHub Enterprise Server connection, your existing connection doesn't work as expected. Work item mentions within GitHub might be delayed or never show up in Azure DevOps Services. This problem occurs because the callback URL associated with GitHub is no longer valid.
354354

355355
Consider the following resolutions:
356356

357357
- **Remove and re-create the connection**:
358358
Remove and re-create the connection to the GitHub Enterprise Server repository. Follow the sequence of steps provided in [Connect from Azure Boards](connect-to-github.md#github-ent-oauth-services) documentation.
359359

360-
- **Fix the webhook url**:
361-
Go to GitHub's repository settings page and edit the webhook url to point out to the migrated Azure DevOps Services organization url: ```https://dev.azure.com/{OrganizationName}/_apis/work/events?api-version=5.2-preview```
360+
- **Fix the webhook URL**:
361+
Go to GitHub's repository settings page and edit the webhook URL, pointing to the migrated Azure DevOps organization URL: ```https://dev.azure.com/{OrganizationName}/_apis/work/events?api-version=5.2-preview```
362362

363363
<a id="integrate-repo-to-several-organizations"></a>
364364

365365
#### Connect to multiple Azure DevOps organizations
366366

367-
If you connect your GitHub repository to two or more projects that are defined in more than one Azure DevOps organization, such as dev.azure.com/Contoso and dev.azure.com/Fabrikam, you may get unexpected results when using **AB#** mentions to link to work items. This problem occurs because work item IDs aren't unique across Azure DevOps organizations, so **AB#12** can refer to a work item in either the Contoso or Fabrikam organization. So, when a work item is mentioned in a commit message or pull request, both organizations attempt to create a link to a work item with a matching ID (if one exists).
367+
If you connect your GitHub repository to two or more projects that are defined in more than one Azure DevOps organization, such as dev.azure.com/Contoso and dev.azure.com/Fabrikam, you might get unexpected results when using **AB#** mentions linking to work items. This problem occurs because work item IDs aren't unique across Azure DevOps organizations, so **AB#12** can refer to a work item in either the Contoso or Fabrikam organization. When a work item gets mentioned in a commit message or pull request, both organizations can attempt to create a link to a work item with a matching ID if one exists.
368368

369369
In general, a user intends an **AB#** mention to link to a single work item in one of the projects. But, if a work item of the same ID exists in both accounts, then links get created for both work items, likely causing confusion.
370370

@@ -377,7 +377,7 @@ Currently, there's no way to work around this issue, so we recommend that you co
377377

378378
#### Update XML definitions for select work item types
379379

380-
If your organization uses the Hosted XML or On-premises XML process model to customize the work tracking experience and you want to link to and view the GitHub link types from the Development section in the work item forms, you'll need to update the XML definitions for the work item types.
380+
Update the XML definitions for the work item types, if your organization uses the Hosted XML or on-premises XML process model to customize the work tracking experience and you want to link to and view the GitHub link types from the Development section in the work item forms.
381381

382382
For example, if you want to link user stories and bugs to GitHub commits and pull requests from the **Development** section, you need to update the XML definitions for user stories and bugs.
383383

@@ -389,7 +389,7 @@ Follow the sequence of tasks provided in [Hosted XML process model](../../organi
389389
> <ExternalLinkFilter Type="GitHub Commit" />
390390
> ```
391391
392-
When it's updated, the section should appear as follows.
392+
When updated, the section should appear as follows.
393393
394394
> [!div class="tabbedCodeSnippets"]
395395
> ```XML
@@ -415,6 +415,20 @@ When it's updated, the section should appear as follows.
415415
> </Group>
416416
> ```
417417
418+
<a id="faqs"></a>
419+
420+
## FAQs (Frequently asked questions)
421+
422+
### Q: Some of my users in Azure DevOps have GitHub identities. Do I need to add them as new GitHub users into my organization?
423+
A: No. Ask your users to sign out, and then from a fresh browser session, sign back in to the organization with their GitHub credentials. This action will help establish the users as having valid GitHub identities.
424+
425+
### Q: I'm an organization Administrator and I turned on the policy that enables inviting GitHub users. Why can't I invite new GitHub users?
426+
A: Once the setting is changed, sign out of Azure DevOps, and then from a fresh browser session, sign back in to the organization `dev.azure.com/{organizationName}` or `organizationName.visualstudio.com` with your GitHub credentials.
427+
428+
### Q: I signed in with my GitHub credentials, but why can't I invite GitHub users?
429+
430+
A: Only organization or project Administrators can invite new users to join the organization. You might not have the permission required to add new users. Work with your administrator to get you the right permissions or ask them to add the user for you.
431+
418432
## Next steps
419433
420434
> [!div class="nextstepaction"]

docs/includes/sign-in-github-account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ Once the setting is changed, sign out of Azure DevOps, and then from a fresh bro
4141

4242
![Invite GitHub users policy ](../media/invite-github-users-policy.png)
4343

44-
For more information about GitHub authentication, see [FAQs](../organizations/security/faq-github-authentication.yml).
44+
For more information about GitHub authentication, see [Connect to GitHub/FAQs](../boards/github/connect-to-github.md#faqs).

docs/organizations/accounts/add-organization-users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ To give other users access to your organization, add their email addresses.
6767
> [!div class="mx-imgBorder"]
6868
>![Web portal, organization admin context, Add new users dialog box](media/add-organization-users-from-user-hub/add-new-users-dialog.png)
6969
70-
* **Users:** Enter the email addresses (Microsoft accounts) or GitHub usernames for the users. You can add several email addresses by separating them with a semicolon (;). An email address appears in red when it's accepted. For more information about GitHub authentication, see [FAQs](../security/faq-github-authentication.yml). To add a service principal, enter the display name of the application or managed identity.
70+
* **Users:** Enter the email addresses (Microsoft accounts) or GitHub usernames for the users. You can add several email addresses by separating them with a semicolon (;). An email address appears in red when it's accepted. For more information about GitHub authentication, see [Connect to GitHub/FAQs](../../boards/github/connect-to-github.md#faqs). To add a service principal, enter the display name of the application or managed identity.
7171
* **Access level:** Leave the access level as **Basic** for users who contribute to the code base. To learn more, see [About access levels](../security/access-levels.md).
7272
* **Add to projects:** Select the project you want to add them to.
7373
* **Azure DevOps Groups:** Leave as **Project Contributors**, the default security group for users who contribute to your project. To learn more, see [Default permissions and access assignments](../security/permissions-access.md).

docs/organizations/security/about-security-identity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ The following policies determine the access you want to give users and applicati
228228
- **External guest access** (*Only valid when the organization is connected to Microsoft Entra ID.*): When enabled, invitations can be sent to email accounts of users who aren't members of the tenant Microsoft Entra ID through the **Users** page. For more information, see [Add external users to your organization](../accounts/add-external-user.md).
229229
- **Allow team and project administrators to invite new users**: Only valid when the organization is connected to Microsoft Entra ID. When enabled, team and project administrators can add users through the **Users** page. For more information, see [Restrict new user invitations from Project and Team Administrators](restrict-invitations.md).
230230
- **Request access**: Only valid when the organization is connected to Microsoft Entra ID. When enabled, users can request access to a resource. A request results in an email notification to the administrators asking for review and access, as needed. For more information, see [Add external users to your organization](../accounts/add-external-user.md).
231-
- **Invite GitHub users**: Only valid when the organization isn't connected to Microsoft Entra ID. When enabled, administrators can add users based on their GitHub user accounts from the **Users** page. For more information, see [Authenticating & inviting GitHub users FAQs](faq-github-authentication.yml#github-users).
231+
- **Invite GitHub users**: Only valid when the organization isn't connected to Microsoft Entra ID. When enabled, administrators can add users based on their GitHub user accounts from the **Users** page. For more information, see [Connect to GitHub/FAQs](../../boards/github/connect-to-github.md#faqs).
232232

233233
<a id="project-scoped-user-group"></a>
234234

docs/organizations/security/faq-github-authentication.yml

Lines changed: 0 additions & 42 deletions
This file was deleted.

docs/organizations/security/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,8 +270,8 @@
270270
href: troubleshoot-permissions.md
271271
- name: User & permissions management FAQs
272272
href: ../accounts/faq-user-and-permissions-management.yml?toc=/azure/devops/organizations/security/toc.json
273-
- name: Authenticate & invite with GitHub
274-
href: faq-github-authentication.yml
273+
- name: Connect to GitHub, FAQs
274+
href: ../../boards/github/connect-to-github.md#faqs?toc=/azure/devops/organizations/security/toc.json
275275
- name: Access with Microsoft Entra FAQs
276276
href: ../accounts/faq-azure-access.yml?toc=/azure/devops/organizations/security/toc.json
277277
- name: Set up Visual Studio

docs/pipelines/get-started/pipelines-sign-up.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To sign up for Azure DevOps with a GitHub account, complete the following steps.
7272

7373
![Link GitHub account to Microsoft account](media/link-microsoft-account.png)
7474

75-
For more information about GitHub authentication, see [FAQs](../../organizations/security/faq-github-authentication.yml).
75+
For more information about GitHub authentication, see [Connect to GitHub/FAQs](../../boards/github/connect-to-github.md#faqs).
7676

7777
6. Fill in your name, email address, and country/region.
7878

docs/user-guide/sign-up-invite-teammates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ Sign in to your organization at any time `https://dev.azure.com/{Your_Organizati
5858
- [Change the location of your organization](../organizations/accounts/change-organization-location.md)
5959
- [Add users to your organization](../organizations/accounts/add-organization-users.md)
6060
- [Add users or groups to a team or project](../organizations/security/add-users-team-project.md)
61-
- [GitHub authentication FAQs](../organizations/security/faq-github-authentication.yml)
61+
- [Connect to GitHub, FAQs](../boards/github/connect-to-github.md#faqs)

0 commit comments

Comments
 (0)