Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace CircleCI badge in readme with GitHub actions #2124

Merged
merged 2 commits into from
Oct 3, 2024
Merged

Replace CircleCI badge in readme with GitHub actions #2124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e63142c
Replace CircleCI badge in readme with GitHub actions
tynandebold Oct 2, 2024
7d953cc
Update the other readme file
tynandebold Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 24 additions & 25 deletions README.npm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

<br />

[![CircleCI](https://circleci.com/gh/kedro-org/kedro-viz/tree/main.svg?style=shield)](https://circleci.com/gh/kedro-org/kedro-viz/tree/main)
[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/kedro-org/kedro-viz/merge-gatekeeper.yml?label=Actions&logo=github)](https://github.com/kedro-org/kedro-viz/actions)
[![Documentation](https://readthedocs.org/projects/kedro/badge/?version=stable)](https://docs.kedro.org/en/stable/visualisation/)
[![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-orange.svg)](https://pypi.org/project/kedro-viz/)
[![PyPI version](https://img.shields.io/pypi/v/kedro-viz.svg?color=yellow)](https://pypi.org/project/kedro-viz/)
Expand Down Expand Up @@ -67,7 +67,7 @@
options={/* Options to configure Kedro Viz */}
/>
</div>
);
);
```

To use with NextJS:
Expand All @@ -89,7 +89,7 @@
kedro viz run --save-file=<path-to-save-kedro-viz-data-to-a-directory>
```

On successful execution of the command above, it will generate a folder at the specified directory, containing the following structure:
On successful execution of the command above, it will generate a folder at the specified directory, containing the following structure:

```
<filename>/api/
Expand All @@ -116,7 +116,7 @@

## Configure Kedro-viz with `options`

The example below demonstrates how to configure your kedro-viz using different `options`.
The example below demonstrates how to configure your kedro-viz using different `options`.

```
<KedroViz
Expand All @@ -131,7 +131,7 @@
metadataPanel: true,
miniMap: true,
sidebar: true,
zoomToolbar: true,
zoomToolbar: true,
},
expandAllPipelines: false,
nodeType: {
Expand All @@ -146,35 +146,34 @@

```

| Name | Type | Default | Description |
| ------------ | ------- | ------- | ----------- |
| `data` | `{ edges: array (required), layers: array, nodes: array (required), tags: array }` | - | Pipeline data to be displayed on the chart |
| `onActionCallback` | function | - | Callback function to be invoked when the specified action is dispatched. e.g. `const action = { type: NODE_CLICK, payload: node }; onActionCallback(action);` |
| options.display | | | |
| `expandPipelinesBtn` | boolean | true | Show/Hide expand pipelines button |
| `exportBtn` | boolean | true | Show/Hide export button |
| `globalNavigation` | boolean | true | Show/Hide global navigation |
| `labelBtn` | boolean | true | Show/Hide label button |
| `layerBtn` | boolean | true | Show/Hide layer button |
| `metadataPanel` | boolean | true | Show/Hide Metadata Panel |
| `miniMap` | boolean | true | Show/Hide Mini map and mini map button |
| `sidebar` | boolean | true | Show/Hide Sidebar and action toolbar |
| `zoomToolbar` | boolean | true | Show/Hide zoom-in, zoom-out and zoom reset buttons together |
| options.expandAllPipelines | boolean | false | Expand/Collapse Modular pipelines on first load |
| options.nodeType | `{disabled: {parameters: boolean,task: boolean,data: boolean}}` | `{disabled: {parameters: true,task: false,data: false}}` | Configuration for node type options |
| options.tag | `{enabled: {<tagName>: boolean}}` | - | Configuration for tag options |
| options.theme | string | dark | select `Kedro-Viz` theme : dark/light |

| Name | Type | Default | Description |
| -------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data` | `{ edges: array (required), layers: array, nodes: array (required), tags: array }` | - | Pipeline data to be displayed on the chart |
| `onActionCallback` | function | - | Callback function to be invoked when the specified action is dispatched. e.g. `const action = { type: NODE_CLICK, payload: node }; onActionCallback(action);` |

Check warning on line 152 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L152 

[Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
Raw output 
{"message": "[Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.", "location": {"path": "README.npm.md", "range": {"start": {"line": 152, "column": 249}}}, "severity": "WARNING"}
| options.display | | | |
| `expandPipelinesBtn` | boolean | true | Show/Hide expand pipelines button |

Check warning on line 154 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L154 

[Kedro-viz.Spellings] Did you really mean 'boolean'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'boolean'?", "location": {"path": "README.npm.md", "range": {"start": {"line": 154, "column": 32}}}, "severity": "WARNING"}
| `exportBtn` | boolean | true | Show/Hide export button |

Check warning on line 155 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L155 

[Kedro-viz.Spellings] Did you really mean 'boolean'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'boolean'?", "location": {"path": "README.npm.md", "range": {"start": {"line": 155, "column": 32}}}, "severity": "WARNING"}
| `globalNavigation` | boolean | true | Show/Hide global navigation |

Check warning on line 156 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L156 

[Kedro-viz.Spellings] Did you really mean 'boolean'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'boolean'?", "location": {"path": "README.npm.md", "range": {"start": {"line": 156, "column": 32}}}, "severity": "WARNING"}
| `labelBtn` | boolean | true | Show/Hide label button |

Check warning on line 157 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L157 

[Kedro-viz.Spellings] Did you really mean 'boolean'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'boolean'?", "location": {"path": "README.npm.md", "range": {"start": {"line": 157, "column": 32}}}, "severity": "WARNING"}
| `layerBtn` | boolean | true | Show/Hide layer button |

Check warning on line 158 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L158 

[Kedro-viz.Spellings] Did you really mean 'boolean'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'boolean'?", "location": {"path": "README.npm.md", "range": {"start": {"line": 158, "column": 32}}}, "severity": "WARNING"}
| `metadataPanel` | boolean | true | Show/Hide Metadata Panel |

Check warning on line 159 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L159 

[Kedro-viz.Spellings] Did you really mean 'boolean'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'boolean'?", "location": {"path": "README.npm.md", "range": {"start": {"line": 159, "column": 32}}}, "severity": "WARNING"}
| `miniMap` | boolean | true | Show/Hide Mini map and mini map button |

Check warning on line 160 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L160 

[Kedro-viz.Spellings] Did you really mean 'boolean'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'boolean'?", "location": {"path": "README.npm.md", "range": {"start": {"line": 160, "column": 32}}}, "severity": "WARNING"}
| `sidebar` | boolean | true | Show/Hide Sidebar and action toolbar |

Check warning on line 161 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L161 

[Kedro-viz.Spellings] Did you really mean 'boolean'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'boolean'?", "location": {"path": "README.npm.md", "range": {"start": {"line": 161, "column": 32}}}, "severity": "WARNING"}
| `zoomToolbar` | boolean | true | Show/Hide zoom-in, zoom-out and zoom reset buttons together |

Check warning on line 162 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L162 

[Kedro-viz.Spellings] Did you really mean 'boolean'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'boolean'?", "location": {"path": "README.npm.md", "range": {"start": {"line": 162, "column": 32}}}, "severity": "WARNING"}
| options.expandAllPipelines | boolean | false | Expand/Collapse Modular pipelines on first load |

Check warning on line 163 in README.npm.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.npm.md#L163 

[Kedro-viz.Spellings] Did you really mean 'boolean'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'boolean'?", "location": {"path": "README.npm.md", "range": {"start": {"line": 163, "column": 32}}}, "severity": "WARNING"}
| options.nodeType | `{disabled: {parameters: boolean,task: boolean,data: boolean}}` | `{disabled: {parameters: true,task: false,data: false}}` | Configuration for node type options |
| options.tag | `{enabled: {<tagName>: boolean}}` | - | Configuration for tag options |
| options.theme | string | dark | select `Kedro-Viz` theme : dark/light |

### Note

- `onActionCallback` callback is only called when the user clicks on a node in the flowchart, and we are passing the node object as the payload in the callback argument. In future releases, we will add more actions to be dispatched in this callback.
- When `display.sidebar` is `false`, `display.miniMap` prop will be ignored.

All components are annotated to understand their positions in the Kedro-Viz UI.

![Kedro-Viz component annotation](https://raw.githubusercontent.com/kedro-org/kedro-viz/main/.github/img/kedro_viz_annotation.png)


## Standalone Example Repository

We have created a [kedro-viz-standalone](https://github.com/kedro-org/kedro-viz-standalone.git) repository to demonstrate how to use Kedro-Viz in standalone mode or embedded in a React application.
Expand Down
2 changes: 1 addition & 1 deletion package/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Live Demo: <a href="https://demo.kedro.org/" target="_blank">https://demo.kedro.

<br />

[![CircleCI](https://circleci.com/gh/kedro-org/kedro-viz/tree/main.svg?style=shield)](https://circleci.com/gh/kedro-org/kedro-viz/tree/main)
[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/kedro-org/kedro-viz/merge-gatekeeper.yml?label=Actions&logo=github)](https://github.com/kedro-org/kedro-viz/actions)
[![Documentation](https://readthedocs.org/projects/kedro/badge/?version=stable)](https://docs.kedro.org/en/stable/visualisation/)
[![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-orange.svg)](https://pypi.org/project/kedro-viz/)
[![PyPI version](https://img.shields.io/pypi/v/kedro-viz.svg?color=yellow)](https://pypi.org/project/kedro-viz/)
Expand Down
Loading