Commit Graph

43 Commits

Author SHA1 Message Date
Dr. Jens Harbott 692ee752b6 Update from storyboard to launchpad pt. 2
This was missed in [0]. Also update the mailing list link after it moved
to mailman3.

[0] Iaf93c892d211fd7465395d8830f56c2977a88f8b

Change-Id: I91168713a854be0c4348bab3fa34f4b1a924f451
2023-10-31 10:19:43 +01:00
Ghanshyam Mann 4891bb3820 Moving IRC network reference to OFTC
Change-Id: I11e00f18fa8dca02bc0f136c0c5e9a2f040eef8f
2021-07-07 19:43:00 -05:00
pedro d688cb58a3 Add documentation about login with federation
The documentation presents the parameters necessary
to authenticate via federation (using password) and do
a brief description of each parameter used in the process.

Change-Id: Iae3b6d0b56ebd2bbbb94f9f3637b5086e75559a7
2020-12-02 08:42:39 -03:00
Eric Fried d0bfef807d Doc: launchpad => storyboard
A few docs still referred to launchpad, which osc hasn't used in a
couple of years. Cut over to storyboard.

Change-Id: Ic9abf0fe1e52c255976bd7a019e999a8e610455e
2019-10-22 15:13:40 -05:00
Dean Troyer cb0c20b23c Update release table for Train and 4.0.0
Also clean up some docs and release notes.

Change-Id: I73feec747ca1bd12be5e5700c9ca608ed3a8b2c2
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2019-09-10 23:48:32 -05:00
Dean Troyer 0f56b7d074 Followup opendev cleanup and test jobs
* upper-constraints references need s/plain/raw/

Change-Id: I04368dc42f1a62a048ac9d11497747ef6f600515
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2019-04-19 23:47:02 -05:00
wu.chunyang ddcc25e7f3 Add release note link in README
Change-Id: I53896535dc369a499a6850b71d23feff9350e557
2018-06-28 13:27:55 +08:00
Chen f904efb037 Fix urls in README.rst
1. bug tracking has been moved to storyboard
2. syntax issues
3. remove PyPI downloads since it is no longer maintained
https://packaging.python.org/guides/analyzing-pypi-package-downloads/

Change-Id: Ic57c7032af0296d666841021c19e6e56f0b3e89a
2018-06-07 22:53:00 +08:00
Tovin Seven 5a9fc91830 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I61f3d53737616dbbd6df725823b5335a57045dba
2018-04-20 17:23:30 +07:00
melissaml 5a5281e755 Update links in README
Change the outdated links to the latest links in README

Change-Id: I94c781866c8b65e84708dd9f951f023a5e2913b1
2018-03-02 18:13:24 +08:00
Jenkins d010c00a15 Merge "Update the documentation link for doc migration" 2017-07-27 13:48:04 +00:00
Jenkins 08ffd854e8 Merge "Use identity auth v3 the README examples" 2017-07-25 17:27:32 +00:00
Hangdong Zhang 37998ad1c2 Update the documentation link for doc migration
Change-Id: I7833e40d66abe233af5a211bcefadc141fe8e54b
2017-07-24 11:33:07 +08:00
Samuel de Medeiros Queiroz 6eb1551573 Use identity auth v3 the README examples
Identity auth v3 is the default in devstack. The keystone team
advertises all deployments to migrate over to v3.

If we get our examples to use v3, that would be a great help.

Change-Id: I8bd4cbf16cd42fa1654776f19bf113e3c94e25cf
2017-06-25 15:46:24 -04:00
Doug Hellmann 0ddda620dc update the docs URLs in the readme
Change-Id: Id1168e1003f62e08d2da338cb1b81bc2b7547bfc
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 11:57:39 +02:00
Flavio Percoco 1f8485b94f Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/30af7c8ad287756d38d131d1f5dceae0

Change-Id: I2d906fa0675463e21f2786d93f464c465f2bc3b1
2016-11-26 12:05:49 +01:00
Ryan Selden cde07464b5 Added a note on how to test changes
It's confusing for new contributors to test the client.
Added a quick note to the README explaining how to do so.

Change-Id: I2a185f04bbec7ab01fdd2ab436a5f413f33819e7
2016-07-07 16:11:54 +00:00
Ankur Gupta 61a60ef926 Add Testing Ref in README.rst
Add a reference in the README directed to docs page for testing
within python-openstackclient. Avoid creating TESTING.rst due to
unneeded duplication. Updated Developer URL to correct one.

Change-Id: I40b4c949d155aea6e0e25ecd4a88797481a4d8ac
2016-04-11 11:12:37 -05:00
Xi Yang 54b0ef3358 Use Block Storage instead of Volume
Volume is better to be replaced by Block Storage in the
doc.

Change-Id: I736669ee01c7385b6e701cb20f4334eff1c49286
2015-11-27 17:56:10 +08:00
Steve Martinelli e52dfce7bd Add shields.io version/downloads links/badges into README.rst
it's handy to have appear in the pypi page

Change-Id: I142da7d194d719f3b8218ad84e32e19bf0071c63
2015-09-25 00:01:49 -04:00
Monty Taylor 4afd308a4f Include links to developer workflow documentation
Newcomers aren't always sure how to get started with our tools or
workflow. Lucky for them, we have documented these things. Unlucky for
them, they have no idea the docs exist.

