Elyra Canvas Documentation using mkdocs #1702

srikant-ch5 · 2024-02-19T14:56:16Z

Developer's Certificate of Origin 1.1

   By making a contribution to this project, I certify that:

   (a) The contribution was created in whole or in part by me and I
       have the right to submit it under the Apache License 2.0; or

   (b) The contribution is based upon previous work that, to the best
       of my knowledge, is covered under an appropriate open source
       license and I have the right under that license to submit that
       work with modifications, whether created in whole or in part
       by me, under the same open source license (unless I am
       permitted to submit under a different license), as indicated
       in the file; or

   (c) The contribution was provided directly to me by some other
       person who certified (a), (b) or (c) and I have not modified
       it.

   (d) I understand and agree that this project and the contribution
       are public and that a record of the contribution (including all
       personal information I submit with it, including my sign-off) is
       maintained indefinitely and may be redistributed consistent with
       this project or the open source license(s) involved.

Signed-off-by: Paul-Kawalkowski <[email protected]>

Signed-off-by: srikant <[email protected]>

srikant-ch5 · 2024-02-19T14:57:24Z

Hi @matthoward366 Please review above setup for new Elyra Canvas Documentation

matthoward366 · 2024-02-19T16:45:40Z

@srikant-ch5 Is there a way I can test this out locally?

srikant-ch5 · 2024-02-19T16:53:32Z

@srikant-ch5 Is there a way I can test this out locally?

Hi @matthoward366 Yes you can run this using command mkdocs serve .

tomlyn · 2024-02-20T20:20:07Z

@matthoward366
For getting the docs build to work @Paul-Kawalkowski helped me discover that:

Python v3 needs to be available. I had v3.11.3 installed
Then run pip3 install -r requirements.txt
Then run mkdocs serve
When complete, open the browser: http://127.0.0.1:8000/

@srikant-ch5 Can you add this info to the Read me?

Signed-off-by: srikant <[email protected]>

srikant-ch5 · 2024-02-21T14:56:02Z

@matthoward366 For getting the docs build to work @Paul-Kawalkowski helped me discover that:

Python v3 needs to be available. I had v3.11.3 installed

Then run pip3 install -r requirements.txt

Then run mkdocs serve

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

@srikant-ch5 Can you add this info to the Read me?

Hi @tomlyn . Sure, I have added above instructions in Readme.

nmgokhale · 2024-02-22T00:19:57Z

mkdocs.yml

+edit_uri: edit/main/guide/
+
+# Documentation and theme
+copyright: 'Copyright &copy; 2023 IBM Watson Team, an open source project and all are welcome to contribute!<br> Maintained by the SPSS Modeler Team'


Update year to 2024. Maintained by the elyra canvas Team.

nmgokhale · 2024-02-22T00:23:50Z

mkdocs.yml

@@ -0,0 +1,80 @@
+site_name: Elyra Guide


This should be Elyra Canvas Guide

README.md

nmgokhale · 2024-02-22T00:32:05Z

guide/5.0-Styling.md

+
+### 3rd party styling
+
+If you are using the expression builder in common-properties then also include these libraries:


Remove lines 44-47 -

If you are using the expression builder in common-properties then also include these libraries: codemirror/addon/hint/show-hint.css codemirror/lib/codemirror.css

Signed-off-by: srikant <[email protected]>

srikant-ch5 · 2024-02-22T06:37:49Z

Hi @nmgokhale Thanks for the review. I have updated the PR with above feedback.

nmgokhale · 2024-02-22T18:01:44Z

mkdocs.yml

+edit_uri: edit/main/guide/
+
+# Documentation and theme
+copyright: 'Copyright &copy; 2024. Maintained by the Elyra Canvas Team., an open source project and all are welcome to contribute!<br> Maintained by the SPSS Modeler Team'


Please remove Maintained by the SPSS Modeler Team

tomlyn · 2024-02-20T20:36:23Z

guide/index.md

@@ -0,0 +1,90 @@
+# Welcome to the Elyra Canvas Wiki


Change to Welcome to the Elyra Canvas Documentation

tomlyn · 2024-02-20T20:43:13Z

mkdocs.yml

