Skip to content

Commit

Permalink
fix: Update documentation index file (#700)
Browse files Browse the repository at this point in the history
Signed-off-by: Mateus Oliveira <matews1943@gmail.com>

Signed-off-by: Mateus Oliveira <matews1943@gmail.com>
  • Loading branch information
mateusoliveira43 authored Nov 7, 2022
1 parent d5a5342 commit d1a2046
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,18 @@
![](https://github.com/redhat-cop/pelorus/workflows/Unit%20Tests/badge.svg)
![](https://github.com/redhat-cop/pelorus/workflows/Conftest/badge.svg)
![](https://github.com/redhat-cop/pelorus/workflows/Chart%20Lint/badge.svg)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

Pelorus is a tool that helps IT organizations measure their impact on the overall performance of their organization. It does this by gathering metrics about team and organizational behaviors over time in some key areas of IT that have been shown to impact the value they deliver to the organization as a whole. Some of the key outcomes Pelorus can focus on are:

- Software Delivery Performance
- Product Quality and Sustainability
- Customer experience

For more background on the project you can read @trevorquinn's blog post on [Metrics Driven Transformation](https://www.openshift.com/blog/exploring-a-metrics-driven-approach-to-transformation)
For more background on the project you can read [@trevorquinn](https://github.com/trevorquinn)'s blog post on [Metrics Driven Transformation](https://www.openshift.com/blog/exploring-a-metrics-driven-approach-to-transformation).

### Software Delivery Performance as an outcome
## Software Delivery Performance as an outcome

Currently, Pelorus functionality can capture proven metrics that measure Software Delivery Performance -- a significant outcome that IT organizations aim to deliver.

Expand All @@ -31,10 +33,13 @@ Pelorus documentation is available at [pelorus.readthedocs.io](https://pelorus.r

If you are interested in contributing to the Pelorus project, please review our Contribution guide which can be found in the [contribution guide](./CONTRIBUTING.md)


## Statement of Support

Our support policy can be found in the [Upstream Support statement](docs/UpstreamSupport.md)

## Code of Conduct
Refer to Konveyor's Code of Conduct [here](https://github.com/konveyor/community/blob/main/CODE_OF_CONDUCT.md).

## License

This repository is licensed under the terms of [Apache-2.0 License](LICENSE).
13 changes: 9 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
![Pelorus](img/Logo-Pelorus-A-Standard-RGB_smaller.png)

![](https://github.com/redhat-cop/pelorus/workflows/Pylama/badge.svg)
![](https://github.com/redhat-cop/pelorus/workflows/Unit%20Tests/badge.svg)
![](https://github.com/redhat-cop/pelorus/workflows/Conftest/badge.svg)
![](https://github.com/redhat-cop/pelorus/workflows/Chart%20Lint/badge.svg)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
![Python versions](https://img.shields.io/badge/Python-3.9%20|%203.10-success)

Pelorus is a tool that helps IT organizations measure their impact on the overall performance of their organization. It does this by gathering metrics about team and organizational behaviors over time in some key areas of IT that have been shown to impact the value they deliver to the organization as a whole. Some of the key outcomes Pelorus can focus on are:

Expand All @@ -12,18 +18,17 @@ Pelorus is a tool that helps IT organizations measure their impact on the overal

To understand the motivation, see [Our Philosophy](Philosophy.md).

For more background on the project you can read @trevorquinn's blog post on [Metrics Driven Transformation](https://www.openshift.com/blog/exploring-a-metrics-driven-approach-to-transformation).
For more background on the project you can read [@trevorquinn](https://github.com/trevorquinn)'s blog post on [Metrics Driven Transformation](https://www.openshift.com/blog/exploring-a-metrics-driven-approach-to-transformation).

## Software Delivery Performance as an outcome

Currently, Pelorus can capture proven metrics that measure Software Delivery Performance -- a significant outcome that IT organizations aim to deliver.
Currently, Pelorus functionality can capture proven metrics that measure Software Delivery Performance -- a significant outcome that IT organizations aim to deliver.

Pelorus is a Grafana dashboard that can easily be deployed to an OpenShift cluster, and provides an organizational-level view of the [four critical measures of software delivery performance](https://blog.openshift.com/exploring-a-metrics-driven-approach-to-transformation/).

![Software Delivery Metrics Dashboard](img/sdp-dashboard.png)

A short video describing each of these metrics is available [here](https://www.youtube.com/watch?v=7-iB_KhUaQg),
and you can learn more about each individual dashboard in the [dashboards documentation](Dashboards.md).
A short video describing each of these metrics is available [here](https://www.youtube.com/watch?v=7-iB_KhUaQg), and you can learn more about each individual dashboard in the [dashboards documentation](Dashboards.md).

## Prior Knowledge

Expand Down

0 comments on commit d1a2046

Please sign in to comment.