openstack/vitrage
Code Issues Proposed changes
785d8f0167
vitrage/README.rst

25 lines
1.0 KiB
ReStructuredText
Raw Normal View History

Start README.rst with a better title Now that we are using gitea the contents of our README.rst are more prominently displayed. Starting it with a "Team and repository tags" title is a bit confusing. This change makes it start with the name of the project instead. While at it, make intro more user-friendly and point to CONTRIBUTING.rst instead of HACKING.rst for contributor guidance. Change-Id: I1a7044ea10b94cdb25dfcc05d3b2b77d877c1dd5
2019-11-20 15:24:35 +08:00
=================
OpenStack Vitrage
=================
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/241e2ef4630b9a285c84f4fb7a6164af Change-Id: I579d80209c9e56e2e90b53b1d23bf797b4d4a0fa
2016-11-25 11:05:27 +01:00
Update links in README Change the outdated links to the latest links in README Change-Id: I4c6f9d766a8d5914df789492f9d54ca4ccf24c8e
2018-03-28 11:10:08 +08:00
.. image:: https://governance.openstack.org/tc/badges/vitrage.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
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/241e2ef4630b9a285c84f4fb7a6164af Change-Id: I579d80209c9e56e2e90b53b1d23bf797b4d4a0fa
2016-11-25 11:05:27 +01:00
.. Change things from this point on
Start README.rst with a better title Now that we are using gitea the contents of our README.rst are more prominently displayed. Starting it with a "Team and repository tags" title is a bit confusing. This change makes it start with the name of the project instead. While at it, make intro more user-friendly and point to CONTRIBUTING.rst instead of HACKING.rst for contributor guidance. Change-Id: I1a7044ea10b94cdb25dfcc05d3b2b77d877c1dd5
2019-11-20 15:24:35 +08:00
OpenStack Vitrage is the OpenStack RCA (Root Cause Analysis) Service for organizing, analyzing and expanding OpenStack alarms & events, yielding insights regarding the root cause of problems and deducing the existence of problems before they are directly detected.
Add Vitrage project initial file Change-Id: If3b03c8a9aff64e140d8068403d006e804004466
2015-09-30 23:10:46 +03:00
add link to devstack installation Change-Id: Ica38fdb03044e65885c6e43a1f002e8d575933a1
2016-03-22 17:20:57 +02:00
Enabling Vitrage in DevStack
----------------------------
Beautify, correct URLs in documentation files - Beautify, re-indent, format code in a lot of doc files - Use relative URLs instead of absolute github URLs - Some absolute github urls are not corrected yet: + URL for enabling vitrage in devstack + URL for enabling vitrage in horizon - Update year number in doc/source/config.py from 2013 to 2016 My thought: We should have a blueprint to create more concise and easy to access like other project (nova: http://docs.openstack.org/developer/nova/). Currently, that site for vitrage has not existed yet. Notes: Change github URLs to relative URLs (or absolute URLs in docs.openstack.org/developers) will not work correctly if we do not have official documentation site. Hence, other people cannot follow the link to html page if they read vitrage documentation in github mirror. Change-Id: Ifff8355c7e5291f68a7592d1617644053d790d5e
2016-10-21 13:35:41 +07:00
More details in: `README file <devstack/README.rst>`_
add link to devstack installation Change-Id: Ica38fdb03044e65885c6e43a1f002e8d575933a1
2016-03-22 17:20:57 +02:00
fixed readme file Change-Id: Id67f23a860cefd1f574ce63d3b63f7ce55457325
2016-01-21 14:53:00 +00:00
Project Resources
-----------------
Add Vitrage project initial file Change-Id: If3b03c8a9aff64e140d8068403d006e804004466
2015-09-30 23:10:46 +03:00
Add project documentation link to README.rst Change-Id: Ic828f2095db43daf545a0e17d89c0658fcdb9739
2019-04-05 16:40:39 +03:00
* Project documentation: https://docs.openstack.org/vitrage/latest/
Beautify, correct URLs in documentation files - Beautify, re-indent, format code in a lot of doc files - Use relative URLs instead of absolute github URLs - Some absolute github urls are not corrected yet: + URL for enabling vitrage in devstack + URL for enabling vitrage in horizon - Update year number in doc/source/config.py from 2013 to 2016 My thought: We should have a blueprint to create more concise and easy to access like other project (nova: http://docs.openstack.org/developer/nova/). Currently, that site for vitrage has not existed yet. Notes: Change github URLs to relative URLs (or absolute URLs in docs.openstack.org/developers) will not work correctly if we do not have official documentation site. Hence, other people cannot follow the link to html page if they read vitrage documentation in github mirror. Change-Id: Ifff8355c7e5291f68a7592d1617644053d790d5e
2016-10-21 13:35:41 +07:00
* Wiki page: https://wiki.openstack.org/wiki/Vitrage
Replace git.openstack.org URLs with opendev.org URLs Change-Id: If820cd3866818f7283d8aa9559257166e0627cc5
2019-04-23 17:06:14 +08:00
* Source: https://opendev.org/openstack/vitrage
Add storyboard link into README.rst Change-Id: I7cbcd38a6e5db3fcc48b778b61d2a0136b75c00b
2018-08-27 09:54:04 -04:00
* StoryBoard: https://storyboard.openstack.org/#!/project/openstack/vitrage
Add release notes link to README Change-Id: Ib363a9e11d6833628dc8e3a7b33f3d2af78169f9
2018-06-12 15:05:18 +08:00
* Release notes: https://docs.openstack.org/releasenotes/vitrage
Add vitrage-specs link to readme.rst Change-Id: I899a8be96f7a4f9536a3418d028da12459a0ffcf
2019-08-30 16:46:22 +08:00
* Design specifications: https://specs.openstack.org/openstack/vitrage-specs/
Copy Permalink