Qiskit / Qiskit/documentation

Detect need for redirects in CI

Open
#1,567 0 comments 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 need to set up redirects whenever we rename or delete a page from docs/, or delete a tutorial or change it's slug. It would be good if we have a check in CI that detects this and fails unless the change is added to an allowlist (which the author should only do when the redirects are ready).

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 with the docs/ tree and the repository's CI configuration, then determine how page renames, deletions, tutorial deletions, and slug changes can be detected. Define the allowlist workflow and verify that CI fails for an unallowlisted change while passing once the corresponding redirect is recorded.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.