Give them some links.

Change-Id: I6fce6fbccb8a9fe16b48845790b4cac05317ebac
2015-06-08 11:43:24 -04:00
Dean Troyer 649dbf1ede Update README
Re-orient README toward end-users

Change-Id: I4623832dde72a7ae0eeadf09429402521771dd35
2015-03-09 15:49:44 -05:00
Steve Martinelli 75e8490e54 Cleanup README.rst
There are two harmless typos in the README.rst
'OpenStackclient' => 'OpenStack Client'
'python-*client' => the '*' is being interpreted as a link

Change-Id: Ie813e220c3c150f46edb2c93f94e8bb78bdb0013
Closes-Bug: #1350518
2014-07-31 00:53:36 -04:00
Alex Gaynor b8f534df01 Remove keyring support from openstackclient
* The encryption it purports to offer is completely insecure.
* It also appears to be broken.

Closes-Bug: #1319381
Change-Id: Id15ecfbbfd15f142b14c125bfd85afd5032699ac
2014-07-04 01:56:18 +00:00
Alex Gaynor a8087a6c8b Fixed several typos throughout the codebase
Change-Id: I048ee857fc1215fea7f60978364894e1b5abdf66
2014-05-21 07:47:52 -07:00
Alex Holden 00188f092c Fixed spelling error, compatability to compatibility
Change-Id: I72c1254666a741ffe1070cf8275af889fa323f52
2014-03-07 09:40:29 -08:00
Dean Troyer 038269cf7f Update release notes for 0.3.1
* update README
* update man page
* fix doc errors

Change-Id: I5682654bf482289879c8ba9016e348f2b2782971
2014-02-27 17:36:28 -06:00
Terry Howe 202c3e375b Closes-Bug: #1262322 Make links clickable
Change-Id: I61302ff5274cdaa09801cb9b0dc9bfd353ac687f
2013-12-25 09:41:17 -07:00
Jenkins 0cc5811122 Merge "Prep for 0.2 release (0.2.rc1)" 2013-08-01 22:51:30 +00:00
Dean Troyer 6f9dcc13f6 Prep for 0.2 release (0.2.rc1)
* rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file
* add the barest of pointers to the wiki, etc. to the source docs
* add a bare-bones man page

Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe
2013-08-01 16:21:22 -05:00
Dean Troyer 0aa3c206a3 Remove tenant round 1 - global options
Change the global auth options to use 'project', leave the original
tenant options in place but silent for compatability with the existing
project CLI auth options.  This is the only compatibility for tenant
usage in this changeover.

Change-Id: I3cce6e552f18822cc9f445ec5f301b0f5d9003f8
2013-07-31 10:07:50 -05:00
Josh Kearney 37b75a10c2 Updated README to reflect latest changes.
Change-Id: I996d5c0ec6e480fcbdc546bad238eee2e20504d6
2013-01-29 15:12:39 -06:00
Josh Kearney c1ea298904 Clean up test environment and remove unused imports.
First round of adding more complete unit test coverage.

Change-Id: Ic1979c499ca6fcb784892a95954a3527539c4e53
2013-01-22 11:44:18 -06:00
Bhuvan Arumugam 8010e773ac Document the use of keyring.
* README.rst
  Document the option --os-use-keyring, and environment variable
  OS_USE_KEYRING, to enable keyring.

Change-Id: I54ceb2d2692fecca328da16f6ed14db8d09a6eb7
2012-08-22 15:57:59 -07:00
Dolph Mathews 540c4883d6 Secure password prompt (docs)
Change-Id: I879a8aba13318f1dd660a487cbd1fd20c7ae659b
2012-07-13 14:54:27 -05:00
Clark Boylan 77e5ce57fd Move docs to doc.
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc/source and build results go in project/doc/build.

Change-Id: I925e687254bac9e06c2c520f4fc35a083e21c4ca
2012-06-11 14:37:48 -07:00
Matt Joyce 64f685ad63 minor fixes
Change-Id: Ib5601e1a932e0bfaa0341909416415d1e81ee915
2012-05-29 14:31:00 -07:00
Lorin Hochstein 14ffd1c1df Documented python setup.py develop
Change-Id: Ic17f17e6c80f54a633676b7e17a899748038f8d6
2012-05-21 12:39:35 -04:00
Lorin Hochstein fad694e428 Added :: to readme.rst to format correctly.
Also zapped a trailing bit of whitespace

Change-Id: I49d0306c0e73f096d091c27ba54705d9dbe9c0ca
2012-05-16 13:05:48 -04:00
Lorin Hochstein e1afa4c7cc Document how to install the client
This documents a workaround for bug 993390.

Change-Id: I6d930aa9ad142096cdc2790df4be31f0b1570199
2012-05-16 12:02:18 -04:00
Matt Joyce 25051a733d Updating Readme Document
Change-Id: I0c0f5c86b0bfa96ab4d7236eb2e7e7efab6fbac0
2012-05-14 17:01:46 -07:00
Dean Troyer 2f2191b9ed Add token auth to shell and README 2012-04-27 11:49:15 -05:00
Dean Troyer f4b5ef39f6 First commit 2012-04-18 13:16:39 -05:00