doc: add preferences auth concept page #2056
Conversation
| }); | ||
|
|
||
| // Get team preferences | ||
| const promise = teams.get('<TEAM_ID>'); |
There was a problem hiding this comment.
Perhaps we should be consistent and use teams.getPrefs('<TEAM_ID>')?
| { | ||
| label: 'Preferences', | ||
| href: '/docs/products/auth/preferences' | ||
| }, |
There was a problem hiding this comment.
When the docs were first designed/structured, Concepts were used to explain aspects in Appwrite while Journeys talked more about use cases. See our style guide:
Given that, I would recommend splitting up the content so that this new Preferences content goes under Journeys.
If we want Preferences more discoverable, we should move the Preferences in Accounts into its own page and add a section on Team Preferences.
There was a problem hiding this comment.
Done @stnguyen90 Please check out the update
| | **Schema Validation** | No | No | No | Yes | | ||
| | **Offline Access** | Yes | No | No | No** | | ||
| | **Syncing Required** | Yes | Automatic | Automatic | Manual | | ||
| | **Query Capabilities** | Basic | Basic | Basic | Advanced | |
There was a problem hiding this comment.
When I hear query, I think of being able to fetch for a certain value or filter, but you can't really query user/team preferences 🧐
There was a problem hiding this comment.
That makes sense. I'll change to "no, no, no, yes"
| | **Complexity** | Simple | Simple | Simple | Complex | | ||
| | **Schema Validation** | No | No | No | Yes | | ||
| | **Offline Access** | Yes | No | No | No** | | ||
| | **Syncing Required** | Yes | Automatic | Automatic | Manual | |
There was a problem hiding this comment.
Why is user/team preferences automatic but databases manual?
There was a problem hiding this comment.
The idea was that with user/team preferences, Appwrite does most of the setup work. But with Databases, how it functions depends on the user. Maybe I should change Databases to automatic
| - Persists across all user devices | ||
| - Stored as a JSON object | ||
| - Limited to 64kB of data | ||
| - Automatically synced when the user logs in |
There was a problem hiding this comment.
What do you mean by this? where is it synced to?
There was a problem hiding this comment.
Syncs from the cloud to their device. Is there another way we could pass this, or is the line not necessary?
- also update overview page / link to new preferences page
What does this PR do?
Adds new auth concept page, preferences
Test Plan
/docs/products/auth/preferencesRelated PRs and Issues
DRL-1430