Skip to content

[WIP] Generate authorization role guide - #5384

Draft
Eric-Arellano wants to merge 2 commits into
mainfrom
generate-auth
Draft

[WIP] Generate authorization role guide#5384
Eric-Arellano wants to merge 2 commits into
mainfrom
generate-auth

Conversation

@Eric-Arellano

Copy link
Copy Markdown
Collaborator

We already document our IAM roles at https://cloud.ibm.com/docs/iam?topic=iam-iam-service-roles-actions#service-roles-table155, along with inline in the REST API guides where we say the "Authorization" required for each endpoint.

This endpoint adds an additional centralized place where we list all of our IAM roles. Reasons why this is useful:

  • Unlike the cloud.ibm.com page, this new guide shows up in search in IBM Quantum Platform
  • Unlike the cloud.ibm.com page, this lists the specific API endpoints for each role
  • Unlike the REST API, this gives one centralized list

There's little extra maintenance burden because we reuse the cron job we already had for generating the observability pages.

image

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Eric-Arellano

Copy link
Copy Markdown
Collaborator Author

The code is all ready, but this needs some help from @Qiskit/docs-content-team please to finish it.

  1. Decide if the page should be /guides/authorization-roles or /guides/iam-roles. I proposed authorization because our REST API docs already call it "Authorization"
  2. Decide where the page should live in the left TOC. I put it under "Security and compliance". Another option is "IBM Quantum Platform -> Accounts, access groups, and policies"
  3. Add prose to the top of the file. You'll do that by filling in getAuthorizationProse in scripts/js/commands/generateRestApiGuides.ts
  4. Cross-link to this new page from anywhere you'd like.

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

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

1 participant