openstack
/
cloudkitty
Code Issues Proposed changes

Update README content 

Change-Id: Ib322726514d3d5f21af43fd889594afd06c0c84e
Story: 2004180
Task: 27668
This commit is contained in:
Pierre Riteau 2024-04-15 15:51:57 +02:00
parent b611e60954
commit 4ca61c05ab
1 changed files with 20 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.rst
View File

@ -10,13 +10,11 @@ Team and repository tags
==========
CloudKitty
==========
|doc-status|
.. image:: doc/source/images/cloudkitty-logo.png
:alt: cloudkitty
:align: center
Rating as a Service component
+++++++++++++++++++++++++++++
@ -36,15 +34,13 @@ address your particular use case.
You can find more information on its architecture in the documentation,
`architecture section`_.
Status
------
CloudKitty has been successfully deployed in production on different OpenStack
systems.
You can find the latest documentation on readthedocs_.
You can find the latest documentation on documentation_.
Contributing
------------
@ -57,7 +53,6 @@ OpenStack mailing list openstack-discuss@lists.openstack.org.
A storyboard_ is available if you need to report bugs.
Additional components
---------------------
@ -66,21 +61,17 @@ files in the cloudkitty-dashboard_ repository.
A CLI is available too in the python-cloudkittyclient_ repository.
Trying it
---------
CloudKitty can be deployed with devstack, more information can be found in the
CloudKitty can be deployed with DevStack, more information can be found in the
`devstack section`_ of the documentation.
Deploying it in production
--------------------------
CloudKitty can be deployed in production on OpenStack Kilo environments, for
more information check the `installation section`_ of the documentation. Due to
oslo libraries new namespace backward compatibility is not possible. If you
want to install it on an older system, use a virtualenv.
CloudKitty can be deployed in production on OpenStack environments, for
more information check the `installation section`_ of the documentation.
Getting release notes
---------------------
@ -88,33 +79,31 @@ Getting release notes
Release notes can be found in the `release notes section`_ of the
documentation.
Contributing to CloudKitty
--------------------------
For information on how to contribute to CloudKitty, please see the contents of
the CONTRIBUTING.rst.
Any new code must follow the development guidelines detailed in the HACKING.rst
file, and pass all unit tests.
.. Global references and images
.. |doc-status|
image:: https://readthedocs.org/projects/cloudkitty/badge/?version=latest
:target: https://cloudkitty.readthedocs.io/en/latest/
:alt: Documentation Status
.. _readthedocs: https://cloudkitty.readthedocs.io/en/latest/
.. _documentation: https://docs.openstack.org/cloudkitty/latest/
.. _storyboard: https://storyboard.openstack.org/#!/project/890
.. _python-cloudkittyclient: https://opendev.org/openstack/python-cloudkittyclient
.. _python-cloudkittyclient: https://github.com/openstack/python-cloudkittyclient
.. _cloudkitty-dashboard: https://opendev.org/openstack/cloudkitty-dashboard
.. _architecture section: https://docs.openstack.org/cloudkitty/latest/admin/architecture.html
.. _cloudkitty-dashboard: https://github.com/openstack/cloudkitty-dashboard
.. _devstack section: https://docs.openstack.org/cloudkitty/latest/admin/devstack.html
.. _architecture section: https://cloudkitty.readthedocs.io/en/latest/arch.html
.. _devstack section: https://cloudkitty.readthedocs.io/en/latest/devstack.html
.. _installation section: https://cloudkitty.readthedocs.io/en/latest/installation.html
.. _installation section: https://docs.openstack.org/cloudkitty/latest/admin/install/index.html
.. _release notes section: https://docs.openstack.org/releasenotes/cloudkitty/
.. _contributing: https://docs.openstack.org/cloudkitty/latest/contributor/contributing.html