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-39535): Consolidate Manage Sync Subscriptions page #3320

Merged
merged 26 commits into from
Aug 1, 2024

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Jul 11, 2024

Pull Request Info - SDK Docs Consolidation

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

Staged Page

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 11, 2024
Copy link

github-actions bot commented Jul 11, 2024

Readability for Commit Hash: aded9c3

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

Readability scores for changed documents:

  • source/sdk/sync/manage-sync-subscriptions: Grade Level: 8.2, Reading Ease: 58.79
  • source/sdk/sync/configure-and-open-synced-database: Grade Level: 5.5, Reading Ease: 65.79

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.

@dacharyc dacharyc marked this pull request as ready for review July 16, 2024 16:48
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.

Thank you for all of the hard work on this page, @dacharyc!

I requested changes for some API ref links, adding back in a Dart code example, and looking into a couple potential platform bugs.


.. include:: /includes/api-details/javascript/sync/manage-sync-subscriptions-add-subscription-js-ts-description.rst

.. include:: /includes/sdk-examples/sync/manage-sync-subscriptions-add-subscription.rst
Copy link
Collaborator

Choose a reason for hiding this comment

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

I ran into a weird platform bug maybe? If you select Dart from either the code block dropdown or the one above the on this page TOC, then select C++, you get the placeholder for Dart. It only seems to happen for this specific direction and interaction.

Could potentially be a me thing, but confirmed the behavior in Firefox and Chrome.

Edit: after a bit more poking around, seems like any time there's placeholder content, then moving to the C++ tab, the previous placeholder sticks around. In this example, it happens with the C#, Java, and Kotlin (Java SDK) placeholders in addition to Dart.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Woah. This is weirder than I thought. There's another odd thing happening. On initial page load, I get the expected placeholder for C++.

Screenshot 2024-07-31 at 10 34 42 AM

However, if I switch to another language with a code example (like JavaScript), then switch back to C++, I get a code example for C++ and the bit about the language not supporting the query API. 😕

Screenshot 2024-07-31 at 10 36 21 AM

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh. Is this because there are two includes here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Well, that's unfortunate ☹️

It seems to be specific to this page. If I switch to another page with placeholders, this isn't happening (i.e. Create). So I don't know if I've done something disallowed with tabs here, or if it's the quantity of tabs here, or what. I'll play around with this and see if I can figure out what's happening.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ahh, figured it out. I used the wrong id in the code example include - I used cpp (which IS a valid Driver language, but isn't the one we're using for the SDK) instead of cpp-sdk.

This is now fixed here. I noticed it's also wrong in some other code example tab sets, so I'll make a separate PR to update it everywhere else it's wrong as that is outside the scope of this PR.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oooooh, interesting. I'm glad you figured it out. I was totally stumped. ha

Comment on lines 7 to 10
.. literalinclude:: /examples/generated/cpp/flexible-sync.snippet.remove-subscription-by-name.cpp
:language: cpp

.. include:: /includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
Copy link
Collaborator

Choose a reason for hiding this comment

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

Did you intentionally add these examples? The text before this says the C++ SDK doesn't allow for removing subscriptions to a specific object type.

Screenshot 2024-07-31 at 10 48 33 AM

It's weird to see the same wording used in other sections and they don't have examples.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Nope, this was a missed copy-paste when I duplicated it from another file. Thanks for catching this!

Copy link

netlify bot commented Aug 1, 2024

Deploy Preview for device-sdk ready!

Name Link
🔨 Latest commit aded9c3
🔍 Latest deploy log https://app.netlify.com/sites/device-sdk/deploys/66abac39c69a190008b52934
😎 Deploy Preview https://deploy-preview-3320--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: 27 (🟢 up 2 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
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.

Thanks for figuring out and fixing the weird tab set behavior! LGTM!

@dacharyc dacharyc merged commit 6411c1c into mongodb:feature-consolidated-sdk-docs Aug 1, 2024
10 checks passed
@dacharyc dacharyc deleted the DOCSP-39535 branch August 1, 2024 16:07
@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