From 3ebcc7122c4867b8f62b6ace6bbd34c12aaa4ec8 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Fri, 29 Jul 2022 12:53:18 +0100 Subject: [PATCH] Add note to divert away from adding content to user guide 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. --- docs/html/user_guide.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 70a28ab9988..4fbbd9eae00 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -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 ===========