Skip to content

Conversation

@brad-dow
Copy link
Contributor

@brad-dow brad-dow commented Dec 10, 2025

Fixes #3638

Description of changes

  • 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

Required

  • Used LinkOut component on external links
  • Reviewed Vale errors and made changes where appropriate
  • Ran Prettier
  • Previewed updates in Netlify
  • Received SME and/or peer approval if updates are significant
  • Included a "fixes #" comment

Conditional

  • Ensured sequence diagrams follow our style guide
  • Included code samples where appropriate
  • Updated related READMEs

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
@netlify
Copy link

netlify bot commented Dec 10, 2025

Deploy Preview for brilliant-pasca-3e80ec ready!

Name Link
🔨 Latest commit 072d911
🔍 Latest deploy log https://app.netlify.com/projects/brilliant-pasca-3e80ec/deploys/693c9304754bab00085c97c7
😎 Deploy Preview https://deploy-preview-3774--brilliant-pasca-3e80ec.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added the pkg: documentation Changes in the documentation package. label Dec 10, 2025
@brad-dow
Copy link
Contributor Author

After a writer review, I'll seek a technical review as well.

@github-actions
Copy link

github-actions bot commented Dec 10, 2025

🚀 Performance Test Results

Test Configuration:

  • VUs: 4
  • Duration: 1m0s

Test Metrics:

  • Requests/s: 40.73
  • Iterations/s: 13.58
  • Failed Requests: 0.00% (0 of 2453)
📜 Logs

> [email protected] run-tests:testenv /home/runner/work/rafiki/rafiki/test/performance
> ./scripts/run-tests.sh -e test "-k" "-q" "--vus" "4" "--duration" "1m"

Cloud Nine GraphQL API is up: http://localhost:3101/graphql
Cloud Nine Wallet Address is up: http://localhost:3100/
Happy Life Bank Address is up: http://localhost:4100/
cloud-nine-wallet-test-backend already set
cloud-nine-wallet-test-auth already set
happy-life-bank-test-backend already set
happy-life-bank-test-auth already set
     data_received..................: 885 kB 15 kB/s
     data_sent......................: 1.9 MB 31 kB/s
     http_req_blocked...............: avg=8.26µs   min=2.35µs   med=5.92µs   max=763.42µs p(90)=7.03µs   p(95)=7.65µs  
     http_req_connecting............: avg=868ns    min=0s       med=0s       max=712.42µs p(90)=0s       p(95)=0s      
     http_req_duration..............: avg=97.46ms  min=7.86ms   med=80.72ms  max=573.69ms p(90)=170.54ms p(95)=195.12ms
       { expected_response:true }...: avg=97.46ms  min=7.86ms   med=80.72ms  max=573.69ms p(90)=170.54ms p(95)=195.12ms
     http_req_failed................: 0.00%  ✓ 0         ✗ 2453
     http_req_receiving.............: avg=100.42µs min=28.19µs  med=85.2µs   max=2.35ms   p(90)=129.03µs p(95)=162.72µs
     http_req_sending...............: avg=37.51µs  min=14.33µs  med=30.61µs  max=2.08ms   p(90)=45.3µs   p(95)=58.99µs 
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=97.32ms  min=7.64ms   med=80.53ms  max=573.62ms p(90)=170.42ms p(95)=194.9ms 
     http_reqs......................: 2453   40.732289/s
     iteration_duration.............: avg=294.08ms min=203.51ms med=280.55ms max=1.15s    p(90)=356.95ms p(95)=381.52ms
     iterations.....................: 818    13.582965/s
     vus............................: 4      min=4       max=4 
     vus_max........................: 4      min=4       max=4 

Copy link
Contributor

@melissahenderson melissahenderson left a 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


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.
Copy link
Contributor

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.

Copy link
Contributor Author

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..."

- 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
@brad-dow
Copy link
Contributor Author

Ready for technical review - adding @mkurapov and @BlairCurrey as reviewers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg: documentation Changes in the documentation package.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: build out Integration > Requirements > Assets

2 participants