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

DOCS-2640 SAML Troubleshooting Guide #11398

Merged
merged 20 commits into from
Nov 2, 2021
Merged

DOCS-2640 SAML Troubleshooting Guide #11398

merged 20 commits into from
Nov 2, 2021

Conversation

alai97
Copy link
Contributor

@alai97 alai97 commented Aug 12, 2021

What does this PR do?

First draft of a troubleshooting guide for SAML errors.

Motivation

DOCS-2352

Preview

https://docs-staging.datadoghq.com/alai97/saml-troubleshooting-guide/account_management/saml/troubleshooting/

Reviewer checklist

  • Review the changed files.
  • Review the URLs listed in the Preview section.
  • Check images for PII
  • Review any mentions of "Contact Datadog support" for internal support documentation.

@alai97
DOCS-2352
8a58d36 
First draft of a troubleshooting guide for SAML errors.
@alai97 alai97 added the WORK IN PROGRESS No review needed, it's a wip ;) label Aug 12, 2021
@alai97 alai97 requested a review from sarina-dd August 12, 2021 16:02
@alai97 alai97 requested a review from a team as a code owner August 12, 2021 16:02
@github-actions github-actions bot added account_management Content changed in the Account_management folder Architecture Everything related to the Doc backend labels Aug 12, 2021
@alai97 alai97 changed the title DOCS-2352 DOCS-2352 SAML Troubleshooting Guide Aug 16, 2021
sarina-dd
sarina-dd reviewed Aug 17, 2021
View reviewed changes
Copy link
Contributor

@sarina-dd sarina-dd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vale recommendations

content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
@sarina-dd sarina-dd requested a review from psionn August 17, 2021 17:25
@sarina-dd
Copy link
Contributor

Hi @psionn! We've pulled together a first draft of the SAML troubleshooting guide. Would love for you to take a look and leave feedback.

vibrantlife
vibrantlife suggested changes Sep 28, 2021
View reviewed changes
Copy link
Contributor

@vibrantlife vibrantlife left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added some notes and a wish list of items to add to this doc.

content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Show resolved Hide resolved
@github-actions github-actions bot added the Images Images are added/removed with this PR label Oct 6, 2021
vibrantlife
vibrantlife suggested changes Oct 8, 2021
View reviewed changes
Copy link
Contributor

@vibrantlife vibrantlife left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've left some enhancements and suggestions for improvements.

content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Show resolved Hide resolved
@sarina-dd
Copy link
Contributor

Thanks for the feedback, @vibrantlife! Incorporated it in the latest commit.

@sarina-dd sarina-dd added editorial review Waiting on a more in-depth review and removed WORK IN PROGRESS No review needed, it's a wip ;) labels Oct 15, 2021
@sarina-dd sarina-dd changed the title DOCS-2352 SAML Troubleshooting Guide DOCS-2640 SAML Troubleshooting Guide Oct 15, 2021
@alai97 alai97 requested a review from vibrantlife October 15, 2021 01:25
vibrantlife
vibrantlife approved these changes Oct 15, 2021
View reviewed changes
Copy link
Contributor

@vibrantlife vibrantlife left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for your work on this! It looks great. I just added 2 comments and then I think it's good to go!

content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Show resolved Hide resolved
alai97
alai97 commented Oct 18, 2021
View reviewed changes
Copy link
Contributor Author

@alai97 alai97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrapping up Nichole's final copy nits!

content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Show resolved Hide resolved
jtappa
jtappa suggested changes Nov 1, 2021
View reviewed changes
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated
</saml2:Attribute>
```

2. Navigate to the Team page in the bottom left corner of Datadog.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Team" page no longer exists! These instructions need updating and verification.

content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
alai97
alai97 commented Nov 2, 2021
View reviewed changes
Copy link
Contributor Author

@alai97 alai97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Mappings" --> "SAML Group Mappings"

content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
content/en/account_management/saml/troubleshooting.md Outdated Show resolved Hide resolved
@alai97 @jtappa
Doc Review #3
b4743db 
Co-authored-by: Jorie Helwig <[email protected]>
@alai97 alai97 requested a review from jtappa November 2, 2021 18:51
@jtappa jtappa merged commit 7eb9a56 into master Nov 2, 2021
@jtappa jtappa deleted the alai97/saml-troubleshooting-guide branch November 2, 2021 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vibrantlife vibrantlife vibrantlife approved these changes

@jtappa jtappa jtappa approved these changes

@psionn psionn Awaiting requested review from psionn

@sarina-dd sarina-dd Awaiting requested review from sarina-dd

Assignees
No one assigned
Labels
account_management Content changed in the Account_management folder Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review Images Images are added/removed with this PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@alai97 @sarina-dd @jtappa @vibrantlife