Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Document resource unit fields in service instance API guide

Open Beginner friendly
  • Is something wrong?
#5,790 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

The three sections to change are the Get, Create and Update instance parts of the access-instances-platform-apis guide linked in the issue; locate them in the repository by searching for those headings and for instance_limit_seconds. Add instance_limit_ru and usage_allocation_ru beside their seconds counterparts, and state that seconds and RUs cannot be sent together in POST or PATCH, that the other unit is calculated automatically, and that RUs are floating-point. Done when all three sections document both unit fields and the exclusion rule, and the page builds without errors.

Written by the indexing model from the issue text.

Description

content 📄 needs triage 🤔
URL to the relevant guide or resource
Select all that apply
  • new content request
  • typo
  • code bug
  • out-of-date content
  • broken link
  • other
Describe the fix or the content request.

The qiskit runtime service instance resource controller resources now have "resource unit" fields for limits and allocations. So where we see instance_limit_seconds and usage_allocation_seconds we now also have instance_limit_ru and usage_allocation_ru fields.

For the POST and PATCH requests, seconds and RUs can't be specified at the same time - an error will be returned if so. But if specifying limit or allocation in seconds, the RU value will be calculated automatically, and vice-versa.

RUs are a floating point number, not an integer like the seconds fields.

For new content requests - if the request is accepted, do you want to write the content?

I can help the team by providing enough information or by referring them to a specific Subject Matter Expert to write the material

Dominant language
Jupyter Notebook
Stars
108
Forks
236
Avg merge
3d 4m
Merged PRs (30d)
81

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Qiskit/documentation

All issues in Qiskit/documentation

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.