-
Notifications
You must be signed in to change notification settings - Fork 104
docs: update tenants, assets, and admin user guide #3774
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
base: main
Are you sure you want to change the base?
Conversation
Updated assets.mdx with sections for updating and deleting assets Updated tenants.mdx to include more contextual information before each operation (add, update, delete) Updated the admin user guide to specify read-only values when editing Overall, improvements made for multi-tenancy consistency and cohesion across pages
i forgot my old friend, prettier
✅ Deploy Preview for brilliant-pasca-3e80ec ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
After a writer review, I'll seek a technical review as well. |
🚀 Performance Test ResultsTest Configuration:
Test Metrics:
📜 Logs |
melissahenderson
left a comment
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.
In the Integration Assets page and also the Peers page, we have permissions lists that could be shortened. Would you mind making those changes?
Instead of:
- Operators can create...
- Operators can view...
- Operators can edit and delete...
We can do:
Operators can:
- Create assets...
- View...
- Edit and delete
packages/documentation/src/content/docs/integration/requirements/assets.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| Deleting an asset removes it from active use within a Rafiki instance. | ||
|
|
||
| This operation succeeds only if the asset is **not** referenced by any peers or wallet addresses. |
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'm not sure what is meant by "referenced". I did a super quick search and I don't see "reference" being used anywhere else (other than in the list a bit below) in this context. If that's the right word to use, then that's fine.
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.
This verbiage came from a deeper dive into how deletes actually work, but it doesn't sound very natural. Basically, that delete mutation checks (at the database level) if any peer or wallet address record is using an asset's id as a key.
I have some similar content in the live version of the admin user guide - https://rafiki.dev/admin/admin-user-guide/#delete-asset
"Reference" is used twice here and "associated" is used once. Let me find a smoother way to match similar phrasing - maybe something like "...if the asset is not associated with any peers..."
packages/documentation/src/content/docs/integration/requirements/tenants.mdx
Outdated
Show resolved
Hide resolved
- Updated user guide and tenants page to clarify API secret details - Revised ambiguous wording and accidental line break - Revised permissions lists on assets and peers pages
another missed line break
Fixed permissions style and formatting on assets and peers pages
|
Ready for technical review - adding @mkurapov and @BlairCurrey as reviewers |
Fixes #3638
Description of changes
Overall, improvements made for multi-tenancy consistency and cohesion across pages
Required
Conditional