Qiskit / Qiskit/documentation

Figure out why AVIF image generation and objects.inv is not deterministic

Open
#2,802 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

infra 🏗️ tech debt 💩
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

We've had a few instances where generation of AVIF images for API docs & generation of objects.inv varies depending on the user's machine. This creates unnecessary Git diff noise. See https://github.com/Qiskit/documentation/pull/2801/commits for an example.

(I believe @Eric-Arellano and @arnaucasau have different behavior.)

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by inspecting the commits in documentation PR 2801 and reproducing both AVIF generation and objects.inv generation on the differing machines described in the issue. Trace the generation entry points and environment-dependent inputs; the work is done when both outputs are identical across supported environments and the result no longer creates unnecessary Git diff noise.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.