Skip to content

Commit

Permalink
Deploy docs to gh-pages and fix link navigation in docs
Browse files Browse the repository at this point in the history
Signed-off-by: srikant <[email protected]>
  • Loading branch information
srikant-ch5 committed Feb 26, 2024
1 parent e9755ff commit 8e18c5c
Show file tree
Hide file tree
Showing 22 changed files with 138 additions and 135 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ build/Release
# Dependency directory
node_modules

# Site folder generated by mkdocs-deploy
site

config/app-local.json

/public/build/*
Expand Down
26 changes: 13 additions & 13 deletions docs/2.0-Common-Canvas-Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ Within common canvas the user can perform operations such as:

Common-canvas has these constituent parts that are visible to the user:

* [Canvas editor](/2.0.1-Canvas-Editor/) - the main area of the UI where the flow is displayed and edited
* [Palette](/2.0.2-Palette/) - a set of node templates that can be dragged to the canvas to create new nodes
* [Context menu](/2.0.3-Context-Menu/) - a menu of options for nodes, comments, etc
* [Context toolbar](/2.0.4-Context-Toolbar/) - a menu of options for nodes, comments, etc presented as a small toolbar
* [Canvas editor](2.0.1-Canvas-Editor.md) - the main area of the UI where the flow is displayed and edited
* [Palette](2.0.2-Palette.md) - a set of node templates that can be dragged to the canvas to create new nodes
* [Context menu](2.0.3-Context-Menu.md) - a menu of options for nodes, comments, etc
* [Context toolbar](2.0.4-Context-Toolbar.md) - a menu of options for nodes, comments, etc presented as a small toolbar
* Toolbar - a set of tools across the top of the UI
* Notification panel - a panel for displaying runtime and other messages to your user
* Right side flyout - a panel, often used to display node properties
Expand All @@ -40,7 +40,7 @@ and it handles:

## Canvas Controller

The only mandatory parameter for the `<CommonCanvas>` component is a regular JavaScript object called the [CanvasController](/2.4-Canvas-Controller-API/).
The only mandatory parameter for the `<CommonCanvas>` component is a regular JavaScript object called the [CanvasController](2.4-Canvas-Controller-API.md).

The CanvasController routes handles calls from the host application and actions performed by the user. It then updates the internal object model which stores:

Expand All @@ -51,7 +51,7 @@ The only mandatory parameter for the `<CommonCanvas>` component is a regular Jav
5. breadcrumbs that indicate which sub-flow is being viewed
6. layout information

The [CanvasController](/2.4-Canvas-Controller-API/) provides an API which allows your code to:
The [CanvasController](2.4-Canvas-Controller-API.md) provides an API which allows your code to:

1. set a new pipelineFlow;
2. get the current pipelineFlow (after the user has edited it);
Expand Down Expand Up @@ -128,7 +128,7 @@ Some examples of pipeline flow JSON files can be found here:
https://github.com/elyra-ai/canvas/tree/master/canvas_modules/harness/test_resources/diagrams

## Step 6 : Pull in the CSS
Check this section to find info on what CSS to include in your application's CSS. [Styling](./4.0-Styling.md).
Check this section to find info on what CSS to include in your application's CSS. [Styling](4.0-Styling.md).

## Step 7 : Display the canvas

Expand Down Expand Up @@ -182,11 +182,11 @@ If you want to customize the behavior of common canvas you can specify any combi
### Config objects
Common canvas has five **optional** configuration objects: config, toolbarConfig, notificationConfig, contextMenuConfig and keyboardConfig.
They are documented here:
[Config Objects](/2.1-Config-Objects)
[Config Objects](2.1-Config-Objects.md)

### Handlers
There are several **optional** handlers implemented as callback functions. They are contextMenuHandler, editActionHandler, beforeEditActionHandler, clickActionHandler, decorationActionHandler, layoutHandler, tipHandler, idGeneratorHandler, selectionChangeHandler and actionLabelHandler. They are documented here:
[Common Canvas Callback](/2.2-Common-Canvas-callbacks)
[Common Canvas Callback](2.2-Common-Canvas-callbacks.md)

### Right-flyout panel parameters
The right flyout panel appears on the right of the canvas area. You can add whatever content you like to this panel. Typically, it is used to display properties of nodes on the canvas. There are two **optional** parameters to let you manage the right flyout panel These are:
Expand All @@ -207,7 +207,7 @@ The top panel appears below the toolbar and between the palette and the right fl
- topPanelContent: content to display in the top panel which is a JSX object. Nothing is displayed by default.

### Localization
You can customize `<CommonCanvas>` using the `<IntlProvider>` object to [display translated test](/#localization)
You can customize `<CommonCanvas>` using the `<IntlProvider>` object to [display translated test](#localization)

## Creating nodes on the canvas

Expand All @@ -217,7 +217,7 @@ Nodes can be created on the canvas by the user in two ways:
* By dragging a node from outside the canvas

The first technique is provided by Common canvas. The second requires some development work which is documented here:
[Enabling node creation from external object](/2.3-Enabling-node-creation-from-external-object)
[Enabling node creation from external object](2.3-Enabling-node-creation-from-external-object.md)


## Keyboard support
Expand All @@ -236,6 +236,6 @@ Common canvas supports a number of keyboard interactions as follows:
|Ctrl/Cmnd + y|redo|Redo last undone command|


Your application can disable any or all of these actions by providing the [keyboard config object](/2.1-Config-Objects#keyboard-config-object) to the CommonCanvas react component.
Your application can disable any or all of these actions by providing the [keyboard config object](2.1-Config-Objects.md#keyboard-config-object) to the CommonCanvas react component.

When any of the shortcut keys are pressed the common-canvas object model will be updated and then the [editActionHandler](/2.2-Common-Canvas-callbacks#editactionhandler) callback will be called with the `data.editType` parameter set to the action above and the `data.editSource` parameter set to "keyboard".
When any of the shortcut keys are pressed the common-canvas object model will be updated and then the [editActionHandler](2.2-Common-Canvas-callbacks.md#editactionhandler) callback will be called with the `data.editType` parameter set to the action above and the `data.editSource` parameter set to "keyboard".
14 changes: 7 additions & 7 deletions docs/2.0.2-Palette.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ By default, common-canvas includes a palette which appears in the left flyout pa
## Populating the palette
The host application must tell common-canvas what node templates and categories it wants the user to see in the palette. This is done by providing common-canvas with a palette (JavaScript) object by calling the canvas-controller `setPipelineFlowPalette(palette)` method. The palette object is often read from a JSON document stored in the host application's repository or it can be automatically generated.

The palette object should conform to the [palette schema](https://github.com/elyra-ai/pipeline-schemas/blob/412d70176953ed9ac2e6a03f7135b09b7565fc5d/common-canvas/palette/palette-v3-schema.json). The host application can ensure that palette conforms to the schema by switching on [schema validation](/2.1-Config-Objects#schemavalidation) in the canvas configuration.
The palette object should conform to the [palette schema](https://github.com/elyra-ai/pipeline-schemas/blob/412d70176953ed9ac2e6a03f7135b09b7565fc5d/common-canvas/palette/palette-v3-schema.json). The host application can ensure that palette conforms to the schema by switching on [schema validation](2.1-Config-Objects.md#schemavalidation) in the canvas configuration.

## Auto-join
Instead of dragging node templates from the palette, the user can double click node templates to add, and automatically join, them to the current flow. When a node template is double clicked, common-canvas will look for the node at the end of the current flow of nodes and will add the node to the canvas to the right of the end node in the flow. Common-canvas will also automatically join the nodes together by creating a new link line.

## Palette configuration
There are a number of configuration options that control the palette that are specified in the canvas config object:

* [enablePaletteLayout](/2.1-Config-Objects#enablepalettelayout)
* [enableNarrowPalette](/2.1-Config-Objects#enablenarrowpalette)
* [enableAutoLinkOnlyFromSelNodes](/2.1-Config-Objects#enableautolinkonlyfromselnodes)
* Deprecated - [paletteInitialState](/2.1-Config-Objects#paletteinitialstate)
* [enablePaletteLayout](2.1-Config-Objects.md#enablepalettelayout)
* [enableNarrowPalette](2.1-Config-Objects.md#enablenarrowpalette)
* [enableAutoLinkOnlyFromSelNodes](2.1-Config-Objects.md#enableautolinkonlyfromselnodes)
* Deprecated - [paletteInitialState](2.1-Config-Objects.md#paletteinitialstate)

## Palette operation
The palette contents can be manipulated calling these canvas-controller [palette methods](/2.4-Canvas-Controller-API#palette-methods)
The palette contents can be manipulated calling these canvas-controller [palette methods](2.4-Canvas-Controller-API.md#palette-methods)

The palette can be opened and closed using these canvas-controller [operational methods](/2.4-Canvas-Controller-API#palette-methods-1)
The palette can be opened and closed using these canvas-controller [operational methods](2.4-Canvas-Controller-API.md#palette-methods-1)

## Search
The user can enter a search string into the Search field at the top of the palette. The behavior is as follows:
Expand Down
2 changes: 1 addition & 1 deletion docs/2.0.3-Context-Menu.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
A context menu is a small window containing a list of options applicable to an object or set of selected objects.

When [`enableContextToolbar`](/2.1-Config-Objects#enablecontexttoolbar) is set to `false` (or omitted) from the canvas config, and a right-click is performed on a node, link, comment or the canvas background, a traditional context menu is displayed like this:
When [`enableContextToolbar`](2.1-Config-Objects.md#enablecontexttoolbar) is set to `false` (or omitted) from the canvas config, and a right-click is performed on a node, link, comment or the canvas background, a traditional context menu is displayed like this:

<img width="373" alt="image" src="https://github.com/elyra-ai/canvas/assets/15114439/f3be8e93-6373-4f14-93f4-c389c0fe97a5">
2 changes: 1 addition & 1 deletion docs/2.0.4-Context-Toolbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Note: Since the mouse cursor can be hovered over a node, comment or link that is
If the mouse cursor is hovered over a selected object when there are other selected objects, the actions in the context toolbar will be applicable to all the selected objects. This is the same as how a traditional content menu shows actions that are applicable to the set of selected objects.


The context toolbar behavior can be switched on by setting the [`enableContextToolbar`](/2.1-Config-Objects#enablecontexttoolbar) canvas configuration field to true.
The context toolbar behavior can be switched on by setting the [`enableContextToolbar`](2.1-Config-Objects.md#enablecontexttoolbar) canvas configuration field to true.

```
const config = {
Expand Down
Loading

0 comments on commit 8e18c5c

Please sign in to comment.