Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Require all notebooks to be classified #1319

Closed
Tracked by #1326
Eric-Arellano opened this issue May 7, 2024 · 0 comments · Fixed by #1359
Closed
Tracked by #1326

Require all notebooks to be classified #1319

Eric-Arellano opened this issue May 7, 2024 · 0 comments · Fixed by #1359
Assignees
@frankharkins
Labels
infra 🏗️

Comments

@Eric-Arellano
Copy link
Collaborator

Eric-Arellano commented May 7, 2024 •
edited

We currently classify notebooks in notebooks.toml into notebooks_that_submit_jobs and notebooks_no_mock. If the notebook is left off, it defaults to our third category of notebooks that do not submit jobs at all.

It's easy to not realize when you should be changing notebooks.toml. After talking to some of the content team, we think it'd be better to explicitly categorize every notebook in notebooks.toml.

Tasks:

  1. Create a new category like notebooks_no_jobs
  2. Error if a notebook is not categorized with a helpful message saying what file to modify and explaining the three available categories

Feedback from Kevin: We should try to clarify what we mean by the notebook being "too big".
@Eric-Arellano Eric-Arellano mentioned this issue May 8, 2024
Open
@frankharkins frankharkins mentioned this issue May 13, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 13, 2024
@frankharkins @Eric-Arellano
Refactor nb-tester config and args (#1351)
c6ea53f 
This script now has some non-trivial logic to do with skipping, mocking,
writing, etc. This refactor combines the `Config` and args objects so we
have a single point of decision making. You may find it easier to review
each commit separately.

This is prework for #1319.

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
@frankharkins frankharkins mentioned this issue May 13, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 14, 2024
@frankharkins @Eric-Arellano
Make sure all notebooks are classified in notebooks.toml (#1359)
72152ab 
Closes #1319.

* The script no longer uses `all-notebooks` as a glob pattern to search,
instead it just iterates through the list of filepaths
* Added a check to detect unclassified notebooks

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@frankharkins frankharkins

Labels
infra 🏗️
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Make sure all notebooks are classified in notebooks.toml Qiskit/documentation
2 participants
@Eric-Arellano @frankharkins