Commit Graph

19 Commits

Author SHA1 Message Date
Jeremy Stanley 175fad9af9 Add Release Notes to documentation
We're building the sdist to be able to add PBR's changelog in its
docs, so may as well publish the Release Notes document it builds
too.

Change-Id: Icd1b4ae04de8034bc15db87be457751e70e26f6d
2020-08-11 21:20:17 +00:00
Jeremy Stanley 5fdbae5952 Re-add ChangeLog
One of PBR's features is ChangeLog generation, so it only makes
sense that we would include PBR's ChangeLog in published
documentation too. (Also publishing a ChangeLog is helpful.)

Change-Id: Ie1561c0852dfc6731c29e9202f74f0e4c4b08786
2020-08-06 13:10:36 +00:00
Antoine Musso 07b6ac85e6 Update some url to use opendev.org
The git web URL is now: https://opendev.org/openstack/pbr

Also stop linking README.rst to no more existing history/changelog
documentation page (removed by 96b84a9014).

Change-Id: I56b0e2b86a7fc66c5ae25e06175033a885f500f6
2020-08-06 15:09:50 +02:00
ChangBo Guo(gcb) 4fc2518539 Update URLs in documents according to document migration
Change-Id: I8018f0cc0b0f7642d9e0e65f14c9c8a8315b55b9
2017-07-13 12:16:24 +08:00
Doug Hellmann 16a0a98daa add changelog to published documentation
Include the ChangeLog content in the published documentation to make it
possible to read without downloading the source. Add a link to the new
page to the readme for discoverability.

Change-Id: I3cc06846b6d84f5b175a33a48838c8a6a5e1771d
Closes-Bug: #1681725
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-04-11 09:43:27 -04:00
Davanum Srinivas 65f83aef83 Add shields.io version/downloads links/badges into README.rst
Change-Id: Ia4bc4198e47769aadc33ed791907f098088fa405
2015-09-24 20:49:31 -04:00
Doug Hellmann 0a92e4d0dc Update README format to match release notes tool
The Oslo release notes script expects to find the bug tracker link in a
particular format. Update the end of the the README to match those
expectations.

Change-Id: I55e1ef68683e8003624b715e98fef0bc4202df64
2015-01-27 14:39:00 -05:00
Doug Hellmann 19848e6cf1 Clean up links and docs
Move some developer information for running tests out of the README to
the documentation.

Change the home page link to point to the launchpad page.

Add a link to the bug tracker to the README.

Change-Id: I29bdb071eb64bccc561844c130a256b8f998da5f
Closes-Bug: #1318548
2014-10-08 16:49:59 -04:00
Marc Abramowitz 5a560fa135 README.rst: tweaks
Change-Id: Iadb60bd8422734a0eb252d30accd513a49032fd3
2014-04-20 11:56:20 -07:00
Alex Gaynor 3287d9d82f Link to the documentation in the readme
Change-Id: Ib4ddd8bcb749e21615c856026d10df16be3923f9
2013-11-09 14:42:43 -08:00
Monty Taylor 904f79c867 Add more documentation
Moved a good portion of README into the sphinx docs. Also started
fleshing out descriptions of how to use things. Also, fix the sphinx
config.

Change-Id: If53dcdaea0a48ef613e3097ab55d34f056160188
2013-07-21 19:54:39 -07:00
Monty Taylor c84876dc0f Remove the need to specify the pbr hook
If you're running pbr codepaths, you want the hook. There is no need
to say "pbr=True" in setup.py and then to list the hook in setup.cfg
now that d2to1 is in the tree.

Change-Id: Ie33d3e08d5a4133f5caf2613859919ce4f02c4a0
2013-07-21 11:41:34 -07:00
Monty Taylor 746b78d637 Clean up hacking and path issues with d2to1
We imported in another code base. It takes a little bit of path
adjusting to get things right.

Change-Id: Ifb96652c822d5d243a6bedb77bc34e919be2d3a8
2013-07-11 15:02:12 -04:00
Monty Taylor 1d3422fefd Update documentation for release.
Change-Id: I215bfa00a836c7fafb535b78e6fef89c81e28817
2013-03-17 23:51:59 -07:00
Monty Taylor e8af43a318 Rename back to PBR.
Change-Id: I13ee7fab7858231b0fa17f9116176a09184e8b0e
2013-03-17 23:27:50 -07:00
Monty Taylor 24f7985ac5 Amended README testing instructions.
Change-Id: I0988fa318da381a2621f94c355459bf1550f57f7
2013-03-12 11:40:14 -04:00
Monty Taylor f208b1937e Update README with test running instructions.
Change-Id: I772b8fda5abdd07bc212a5fc7358e4b712425cd2
2013-03-12 11:38:10 -04:00
Monty Taylor 85e5c4f846 Update docs.
Change-Id: Ie10b07c44fe8fc5131bfe0691e2bd4db0623a720
2013-03-11 18:19:56 -04:00
Monty Taylor aa4641f0e6 Split out oslo.packaging.
Include logic taken from d2to1 to allow us to inject into setup.py. Combined
with ols openstack/common/setup.py code.

Change-Id: I27b341403bb8245e38f8e3c386f1a835b90b1843
2013-03-10 18:02:43 -04:00