elyra/canvas

Overview

The Elyra Canvas tooling consists of two Node JS modules:

1. A Common Canvas for use in building canvas-like applications. See detailed API and event documentation.

2. Test harness See here for setting up local environment

Documentation

• Elyra canvas documentation - https://elyra-ai.github.io/canvas/
• Elyra canvas playground (Test harness) - https://ibm.biz/elyra-canvas-test-harness

Using local version of common-canvas and/or common-properties

Clone elyra/canvas

# Clone the repo
git clone git@github.com:elyra-ai/canvas.git

# Install global libraries for building
npm install -g grunt-cli sass

# Build common-canvas and common-properties
./<elyra/canvas>/canvas_modules/common-canvas/build.sh

In your application's package.json replace

"@elyra/canvas": "<version>"

with

"@elyra/canvas": "file:<elyra/canvas>/canvas_modules/common-canvas"

Delete @elyra/canvas from node_modules of your application

# Run npm install to get local copy of common-canvas and/or common-properties
npm install

Contribute to the Elyra Canvas documentation (mkdocs)

1. Python v3 needs to be available.

2. Go to canvas/docs directory.

3. Install required mkdocs packages using pip3.

pip3 install -r requirements.txt
pip3 install mike

4. Run below commands to use mike to deploy multiple versions of docs.

# Initially delete everything from gh-pages branch to start creating version folders.
mike delete --all 

# If above command throws an error please run below mkdocs command and then run mike deploy
mkdocs gh-deploy --force

# This command will create a folder named as v13 in gh-pages branch.
mike deploy --push --update-aliases v13 latest
mike set-default v13


# Test changes in local.
mike serve

# If you are working on Elyra Canvas documentation content, you should run the following command, instead of the mike serve command, to see your changes immediately reflected in the browser.
mkdocs serve

5. When complete, open the browser: http://127.0.0.1:8000/