Skip to content

Commit b3861c6

Browse files
committed
WIP README
1 parent 16860c9 commit b3861c6

File tree

3 files changed

+14
-19
lines changed

3 files changed

+14
-19
lines changed

README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11
# Pipeline Graph View Plugin
22

3+
[![Build Status](https://ci.jenkins.io/job/Plugins/job/pipeline-graph-view-plugin/job/main/badge/icon)](https://ci.jenkins.io/job/Plugins/job/pipeline-graph-view-plugin/job/main/)
4+
[![Gitter](https://badges.gitter.im/jenkinsci/ux-sig.svg)](https://gitter.im/jenkinsci/ux-sig?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
5+
[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/pipeline-graph-view.svg)](https://plugins.jenkins.io/pipeline-graph-view)
6+
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/pipeline-graph-view.svg?color=blue)](https://plugins.jenkins.io/pipeline-graph-view)
7+
8+
![preview.png](docs/images/preview.png)
9+
310
## Introduction
411

5-
This plugin provides new Action and View to view a `WorkflowRun` via the "Pipeline Graph" visualization that was popularized in the [Blue Ocean plugin](https://github.com/jenkinsci/blueocean-plugin).
12+
This plugin adds a visual representation of Jenkins pipelines, showing each stage of a run in a clear and easy-to-follow graph format. It’s designed to make pipeline progress and structure easier to understand at a glance.
613

714
## Getting started
815

9-
1. Install the `pipeline-graph-view` plugin
16+
1. Install the [pipeline-graph-view](https://plugins.jenkins.io/pipeline-graph-view/) plugin
1017
2. Go to a pipeline run (not a job page)
11-
3. Click 'Pipeline Overview'
18+
3. Click 'Pipeline Console'
1219

1320
## Screenshots
1421

15-
![Pipeline Graph link](docs/images/action.png)
16-
1722
Basic pipeline:
1823

1924
![Different statuses](./docs/images/different-statuses.png)
@@ -28,20 +33,10 @@ See a live demonstration from a Jenkins Contributor Summit:
2833

2934
[![Demo of Pipeline Graph View plugin](https://img.youtube.com/vi/MBI3MBY2eJ8/0.jpg)](https://www.youtube.com/watch?v=MBI3MBY2eJ8&t=3295 "Pipeline Graph View plugin")
3035

31-
## Vision
32-
33-
This plugin aims to bring the best of Blue Ocean into the regular Jenkins UI.
34-
35-
That means functionality like:
36-
37-
- [x] Pipeline graph
38-
- [x] Summary of runs in a job (like [Pipeline Stage View Plugin](https://github.com/jenkinsci/pipeline-stage-view-plugin/), but simpler, more modern and more performant)
39-
- [x] Modern logs viewing
40-
41-
The plugin should be lightweight, using or providing extension points where possible rather than building everything into one plugin.
42-
4336
## Contributing
4437

45-
Any help is much appreciated, the frontend code is written in React, the backend code is in Java, designers would be greatly appreciated as well.
38+
Refer to our [contribution guidelines](./CONTRIBUTING.md).
39+
40+
## LICENSE
4641

47-
Refer to our [contribution guidelines](./CONTRIBUTING.md)
42+
Licensed under MIT, see [LICENSE](LICENSE.md).

docs/images/action.png

-9.93 KB
Binary file not shown.

docs/images/preview.png

2.71 MB
Loading

0 commit comments

Comments
 (0)