docs: update README with detailed instructions for role and RLS policy management #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Benmuiruri
requested changes
Feb 19, 2025
README.md
Outdated
|
|
||
| ## Creating RLS policies | ||
|
|
||
| The process is similar to the one above for creating roles. The `group key` and `clause` are the important bits here and should be configured accordingly. They determine what level of access the role will have. For example, the clause 'county_name' = '{{county_name}}' will allow the role to access data from the specified county. |
There was a problem hiding this comment.
Suggestion: Add an example JSON payload for how to create RLS Policy
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| Next, update the permissions for the roles. Subsequent roles for individual types will be copied off of these `base` roles. |
There was a problem hiding this comment.
Question: should we describe how to update the permissions for the roles on the UI ? Or via API ?
There was a problem hiding this comment.
The API for now. Doing it via the UI can introduce unwanted changes due to how the permissions UX is presented.
Co-authored-by: Ben Kiarie <[email protected]>
Co-authored-by: Ben Kiarie <[email protected]>
Co-authored-by: Ben Kiarie <[email protected]>
Co-authored-by: Ben Kiarie <[email protected]>
Benmuiruri
approved these changes
Feb 20, 2025
Comment on lines
+6
to
+10
|
|
||
| Clone the repository and install the dependencies: | ||
| ```bash | ||
| npm install | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| Clone the repository and install the dependencies: | |
| ```bash | |
| npm install | |
| ``` | |
| 1. Clone the repository. | |
| 2. install the dependencies: `npm install` | |
| 3. Create a `data` folder in the root of the repository | |
| 3. Add your csv file to the data folder, refer to the `./src/template.csv` for a sample. | |
| 2. Define your environment variables - make a copy of `.env.template` and rename to `.env` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.