(DOCSP-39530): Consolidate Multi-User Applications page #3323
Conversation
dacharyc
added
the
merge to feature branch
|
Readability for Commit Hash: 824087b 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. |
|
|
||
| .. tab:: | ||
| :tabid: dart | ||
|
|
There was a problem hiding this comment.
This is intentionally missing a description, because I'm just re-using a code example from the Authentication page as a placeholder. This should get a description when we address the consolidation gaps ticket, per the TODO reminder in line 142 above. Apparently our tab directive does not support commented-out text in a tab - it just wanted to render it as regular text - so I had to put the todo above the tab block.
There was a problem hiding this comment.
Apparently our tab directive does not support commented-out text in a tab - it just wanted to render it as regular text - so I had to put the todo above the tab block.
interesting...
| Placeholder page for multi-user application content. | ||
| .. tabs-selector:: drivers | ||
|
|
||
| Atlas Device SDK allows multiple :ref:`users <user-accounts>` to be logged in |
There was a problem hiding this comment.
general comment that applies to all the of the links out to App Services user docs pages (e.g. here and ln 56): I know Kyle was pushing back on the "in the App Services documentation", but is there any other way we can flag that this link is taking you out of the SDK docs? esp for really generic link text like "users" -- I have no idea where that's taking me
There was a problem hiding this comment.
Honestly, since we're talking about potentially moving the server-side docs to co-exist with the SDK docs, I'm thinking we probably don't want to put a lot of words in our docs specifying you're going to a different docs set - because hopefully that will change soon. 🤞
Maybe it won't?
But generally it seems we are not aligned as a team on how to handle this, so I'm going with "leave it like it currently is" as part of the consolidation work, and we can revisit if/when we get aligned about this.
...udes/api-details/dart/users/multi-user-applications-list-all-users-on-device-description.rst
Outdated
Show resolved
Hide resolved
...udes/api-details/dart/users/multi-user-applications-list-all-users-on-device-description.rst
Show resolved
Hide resolved
| @@ -0,0 +1,3 @@ | |||
| In the example below, the active user is initially switched to ``user1`` | |||
| using the :js-sdk:`Realm.App.switchUser() <classes/App.html#switchUser>` method. | |||
There was a problem hiding this comment.
noting this since it came up while I was reviewing Omar's PR: links to the JS API docs don't seem to honor the URL anchors (at least, they don't for me). it just lands you at the top of the page every time
There was a problem hiding this comment.
Hmm, that might be something browser-specific? I use generic Chrome with no extensions and it honors the URL anchors for me.
| @@ -0,0 +1 @@ | |||
| You can change the active user with the ``App.switch(to: User)`` method. | |||
There was a problem hiding this comment.
Q on the code example for this -- is it supposed to include the second half commented out?
let app = App(id: YOUR_APP_SERVICES_APP_ID)
// ... log in ...
// Get another user on the device, for example with `app.allUsers`
let secondUser: User = getSomeOtherUser()
XCTAssertNotEqual(app.currentUser, secondUser)
// assert(app.currentUser != secondUser)
// Switch to another user
// app.switch(to: secondUser)
// The switch-to user becomes the app.currentUser
// XCTAssertEqual(app.currentUser, secondUser)
// assert(app.currentUser == secondUser)There was a problem hiding this comment.
This example definitely needs to be updated, and is called out in the Swift follow-up ticket.
Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>
dacharyc
merged commit f8eb607
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-39530
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-docsbranch instead ofmasterNaming
.rstfiles comply with the naming guidelinesLinks and Refs
Content
Reviewer Checklist
As a reviewer, please check these items: