Skip to content

Commit

Permalink
Add note to divert away from adding content to user guide
Browse files Browse the repository at this point in the history
This guide is being broken up, and multiple folks have now tried to add
content to it instead of adding dedicated pages for it.

This note should help direct contributors away from adding more content
on this page, to stop the bleeding and avoid regressing on the amount of
content we'll have to move out of this page later.
  • Loading branch information
pradyunsg committed Jul 29, 2022
1 parent b8ccb04 commit 3ebcc71
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/html/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
User Guide
==========

.. Hello there!
If you're thinking of adding content to this page... please take a moment
to consider if this content can live on its own, within a topic guide or a
reference page.
There is active effort being put toward *reducing* the amount of content on
this specific page (https://github.com/pypa/pip/issues/9475) and moving it
into more focused single-page documents that cover that specific topic.
Running pip
===========
Expand Down

0 comments on commit 3ebcc71

Please sign in to comment.