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.

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

(DOCSP-34287) Add documentation for App.EmailPassword.retryCustomConfirmation #3098

Merged
merged 10 commits into from
Dec 4, 2023

Conversation

krollins-mdb
Copy link
Collaborator

@krollins-mdb krollins-mdb commented Dec 1, 2023

Pull Request Info

Jira ticket: https://jira.mongodb.org/browse/DOCSP-34287
Staged changes:

Add an example for the new App.EmailPassword.retryCustomConfirmation method.

Reminder Checklist

Before merging your PR, make sure to check a few things.

  • Describe your PR's changes in the Release Notes section
  • Create a Jira ticket for corresponding docs-app-services work if needed

Release Notes

  • .NET SDK
    • Manage Users/Manage Email/Password Users: Add an example for the new App.EmailPassword.retryCustomConfirmation method and the older, undocumented, App.EmailPassword.ResendConfirmationEmailAsync method.

Review Guidelines

REVIEWING.md

Copy link

github-actions bot commented Dec 1, 2023

Readability for Commit Hash: 7c7e561

You can see any previous Readability scores (if they exist) by looking
at the comment's history.

Readability scores for changed documents:

  • source/sdk/dotnet/manage-users/manage-email-password-users: Grade Level: 10.0, Reading Ease: 48.7

For Grade Level, aim for 8 or below.

For Reading Ease scores, aim for 60 or above:

Score Difficulty
90-100 Very Easy
80-89 Easy
70-79 Fairly Easy
60-69 Medium
50-59 Fairly Hard
30-49 Hard
0-29 Very Hard

For help improving readability, try Hemingway App.

@krollins-mdb krollins-mdb marked this pull request as ready for review December 4, 2023 16:12
@krollins-mdb krollins-mdb changed the title (DOCSP-34457) Add documentation for App.EmailPassword.retryCustomConfirmation (DOCSP-34287) Add documentation for App.EmailPassword.retryCustomConfirmation Dec 4, 2023
Copy link
Collaborator

@cbullinger cbullinger left a comment

Choose a reason for hiding this comment

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

Question for related content that's out-of-scope for this ticket, but otherwise LGTM!

@@ -51,6 +51,17 @@ mehtod.
.. literalinclude:: /examples/generated/dotnet/WorkWithRealm.snippet.confirm-user.cs
:language: csharp

Retry a User Confirmation Function
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we want to also include a section for resending the email a la Swift -- maybe under another PR? It looks like it's an available method in .NET

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll look at adding it. Shouldn't take too long.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Updates look good! Release Notes section should be updated too?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah, yep. I'll update that now.

@krollins-mdb krollins-mdb merged commit 6e66c33 into mongodb:master Dec 4, 2023
6 checks passed
@krollins-mdb krollins-mdb deleted the DOCSP-34457 branch December 4, 2023 21:52
@docs-builder-bot
Copy link

dacharyc pushed a commit to dacharyc/docs-realm that referenced this pull request Dec 11, 2023
…firmation` (mongodb#3098)

## Pull Request Info

Jira ticket: https://jira.mongodb.org/browse/DOCSP-34287
Staged changes:

- [Manage Email/Password
Users](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-34457/sdk/dotnet/manage-users/manage-email-password-users/#retry-a-user-confirmation-function)

Add an example for the new App.EmailPassword.retryCustomConfirmation
method.

### Reminder Checklist

Before merging your PR, make sure to check a few things.

- [x] Describe your PR's changes in the Release Notes section
- [x] Create a Jira ticket for corresponding docs-app-services work if
needed

### Release Notes

- **.NET SDK**
- Manage Users/Manage Email/Password Users: Add an example for the new
App.EmailPassword.retryCustomConfirmation method and the older,
undocumented, App.EmailPassword.ResendConfirmationEmailAsync method.

### Review Guidelines


[REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)

---------

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants