pypa / pypa/packaging.python.org

Use a version-controlled file as source of truth for Read the Docs redirects

Open
#1,408 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: discussion
Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

The idea is basically the same as that of https://github.com/pypa/pip/pull/11652.

The proposal is that we adopt the same here. This serves to move the ability to add redirects to everyone with the ability to commit to this repository, and makes it possible to ensure that the actually-configured redirects are more generally visibke/accessible.

The details of how it'd work are in the commit messages in the aforementioned PR.

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 reading the referenced pip pull request, especially its commit messages, then inspect this repository's current Read the Docs redirect configuration. The change is complete when redirects are defined in a version-controlled repository file and that file is used as the source of the configured redirects.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
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.