diff options
author | Pradyun Gedam <pradyunsg@gmail.com> | 2019-06-12 03:29:06 +0530 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-06-12 03:29:06 +0530 |
commit | 781a0f9a7ab3724fa1abf6dac1b007fccc56063e (patch) | |
tree | 74301ea63530ed08536ff456aebe950ff6415623 | |
parent | 53d57a2accf994dccb5aee563368fa2ac8f55fa2 (diff) | |
download | pip-781a0f9a7ab3724fa1abf6dac1b007fccc56063e.tar.gz |
Better surface release details in README pradyunsg-release-details
* pip is spelt with a lower-case 'p'
* Avoid specifying release cadence in README so that we have a single point of truth
* Merge release related items into a single list
* Place this immediately after "install-and-use" section of the README
* Fix the syntax of the link (this is rst, not md)
* Update link to the hosted, built sphinx documentation instead of sources
-rw-r--r-- | README.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/README.rst b/README.rst index 6ab637d70..960985ea2 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,11 @@ Please take a look at our documentation for how to install and use pip: * `Installation`_ * `Usage`_ + +Updates are released regularly and more details on them can be found in our documentation: + * `Release notes`_ +* `Release process`_ If you find bugs, need help, or want to talk to the developers please use our mailing lists or chat rooms: @@ -28,10 +32,6 @@ If you want to get involved head over to GitHub to get the source code, look at * `Dev mailing list`_ * `Dev IRC`_ -Pip usually comes installed with Python, and updates are released regularly, with new versions every 3 months. Please take a look at our documentation. - -* [Pip release](https://github.com/pypa/pip/blob/master/docs/html/development/release-process.rst). - Code of Conduct --------------- @@ -43,6 +43,7 @@ rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_. .. _Installation: https://pip.pypa.io/en/stable/installing.html .. _Usage: https://pip.pypa.io/en/stable/ .. _Release notes: https://pip.pypa.io/en/stable/news.html +.. _Release process: https://pip.pypa.io/en/latest/development/release-process/ .. _GitHub page: https://github.com/pypa/pip .. _Dev documentation: https://pip.pypa.io/en/latest/development .. _Issue tracking: https://github.com/pypa/pip/issues |