+edit_uri: edit/main/guide/
+
+# Documentation and theme
+copyright: 'Copyright &copy; 2023 IBM Watson Team, an open source project and all are welcome to contribute!<br> Maintained by the SPSS Modeler Team'


Should be
copyright: 'Copyright © 2024 Elyra Authors, an open source project and all are welcome to contribute!
Maintained by the Elyra Authors Team'

tomlyn · 2024-02-20T21:32:10Z

mkdocs.yml

@@ -0,0 +1,80 @@
+site_name: Elyra Guide


Should be Elyra Canvas Documentation

tomlyn · 2024-02-20T21:46:14Z

guide/index.md

+
+## Installation
+
+You'll need to build your application with common canvas. 


Should be:
You'll need to build your application with Elyra Canvas.

tomlyn · 2024-02-20T21:47:04Z

guide/index.md

+
+You'll need to build your application with common canvas. 
+
+* common-canvas requires react, react-dom, react-intl, and react-redux libraries to be installed.  See peerDependencies in package.json for versions requirements.


First sentence should be:
Elyra Canvas requires react, react-dom, react-intl, and react-redux libraries to be installed.

tomlyn · 2024-02-21T17:55:10Z

guide/4.0-Accessibility.md

@@ -0,0 +1,3 @@
+## Tips
+- All input elements need to have a visual indication `focus` is set.  This is different then selection.
+- Use the correct html element for inputs.  For example don't use a `div` with a click event.  Use a `button` or `a` instead.


Please delete this document. It doesn't add anything useful to the documentation.

…le for deployment Signed-off-by: srikant <[email protected]>

Signed-off-by: srikant <[email protected]>

srikant-ch5 · 2024-02-26T16:35:32Z

Hi Team, I have deployed the docs at https://srikant-ch5.github.io/canvas/ Please review. The url can be changed to elyra-canvas .

nmgokhale · 2024-02-26T21:25:20Z

docs/3.3-Common-Properties-Controls.md

+## Parameter Controls
+The following controls are supported in the Common Properties editor. Control types are intended for use with particular parameter types:
+
+### Control Types


slider control documentation is not added in this section.

slider control documentation is not added in this section.

Hi @nmgokhale I have included slider control documentation now https://srikant-ch5.github.io/canvas/3.3-Common-Properties-Controls/#control-types . Previously I was taking https://github.com/elyra-ai/canvas/wiki as reference (slider is not included in this).

Signed-off-by: srikant <[email protected]>

matthoward366 · 2024-02-28T15:44:03Z

.github/workflows/ci.yml

+on:
+  push:
+    branches:
+      - new-guide 


This doesn't seem right. Would this mean the guide would only be updated when the branch is new-guide?

Yes Matt, this needs to be changed as main when merged, for testing purpose I have kept it as new-guide.

matthoward366 · 2024-02-28T15:44:18Z

.github/workflows/ci.yml

+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]


How did you come up with these?

Hi Matt to deploy the docs using gh-pages I have followed https://squidfunk.github.io/mkdocs-material/publishing-your-site/ resource and able to deploy whenever I push any change in docs to my new-guide branch. It triggers ci to deploy the changes without manually running mkdocs gh-deploy --force

I'm more wondering about git config user.name github-actions[bot] and git config user.email 41898282+github-actions[bot]@users.noreply.github.com. Do we need these?

matthoward366 · 2024-02-28T16:26:20Z

canvas_modules/common-canvas/src/object-model/layout-dimensions.js

@@ -73,7 +73,7 @@ const portsHorizontalDefaultLayout = {
 		labelAllowReturnKey: false, // true allows line feed to be inserted into label, "save" to make the return key save the label.

 		// An array of decorations to be applied to the node. For details see:
-		// https://github.com/elyra-ai/canvas/wiki/2.4.2-Decoration-Specification
+		// https://github.com/elyra-ai/canvas/tree/main/guide/2.4.2-Decoration-Specification.md


Shouldn't all these links be github pages links? Also, I don't this guide is the folder anymore.

Hi Matt, I have reverted the docs links to point to existing elyra canvas docs once the new one is deployed I will change these urls pointing to new docs.

matthoward366 · 2024-02-28T16:27:28Z

canvas_modules/common-canvas/src/object-model/layout-dimensions.js

@@ -488,7 +488,7 @@ const portsVerticalDefaultLayout = {
 		labelAllowReturnKey: false, // true allows line feed to be inserted into label, "save" to make the return key save the label.

 		// An array of decorations to be applied to the node. For details see:
-		// https://github.com/elyra-ai/canvas/wiki/2.4.2-Decoration-Specification
+		// https://github.com/elyra-ai/canvas/tree/main/guide/2.4.2-Decoration-Specification.md


Same as above. Have a look at all the links.

Hi Matt, I have reverted the docs links to point to existing elyra canvas docs once the new one is deployed I will change these urls pointing to new docs.

matthoward366 · 2024-02-28T16:28:51Z

docs/css/styles.css

@@ -0,0 +1,7 @@
+th {


Shouldn't all these new css and js files have copyrights?

Hi Matt I have included copyrights in the new js and css files.

matthoward366 · 2024-02-28T16:29:14Z

docs/images/DELETEME

@@ -0,0 +1 @@
+Images for the guide go here.


What is this?

Hi Matt I have removed this file now. Thanks.

matthoward366 · 2024-02-28T16:29:51Z

docs/js/links-in-new-tabs.js

+// pages within the documentation will remain in the same tab
+// Source: https://stackoverflow.com/questions/4425198/can-i-create-links-with-target-blank-in-markdown#answer-4425214
+
+var links = document.links;


Missing copyright. Also, we usually use const instead of var

Thanks, I have updated these.

…old docs Signed-off-by: srikant <[email protected]>

matthoward366

One small comment and the rest looks good. Once it's deployed with your branch then we can change it to main before merging.

matthoward366 · 2024-02-29T21:31:26Z

.github/workflows/ci.yml

+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]


I'm more wondering about git config user.name github-actions[bot] and git config user.email 41898282+github-actions[bot]@users.noreply.github.com. Do we need these?

Signed-off-by: srikant <[email protected]>

srikant-ch5 · 2024-03-01T10:14:15Z

I'm more wondering about git config user.name github-actions[bot] and git config user.email 41898282+github-actions[bot]@users.noreply.github.com. Do we need these?

Hi @matthoward366 I have removed these and its working fine. Thanks.

Signed-off-by: srikant <[email protected]>

Paul-Kawalkowski and others added 4 commits July 24, 2023 09:16

feat: new guide

b19c585

Signed-off-by: Paul-Kawalkowski <[email protected]>

Merge branch 'main' into new-guide

bd9b570

Merge branch 'main' into new-guide

2131ab8

elyra-ai#1701 : New Elyra Canvas Documentation using mkdocs setup

559de91

Signed-off-by: srikant <[email protected]>

srikant-ch5 requested a review from matthoward366 February 19, 2024 14:56

srikant-ch5 added 2 commits February 21, 2024 20:23

Add instructions related to mkdocs setup in Readme

5dae51d

Signed-off-by: srikant <[email protected]>

Merge branch 'main' into new-guide

4ab5f66

nmgokhale reviewed Feb 22, 2024

View reviewed changes

mkdocs.yml Outdated

@@ -0,0 +1,80 @@

site_name: Elyra Guide

Copy link

Member

nmgokhale Feb 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be Elyra Canvas Guide

nmgokhale reviewed Feb 22, 2024

View reviewed changes

README.md Show resolved Hide resolved

nmgokhale reviewed Feb 22, 2024

View reviewed changes

srikant-ch5 marked this pull request as draft February 22, 2024 06:33

Update Readme, mkdocs.yml and Styling.md as per feedback

a129d9b

Signed-off-by: srikant <[email protected]>

nmgokhale reviewed Feb 22, 2024

View reviewed changes

tomlyn previously approved these changes Feb 22, 2024

View reviewed changes

srikant-ch5 added 2 commits February 23, 2024 11:13

Merge branch 'main' into new-guide

ee740e0

Update new documentation as per comments and include github action fi…

4b0322a

…le for deployment Signed-off-by: srikant <[email protected]>

srikant-ch5 dismissed tomlyn’s stale review via 4b0322a February 23, 2024 06:46

srikant-ch5 added 6 commits February 23, 2024 12:20

Update username and id in ci.yml for github pages

32f0f38

Signed-off-by: srikant <[email protected]>

Update username and id as default

c6aab84

Signed-off-by: srikant <[email protected]>

Update new-guide branch in ci.yml

d88a8d7

Signed-off-by: srikant <[email protected]>

Test using readthedocs theme

7252eb7

Signed-off-by: srikant <[email protected]>

Revert theme change

62ed288

Signed-off-by: srikant <[email protected]>

Include links js file

5c85847

Signed-off-by: srikant <[email protected]>

srikant-ch5 added 3 commits February 26, 2024 15:16

Remove awesome-pages to test deployment

e9755ff

Signed-off-by: srikant <[email protected]>

Deploy docs to gh-pages and fix link navigation in docs

8e18c5c

Signed-off-by: srikant <[email protected]>

Fix Resource def links in docs link navigation

5d54fad

Signed-off-by: srikant <[email protected]>

Paul-Kawalkowski mentioned this pull request Feb 26, 2024

feat: new guide #1537

Closed

tomlyn self-requested a review February 26, 2024 19:28

tomlyn previously approved these changes Feb 26, 2024

View reviewed changes

nmgokhale reviewed Feb 26, 2024

View reviewed changes

Add slider info in Common Properties docs

9f64d5a

Signed-off-by: srikant <[email protected]>

srikant-ch5 dismissed tomlyn’s stale review via 9f64d5a February 27, 2024 10:46

nmgokhale previously approved these changes Feb 27, 2024

View reviewed changes

srikant-ch5 added 2 commits February 28, 2024 11:16

Merge branch 'main' into new-guide

339ec87

Fix link redirection in 2.4.6, 3.1 and 3.2 docs

a0ed397

Signed-off-by: srikant <[email protected]>

srikant-ch5 dismissed nmgokhale’s stale review via a0ed397 February 28, 2024 07:30

matthoward366 requested changes Feb 28, 2024

View reviewed changes

srikant-ch5 added 2 commits February 29, 2024 13:21

Merge branch 'main' into new-guide

9df99fd

Add Copyrights in docs file and revert links in js files to point to …

8da981a

…old docs Signed-off-by: srikant <[email protected]>

matthoward366 reviewed Feb 29, 2024

View reviewed changes

srikant-ch5 added 2 commits March 1, 2024 11:02

Check deployment action

547fd65

Signed-off-by: srikant <[email protected]>

Check deployment by removing git credentials from ci.yml

41dbda1

Signed-off-by: srikant <[email protected]>

Update branch name in ci.yml

0e589b2

Signed-off-by: srikant <[email protected]>

matthoward366 approved these changes Mar 1, 2024

View reviewed changes

matthoward366 marked this pull request as ready for review March 1, 2024 14:58

matthoward366 merged commit 7a31f82 into elyra-ai:main Mar 1, 2024
3 checks passed

srikant-ch5 mentioned this pull request Jun 7, 2024

#2010 Deploy-docs run fails after commit is merged in main branch #2011

Merged


		### 3rd party styling

		If you are using the expression builder in common-properties then also include these libraries:


		## Installation

		You'll need to build your application with common canvas.


		You'll need to build your application with common canvas.

		* common-canvas requires react, react-dom, react-intl, and react-redux libraries to be installed. See peerDependencies in package.json for versions requirements.

Elyra Canvas Documentation using mkdocs #1702

Elyra Canvas Documentation using mkdocs #1702

Conversation

srikant-ch5 commented Feb 19, 2024 • edited Loading

srikant-ch5 commented Feb 19, 2024

matthoward366 commented Feb 19, 2024

srikant-ch5 commented Feb 19, 2024

tomlyn commented Feb 20, 2024

srikant-ch5 commented Feb 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srikant-ch5 commented Feb 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srikant-ch5 commented Feb 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matthoward366 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srikant-ch5 commented Mar 1, 2024

srikant-ch5 commented Feb 19, 2024 •

edited

Loading

matthoward366 left a comment •

edited

Loading