-
Notifications
You must be signed in to change notification settings - Fork 88
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
(DOCSP-39535): Consolidate Manage Sync Subscriptions page #3320
Conversation
Readability for Commit Hash: aded9c3 You can see any previous Readability scores (if they exist) by looking Readability scores for changed documents:
For Grade Level, aim for 8 or below. For Reading Ease scores, aim for 60 or above:
For help improving readability, try Hemingway App. |
There was a problem hiding this 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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++.
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. 😕
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
.. 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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!
.../csharp/sync/manage-sync-subscriptions-wait-for-subscription-changes-to-sync-description.rst
Outdated
Show resolved
Hide resolved
source/includes/sdk-examples/sync/manage-sync-subscriptions-subscribe-to-query.rst
Outdated
Show resolved
Hide resolved
...pi-details/javascript/sync/manage-sync-subscriptions-find-subscription-js-ts-description.rst
Outdated
Show resolved
Hide resolved
.../includes/api-details/kotlin/sync/manage-sync-subscriptions-add-subscription-description.rst
Outdated
Show resolved
Hide resolved
...otlin/sync/manage-sync-subscriptions-remove-all-subscriptions-to-object-type-description.rst
Outdated
Show resolved
Hide resolved
.../includes/api-details/swift/sync/manage-sync-subscriptions-find-subscription-description.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Kyle Rollins <[email protected]>
✅ Deploy Preview for device-sdk ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this 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!
6411c1c
into
mongodb:feature-consolidated-sdk-docs
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/feature-consolidated-sdk-docs/ 🪵 Logs |
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:
feature-consolidated-sdk-docs
branch instead ofmaster
Naming
.rst
files comply with the naming guidelinesLinks and Refs
Content
Reviewer Checklist
As a reviewer, please check these items: