pypa / pypa/packaging.python.org

Document in contributing guide what the process is for removing docs

Open
#1,401 7 comments 1 reaction 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

There seems to be some confusion about whether it is best to remove a doc completely or to make it an orphan doc. This is related to redirects. It's beyond my expertise or historical knowledge of the project so will defer to opinions of others.

Once we have consensus or a decision, let's document it. Thanks.

See #1377, #1397

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 contributing guide and the related issues #1377 and #1397, then review the discussion about removing documents, orphan pages, and redirects. The work is done when the project has reached a decision and the agreed process is documented in the contributing guide.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.