Merge pull request #6205 from theacodes/rewrite-readme-and-index

Rewrite readme and index

README.rst

@@ -1,51 +1,45 @@
-pip
+pip - The Python Package Installer
-===
+==================================
-
-The `PyPA recommended`_ tool for installing Python packages.
 
 .. image:: https://img.shields.io/pypi/v/pip.svg
    :target: https://pypi.org/project/pip/
 
-.. image:: https://img.shields.io/travis/pypa/pip/master.svg?label=travis-ci
-   :target: https://travis-ci.org/pypa/pip
-
-.. image:: https://img.shields.io/appveyor/ci/pypa/pip.svg?label=appveyor-ci
-   :target: https://ci.appveyor.com/project/pypa/pip/history
-
 .. image:: https://readthedocs.org/projects/pip/badge/?version=latest
    :target: https://pip.pypa.io/en/latest
 
-.. image:: https://dev.azure.com/pypa/pip/_apis/build/status/Linux?branchName=master&label=Windows
+pip is the `package installer`_ for Python. You can use pip to install packages from the `Python Package Index`_ and other indexes.
-   :target: https://dev.azure.com/pypa/pip/_build/latest?definitionId=6
 
-.. image:: https://dev.azure.com/pypa/pip/_apis/build/status/macOS?branchName=master&label=macOS
+Please take a look at our documentation for how to install and use pip:
-   :target: https://dev.azure.com/pypa/pip/_build/latest?definitionId=7
-
-.. image:: https://dev.azure.com/pypa/pip/_apis/build/status/Linux?branchName=master&label=Linux
-   :target: https://dev.azure.com/pypa/pip/_build/latest?definitionId=4
 
 * `Installation`_
-* `Documentation`_
+* `Usage`_
-* `Changelog`_
+* `Release notes`_
-* `GitHub Page`_
+
-* `Issue Tracking`_
+If you find bugs, need help, or want to talk to the developers please use our mailing lists or chat rooms:
+
+* `Issue tracking`_
 * `User mailing list`_
-* `Dev mailing list`_
 * `User IRC`_
+
+If you want to get involved head over to GitHub to get the source code and feel free to jump on the developer mailing lists and chat rooms:
+
+* `GitHub page`_
+* `Dev mailing list`_
 * `Dev IRC`_
 
 Code of Conduct
 ---------------
 
 Everyone interacting in the pip project's codebases, issue trackers, chat
-rooms and mailing lists is expected to follow the `PyPA Code of Conduct`_.
+rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.
 
-.. _PyPA recommended: https://packaging.python.org/en/latest/current/
+.. _package installer: https://packaging.python.org/en/latest/current/
+.. _Python Package Index: https://pypi.org
 .. _Installation: https://pip.pypa.io/en/stable/installing.html
-.. _Documentation: https://pip.pypa.io/en/stable/
+.. _Usage: https://pip.pypa.io/en/stable/
-.. _Changelog: https://pip.pypa.io/en/stable/news.html
+.. _Release notes: https://pip.pypa.io/en/stable/news.html
-.. _GitHub Page: https://github.com/pypa/pip
+.. _GitHub page: https://github.com/pypa/pip
-.. _Issue Tracking: https://github.com/pypa/pip/issues
+.. _Issue tracking: https://github.com/pypa/pip/issues
 .. _User mailing list: https://groups.google.com/forum/#!forum/python-virtualenv
 .. _Dev mailing list: https://groups.google.com/forum/#!forum/pypa-dev
 .. _User IRC: https://webchat.freenode.net/?channels=%23pypa

docs/html/index.rst

@@ -1,15 +1,9 @@
-pip
+pip - The Python Package Installer
-===
+==================================
 
-`User list <https://groups.google.com/forum/#!forum/python-virtualenv>`_ |
+pip is the `package installer`_ for Python. You can use pip to install packages from the `Python Package Index`_ and other indexes.
-`Dev list <https://groups.google.com/forum/#!forum/pypa-dev>`_ |
-`GitHub <https://github.com/pypa/pip>`_ |
-`PyPI <https://pypi.org/project/pip/>`_ |
-User IRC: #pypa |
-Dev IRC: #pypa-dev
 
-The `PyPA recommended <https://packaging.python.org/en/latest/current/>`_ tool
+Please take a look at our documentation for how to install and use pip:
-for installing Python packages.
 
 .. toctree::
    :maxdepth: 1
@@ -20,3 +14,34 @@ for installing Python packages.
    reference/index
    development/index
    news
+
+If you find bugs, need help, or want to talk to the developers please use our mailing lists or chat rooms:
+
+* `Issue tracking`_
+* `User mailing list`_
+* `User IRC`_
+
+If you want to get involved head over to GitHub to get the source code and feel free to jump on the developer mailing lists and chat rooms:
+
+* `GitHub page`_
+* `Dev mailing list`_
+* `Dev IRC`_
+
+Code of Conduct
+---------------
+
+Everyone interacting in the pip project's codebases, issue trackers, chat
+rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.
+
+.. _package installer: https://packaging.python.org/en/latest/current/
+.. _Python Package Index: https://pypi.org
+.. _Installation: https://pip.pypa.io/en/stable/installing.html
+.. _Documentation: https://pip.pypa.io/en/stable/
+.. _Changelog: https://pip.pypa.io/en/stable/news.html
+.. _GitHub page: https://github.com/pypa/pip
+.. _Issue tracking: https://github.com/pypa/pip/issues
+.. _User mailing list: https://groups.google.com/forum/#!forum/python-virtualenv
+.. _Dev mailing list: https://groups.google.com/forum/#!forum/pypa-dev
+.. _User IRC: https://webchat.freenode.net/?channels=%23pypa
+.. _Dev IRC: https://webchat.freenode.net/?channels=%23pypa-dev
+.. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/

news/5815.doc

@@ -0,0 +1 @@
+Re-write README and documentation index