Database documentations #937
Conversation
fflorent
force-pushed
the
db-doc
branch
3 times, most recently
from
d38f2d8 to
584a896
Compare
| The migrations are handled in the python sandbox in this code: | ||
| https://github.com/gristlabs/grist-core/blob/main/sandbox/grist/migrations.py | ||
|
|
||
| For more information, please consult [the documentation for migrations](./migrations.md). |
There was a problem hiding this comment.
We can add information of sandbox/grist/schema.py that are the schema of a Doc Database and when we create a new migration we have to adapt this file
There was a problem hiding this comment.
The link to ./migrations.md gives a indirect reference to this file with more context. What do you think?
| `viewers`, `members` and `guests` have basically the same rights (like viewers), the only difference between them is that: | ||
| - `viewers` are explicitly allowed to view the resource and its descendants; | ||
| - `members` are specific to the organisations and are meant to allow access to be granted to individual documents or workspaces, rather than the full team site. | ||
| - `guests` are (FIXME: help please on this one :)) |
There was a problem hiding this comment.
Maybe (not sure !!) that are mail adresses that we add in ACL but which have never logged in and therefore don't have an account. But I don't see it in the choices in frontend
There was a problem hiding this comment.
I feel like they are meant for people invited to workspaces or documents, indeed, but:
- these people are directly granted the role they were assigned (not the guest role);
- for the ancestor resources (workspaces and/or orgs), they are assigned a guest role;
There was a problem hiding this comment.
To make it understandable more quickly maybe but the arrow between Org1 Owners and Ws1 Owners in dotted line and if it's possible put an bug red cross on all the Ws1 Owners ? And like that maybe the new indication won't be necessary
There was a problem hiding this comment.
I feel like the 'new' label would still be necessary, but I agree that the dotted line is clearer, I added that.
| | name | The name as displayed in the UI | | ||
| | domain | The part that should be added in the URL | | ||
| | owner | The id of the user who owns the org | | ||
| | host | ??? | |
There was a problem hiding this comment.
Thanks! But still unclear to me, considering the domain column.
Co-authored-by: jordigh <[email protected]>
Start documenting the databases including: * document ACL and other tables * Permissions * Groups, secrets, and other tables --------- Co-authored-by: jordigh <[email protected]>
This is an attempt to document the databases (home and grist documents).
I focus more on the home database for now, the documentation of the tables in documentation should be done in a future work.
To view the documentation rendered: https://github.com/fflorent/grist-core/blob/db-doc/documentation/database.md