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-39527): Consolidate Custom User Data page #3346

Merged
merged 10 commits into from
Aug 6, 2024

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Jul 30, 2024

Pull Request Info - SDK Docs Consolidation

Jira ticket: https://jira.mongodb.org/browse/DOCSP-39527

Staged Page

Note for reviewer: a couple of the API descriptions are missing where we just don't have an example and there's nothing notable to say. I've added notes to the follow-up gap tickets to also fill in these API descriptions when we add examples.

Page Source

Add links to every SDK's pages where you got the SDK-specific information:

PR Author Checklist

Before requesting a review for your PR, please check these items:

  • Open the PR against the feature-consolidated-sdk-docs branch instead of master
  • Tag the consolidated page for:
    • genre
    • meta.keywords
    • meta.description

Naming

Links and Refs

  • Create new consolidated SDK ref targets starting with "_sdks-" for relevant sections
  • Remove or update any SDK-specific refs to use the new consolidated SDK ref targets
  • Update any Kotlin API links to use the new Kotlin SDK roles

Content

  • Shared code boxes have snippets or placeholders for all 9 languages
  • API description sections have API details or a generic placeholder for all 9 languages
  • Check related pages for relevant content to include
  • Create a ticket for missing examples in each relevant SDK: Consolidation Gaps epic

Reviewer Checklist

As a reviewer, please check these items:

  • Shared code example boxes contain language-specific snippets or placeholders for every language
  • API reference details contain working API reference links or generic content
  • Realm naming/language has been updated
  • All relevant content from individual SDK pages is present on the consolidated page

@dacharyc dacharyc added the merge to feature branch Unreleased feature - do not merge to Master label Jul 30, 2024
Copy link

netlify bot commented Jul 30, 2024

Deploy Preview for device-sdk ready!

Name Link
🔨 Latest commit 3201d61
🔍 Latest deploy log https://app.netlify.com/sites/device-sdk/deploys/66b2217dd32096000803439a
😎 Deploy Preview https://deploy-preview-3346--device-sdk.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 35 (🟢 up 10 from production)
Accessibility: 92 (🔴 down 1 from production)
Best Practices: 75 (no change from production)
SEO: 62 (🔴 down 7 from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Jul 30, 2024

Readability for Commit Hash: 3201d61

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

Readability scores for changed documents:

  • source/sdk/users/custom-user-data: Grade Level: 9.2, Reading Ease: 56.15

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.

Copy link
Collaborator

@krollins-mdb krollins-mdb left a comment

Choose a reason for hiding this comment

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

LGTM with a handful of minor suggestions. Thanks, @dacharyc!

Comment on lines 210 to 211
data whenever a user refreshes their :ref:`access token
<user-sessions>`, which is used by most SDK operations that contact
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hmm. Know this content already existed, but the link here isn't obvious to me. We say "access token" and then send people to a User Sessions section that doesn't mention tokens at all. Would it make more sense to link directly to the Manage User Sessions page, which does talk about tokens?

dacharyc and others added 2 commits August 6, 2024 09:08
Co-authored-by: Kyle Rollins <115574589+krollins-mdb@users.noreply.github.com>
@dacharyc dacharyc merged commit 6835ea9 into mongodb:feature-consolidated-sdk-docs Aug 6, 2024
10 checks passed
@dacharyc dacharyc deleted the DOCSP-39527 branch August 6, 2024 13:16
@docs-builder-bot
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge to feature branch Unreleased feature - do not merge to Master
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants