From cbb67e37b6cf89dc249e431b9c126e02074965d0 Mon Sep 17 00:00:00 2001 From: linglp Date: Tue, 21 Nov 2023 13:45:30 -0500 Subject: [PATCH 1/4] update documentation for publishing schema viz --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cde45ce..e79ed3b 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,16 @@ This repository is for extracting D3 and Javascript code from observables to pro # Running the code Simply clone the repository and run `python3 -m http.server`. -# Update schema used for your project utilizing schematic API (preferred) +# Run schema viz for your data model locally utilizing schematic APIs (preferred) * Open files/config.yml and update the schema url that you want to use for your project. Please note that by default we are using schematic prod environment when making API calls. * Run `python3 -m http.server` and you should be able to see the visualization of your schema. -Note: if the tangled tree or the attribute table is not showing up, it is likely that there is an error when using your schema to make API calls to the following endpoints: 1) `GET /visualize/tangled_tree/layers`; 2) `Get /visualize/attributes`. Please start by using schematic prod: https://schematic.api.sagebionetworks.org/v1/ui/ and see if you could use these two endpoints with your schema. If you could not, please contact FAIR data service desk. +# Run schema viz for your data model and publish visualization using github action (preferred) +* Fork this repository. If you have forked this repo, make sure that the `main` branch of your forked repository is in sync with the `main` branch of this repo. +* In your forked repository, open `files/config.yml` and update the schema url that you want to use for your project. Please note that by default we are using schematic prod environment when making API calls. +* Update `on > push > branches` in `.github/deploy.yml` file and use `main` branch or a branch that you desire to publish schema viz to your forked repository. + +> Note: if the tangled tree or the attribute table is not showing up, it is likely that there is an error when using your schema to make API calls to the following endpoints: 1) `GET /visualize/tangled_tree/layers`; 2) `Get /visualize/attributes`. Please start by using schematic prod: https://schematic.api.sagebionetworks.org/v1/ui/ and see if you could use these two endpoints with your schema. If you could not, please contact FAIR data service desk. # Update Static files (**Will be deprecated**) From a30d2df8cc1f7cef8196f7a95160890614796be9 Mon Sep 17 00:00:00 2001 From: linglp Date: Wed, 22 Nov 2023 12:58:05 -0500 Subject: [PATCH 2/4] update documentation --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e79ed3b..fbbf574 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ Simply clone the repository and run `python3 -m http.server`. # Run schema viz for your data model and publish visualization using github action (preferred) * Fork this repository. If you have forked this repo, make sure that the `main` branch of your forked repository is in sync with the `main` branch of this repo. * In your forked repository, open `files/config.yml` and update the schema url that you want to use for your project. Please note that by default we are using schematic prod environment when making API calls. -* Update `on > push > branches` in `.github/deploy.yml` file and use `main` branch or a branch that you desire to publish schema viz to your forked repository. +* Run schema viz locally by running `python3 -m http.server` and see the schema viz locally. If some parts of the visualization gets cut, please adjust the width of your visualization in `createCollapsibleTree function` in `collapsibleTangleTree.js` (See around line 66 in `collapsibleTangleTree.js`) +* Enable Github action in your repo. Click on "Settings" > "Pages". Under section "Build and deployment", select "main" branch or a branch that you desire to build github pages. +* After building GitHub Pages site successfully, you should be able to visit the site. > Note: if the tangled tree or the attribute table is not showing up, it is likely that there is an error when using your schema to make API calls to the following endpoints: 1) `GET /visualize/tangled_tree/layers`; 2) `Get /visualize/attributes`. Please start by using schematic prod: https://schematic.api.sagebionetworks.org/v1/ui/ and see if you could use these two endpoints with your schema. If you could not, please contact FAIR data service desk. From a1c5feff0450f4d3d859c2fe60db0f2a61dded9f Mon Sep 17 00:00:00 2001 From: linglp Date: Mon, 27 Nov 2023 11:20:01 -0500 Subject: [PATCH 3/4] add instructions --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fbbf574..1b97ec3 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ Simply clone the repository and run `python3 -m http.server`. * Fork this repository. If you have forked this repo, make sure that the `main` branch of your forked repository is in sync with the `main` branch of this repo. * In your forked repository, open `files/config.yml` and update the schema url that you want to use for your project. Please note that by default we are using schematic prod environment when making API calls. * Run schema viz locally by running `python3 -m http.server` and see the schema viz locally. If some parts of the visualization gets cut, please adjust the width of your visualization in `createCollapsibleTree function` in `collapsibleTangleTree.js` (See around line 66 in `collapsibleTangleTree.js`) -* Enable Github action in your repo. Click on "Settings" > "Pages". Under section "Build and deployment", select "main" branch or a branch that you desire to build github pages. -* After building GitHub Pages site successfully, you should be able to visit the site. +* Enable Github action in your repo. Click on "Settings" > "Pages". Under section "Build and deployment", select "main" branch or a branch that you desire to build github pages. (Please see more instructions [here](https://github.com/ncihtan/schema_visualization/tree/develop-update-schema-viz)) +* After your site gets published successfully, to visit your published site, under "GitHub Pages", click `Visit site` > Note: if the tangled tree or the attribute table is not showing up, it is likely that there is an error when using your schema to make API calls to the following endpoints: 1) `GET /visualize/tangled_tree/layers`; 2) `Get /visualize/attributes`. Please start by using schematic prod: https://schematic.api.sagebionetworks.org/v1/ui/ and see if you could use these two endpoints with your schema. If you could not, please contact FAIR data service desk. From ce8912a0a776f3da3f9efc70135e4417c6afd98a Mon Sep 17 00:00:00 2001 From: linglp Date: Mon, 27 Nov 2023 11:22:15 -0500 Subject: [PATCH 4/4] correct format --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b97ec3..2928cdc 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Simply clone the repository and run `python3 -m http.server`. # Run schema viz for your data model and publish visualization using github action (preferred) * Fork this repository. If you have forked this repo, make sure that the `main` branch of your forked repository is in sync with the `main` branch of this repo. * In your forked repository, open `files/config.yml` and update the schema url that you want to use for your project. Please note that by default we are using schematic prod environment when making API calls. -* Run schema viz locally by running `python3 -m http.server` and see the schema viz locally. If some parts of the visualization gets cut, please adjust the width of your visualization in `createCollapsibleTree function` in `collapsibleTangleTree.js` (See around line 66 in `collapsibleTangleTree.js`) +* Run schema viz locally by running `python3 -m http.server` and see the schema viz locally. If some parts of the visualization gets cut, please adjust the width of your visualization in `createCollapsibleTree` function in `collapsibleTangleTree.js` (See around line 66 in `collapsibleTangleTree.js`) * Enable Github action in your repo. Click on "Settings" > "Pages". Under section "Build and deployment", select "main" branch or a branch that you desire to build github pages. (Please see more instructions [here](https://github.com/ncihtan/schema_visualization/tree/develop-update-schema-viz)) * After your site gets published successfully, to visit your published site, under "GitHub Pages", click `Visit site`