Skip to content

Commit

Permalink
deploy: 25be36e
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 24, 2023
1 parent 353dca9 commit 2a3e492
Show file tree
Hide file tree
Showing 26 changed files with 193 additions and 181 deletions.
142 changes: 71 additions & 71 deletions dev/sitemap.xml

Large diffs are not rendered by default.

Binary file modified dev/sitemap.xml.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion en/2-Publishing/Dash/Dash.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Dash makes it simple to build an interactive GUI around your data analysis code.
This is an example of a Layout With Figure and Slider from
[Dash](https://dash.plotly.com/basic-callbacks).

![dash_plot](../images/plot.png)
![Dash Plot example](../images/plot.png)

### Plotly Dash

Expand Down
2 changes: 1 addition & 1 deletion en/2-Publishing/Dash/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1465,7 +1465,7 @@ <h2 id="data-visualization-with-dash">Data Visualization with Dash<a class="head
<p>Dash makes it simple to build an interactive GUI around your data analysis code.
This is an example of a Layout With Figure and Slider from
<a href="https://dash.plotly.com/basic-callbacks">Dash</a>.</p>
<p><img alt="dash_plot" src="../../images/plot.png" /></p>
<p><img alt="Dash Plot example" src="../../images/plot.png" /></p>
<h3 id="plotly-dash">Plotly Dash<a class="headerlink" href="#plotly-dash" title="Permanent link">&para;</a></h3>
<p><em>Publish with Canadian-made software.</em></p>
<p><strong><a href="../Dash/">Plotly Dash</a></strong> is a popular Python library that allows you to create interactive web-based visualizations and dashboards with ease. Developed by the Montreal-based company Plotly, Dash has gained a reputation for being a powerful and flexible tool for building custom data science graphics. With Dash, you can create everything from simple line charts to complex, multi-page dashboards with interactive widgets and controls. Because it's built on open source technologies like Flask, React, and Plotly.js, Dash is highly customizable and can be easily integrated with other data science tools and workflows. Whether you're a data scientist, analyst, or developer, Dash can help you create engaging and informative visualizations that bring your data to life.</p>
Expand Down
5 changes: 4 additions & 1 deletion en/2-Publishing/Datasette/Datasette.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,10 @@ You can even explore maps within the tool!
## Installing Datasette

In your Jupyter Notebook, open a terminal window and run the command
`pip3 install datasette`. ![Install Datasette](../images/InstallDatasette.PNG)
`pip3 install datasette`.
<center>
![Install Datasette](../images/InstallDatasette.PNG)
</center>

## Starting Datasette

Expand Down
5 changes: 4 additions & 1 deletion en/2-Publishing/Datasette/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1448,7 +1448,10 @@ <h2 id="example-datasette">Example Datasette<a class="headerlink" href="#example
<h1 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">&para;</a></h1>
<h2 id="installing-datasette">Installing Datasette<a class="headerlink" href="#installing-datasette" title="Permanent link">&para;</a></h2>
<p>In your Jupyter Notebook, open a terminal window and run the command
<code>pip3 install datasette</code>. <img alt="Install Datasette" src="../../images/InstallDatasette.PNG" /></p>
<code>pip3 install datasette</code>.
<center>
<img alt="Install Datasette" src="../../images/InstallDatasette.PNG" />
</center></p>
<h2 id="starting-datasette">Starting Datasette<a class="headerlink" href="#starting-datasette" title="Permanent link">&para;</a></h2>
<p>To view your own database in your Jupyter Notebook, create a file called
start.sh in your project directory and copy the below code into it. Make the
Expand Down
10 changes: 5 additions & 5 deletions en/2-Publishing/R-Shiny/R-Shiny.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,27 +75,27 @@ shinyuieditor::launch_editor(app_loc = "./")

The first thing you'll see is the template chooser. There are three options as of this writing (`shinyuieditor` is currently in alpha).

![image](https://user-images.githubusercontent.com/8212170/229583104-9404ad01-26cd-4260-bce6-6fe32ffab7d8.png)
![Shiny ui Editor Template](https://user-images.githubusercontent.com/8212170/229583104-9404ad01-26cd-4260-bce6-6fe32ffab7d8.png)

### Single or Multi File Mode

I recommend **Multi file mode**, this will put the back-end code in a file called `server.R` and front-end in a file called `ui.R`.

![image](https://user-images.githubusercontent.com/8212170/229584803-452bcdb9-4aa6-4902-805e-845d0b939016.png)
![Generate app multi file mode](https://user-images.githubusercontent.com/8212170/229584803-452bcdb9-4aa6-4902-805e-845d0b939016.png)

### Design Your App

You can design your app with either code or the graphical user interface. Try designing the layout with the GUI and designing the plots with code.

![image](https://user-images.githubusercontent.com/8212170/229589867-19bf334c-4789-4228-99ec-44583b119e29.png)
![App design example](https://user-images.githubusercontent.com/8212170/229589867-19bf334c-4789-4228-99ec-44583b119e29.png)

Any changes you make in `shinyuieditor` will appear immediately in the code.

![image](https://user-images.githubusercontent.com/8212170/229637808-38dc0ed3-902a-44db-bfa0-193ef25af6ca.png)
![Panel text example](https://user-images.githubusercontent.com/8212170/229637808-38dc0ed3-902a-44db-bfa0-193ef25af6ca.png)

Any change you make in the code will immediately appear in the `shinyuieditor`.

![image](https://user-images.githubusercontent.com/8212170/229637972-b4a263f5-27f0-4160-8b43-9250ace72999.png)
![ShinyUiEditor](https://user-images.githubusercontent.com/8212170/229637972-b4a263f5-27f0-4160-8b43-9250ace72999.png)

## Publishing on the AAW

Expand Down
10 changes: 5 additions & 5 deletions en/2-Publishing/R-Shiny/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1513,17 +1513,17 @@ <h1 id="r-shiny-ui-editor">R Shiny UI Editor<a class="headerlink" href="#r-shiny
</span></code></pre></div></td></tr></table></div>
<h3 id="choose-an-app-template">Choose an App Template<a class="headerlink" href="#choose-an-app-template" title="Permanent link">&para;</a></h3>
<p>The first thing you'll see is the template chooser. There are three options as of this writing (<code>shinyuieditor</code> is currently in alpha).</p>
<p><img alt="image" src="https://user-images.githubusercontent.com/8212170/229583104-9404ad01-26cd-4260-bce6-6fe32ffab7d8.png" /></p>
<p><img alt="Shiny ui Editor Template" src="https://user-images.githubusercontent.com/8212170/229583104-9404ad01-26cd-4260-bce6-6fe32ffab7d8.png" /></p>
<h3 id="single-or-multi-file-mode">Single or Multi File Mode<a class="headerlink" href="#single-or-multi-file-mode" title="Permanent link">&para;</a></h3>
<p>I recommend <strong>Multi file mode</strong>, this will put the back-end code in a file called <code>server.R</code> and front-end in a file called <code>ui.R</code>.</p>
<p><img alt="image" src="https://user-images.githubusercontent.com/8212170/229584803-452bcdb9-4aa6-4902-805e-845d0b939016.png" /></p>
<p><img alt="Generate app multi file mode" src="https://user-images.githubusercontent.com/8212170/229584803-452bcdb9-4aa6-4902-805e-845d0b939016.png" /></p>
<h3 id="design-your-app">Design Your App<a class="headerlink" href="#design-your-app" title="Permanent link">&para;</a></h3>
<p>You can design your app with either code or the graphical user interface. Try designing the layout with the GUI and designing the plots with code.</p>
<p><img alt="image" src="https://user-images.githubusercontent.com/8212170/229589867-19bf334c-4789-4228-99ec-44583b119e29.png" /></p>
<p><img alt="App design example" src="https://user-images.githubusercontent.com/8212170/229589867-19bf334c-4789-4228-99ec-44583b119e29.png" /></p>
<p>Any changes you make in <code>shinyuieditor</code> will appear immediately in the code. </p>
<p><img alt="image" src="https://user-images.githubusercontent.com/8212170/229637808-38dc0ed3-902a-44db-bfa0-193ef25af6ca.png" /></p>
<p><img alt="Panel text example" src="https://user-images.githubusercontent.com/8212170/229637808-38dc0ed3-902a-44db-bfa0-193ef25af6ca.png" /></p>
<p>Any change you make in the code will immediately appear in the <code>shinyuieditor</code>.</p>
<p><img alt="image" src="https://user-images.githubusercontent.com/8212170/229637972-b4a263f5-27f0-4160-8b43-9250ace72999.png" /></p>
<p><img alt="ShinyUiEditor" src="https://user-images.githubusercontent.com/8212170/229637972-b4a263f5-27f0-4160-8b43-9250ace72999.png" /></p>
<h2 id="publishing-on-the-aaw">Publishing on the AAW<a class="headerlink" href="#publishing-on-the-aaw" title="Permanent link">&para;</a></h2>
<h3 id="just-send-a-pull-request">Just send a pull request!<a class="headerlink" href="#just-send-a-pull-request" title="Permanent link">&para;</a></h3>
<p>All you have to do is send a pull request to <a href="https://github.com/StatCan/R-dashboards">our R-Dashboards repository</a>. Include your repository in a folder with the name you want (for example, "air-quality-dashboard"). Then we will approve it and it will come online.</p>
Expand Down
4 changes: 2 additions & 2 deletions en/3-Pipelines/Argo/Argo.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

## Argo Workflows

![Argo Workflows](../images/argo.png)
![Argo Workflows Squid Logo](../images/argo.png)

**[Argo Workflows](https://argoproj.github.io/argo-workflows/)** is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. Argo Workflows is implemented as a Kubernetes CRD (Custom Resource Definition). It is particularly well-suited for use in data science workflows and machine learning workflows.

Expand All @@ -19,7 +19,7 @@ With Argo Workflows, you can easily build workflows that incorporate tasks such
<!-- prettier-ignore -->
!!! info ""
<center>
[![Argo Workflows](../images/argo-workflows.jpg)](https://argoproj.github.io/argo-workflows/)
[![Argo Workflows Diagram](../images/argo-workflows.jpg)](https://argoproj.github.io/argo-workflows/)
<h3>Argo Workflows</h3>
</center>

Expand Down
4 changes: 2 additions & 2 deletions en/3-Pipelines/Argo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1580,7 +1580,7 @@
<h1>Argo</h1>

<h2 id="argo-workflows">Argo Workflows<a class="headerlink" href="#argo-workflows" title="Permanent link">&para;</a></h2>
<p><img alt="Argo Workflows" src="../../images/argo.png" /></p>
<p><img alt="Argo Workflows Squid Logo" src="../../images/argo.png" /></p>
<p><strong><a href="https://argoproj.github.io/argo-workflows/">Argo Workflows</a></strong> is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. Argo Workflows is implemented as a Kubernetes CRD (Custom Resource Definition). It is particularly well-suited for use in data science workflows and machine learning workflows.</p>
<p>Full documentation can be found <a href="https://argoproj.github.io/argo-workflows/walk-through/">here</a>. </p>
<p>Argo Workflows allows you to</p>
Expand All @@ -1594,7 +1594,7 @@ <h2 id="argo-workflows">Argo Workflows<a class="headerlink" href="#argo-workflow
<!-- prettier-ignore -->
<div class="admonition info">
<p><center>
<a href="https://argoproj.github.io/argo-workflows/"><img alt="Argo Workflows" src="../../images/argo-workflows.jpg" /></a>
<a href="https://argoproj.github.io/argo-workflows/"><img alt="Argo Workflows Diagram" src="../../images/argo-workflows.jpg" /></a>
<h3>Argo Workflows</h3>
</center></p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion en/4-Collaboration/Overview/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ others are. That said, it is totally possible.
You can add or remove people from a namespace you already own through the
**Manage Contributors** menu in Kubeflow.

![Contributors Menu](../images/kubeflow_contributors.png)
![ Manage Contributors Menu](../images/kubeflow_contributors.png)

<!-- prettier-ignore -->
!!! info "Now you and your colleagues can share access to a server!"
Expand Down
2 changes: 1 addition & 1 deletion en/4-Collaboration/Overview/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1601,7 +1601,7 @@ <h3 id="sharing-with-the-world">Sharing with the world<a class="headerlink" href
<h2 id="managing-contributors">Managing contributors<a class="headerlink" href="#managing-contributors" title="Permanent link">&para;</a></h2>
<p>You can add or remove people from a namespace you already own through the
<strong>Manage Contributors</strong> menu in Kubeflow.</p>
<p><img alt="Contributors Menu" src="../../images/kubeflow_contributors.png" /></p>
<p><img alt=" Manage Contributors Menu" src="../../images/kubeflow_contributors.png" /></p>
<!-- prettier-ignore -->
<div class="admonition info">
<p class="admonition-title">Now you and your colleagues can share access to a server!</p>
Expand Down
12 changes: 6 additions & 6 deletions en/6-Gitlab/Gitlab/Gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Thankfully, using the cloud main GitLab on the AAW is just like how you would re
### Step 1: Locate the Git repo you want to clone and copy the clone with HTTPS option
If your repository is private, you will need to also do Step 4 (Creating a Personal Access Token) for this to go through.
For me this was a test repo
![image](https://user-images.githubusercontent.com/23174198/217060353-ba229ced-b5c1-4eae-8878-9608835cc65f.png)
![Clone with SSH image](https://user-images.githubusercontent.com/23174198/217060353-ba229ced-b5c1-4eae-8878-9608835cc65f.png)

### Step 2: Paste the copied link into one of your workspace servers
![image](https://user-images.githubusercontent.com/23174198/217060697-535df6c1-d9bb-4bc3-a42b-9f085a5386d5.png)
![Git clone example](https://user-images.githubusercontent.com/23174198/217060697-535df6c1-d9bb-4bc3-a42b-9f085a5386d5.png)

### Step 3: Success!
As seen in the above screenshot I have cloned the repo!
Expand All @@ -22,20 +22,20 @@ As seen in the above screenshot I have cloned the repo!
If you try to `git push ....` you will encounter an error eventually leading you to the [GitLab help documentation](https://gitlab.k8s.cloud.statcan.ca/help/user/profile/account/two_factor_authentication.md#error-http-basic-access-denied-the-provided-password-or-token-)

You will need to make a Personal Access Token for this. To achieve this go in GitLab, click your profile icon and then hit `Preferences` and then `Access Tokens`
![image](https://user-images.githubusercontent.com/23174198/217061060-122dded8-dc80-46ce-a907-a85913cf5dd7.png)
![Personal Access Tokens](https://user-images.githubusercontent.com/23174198/217061060-122dded8-dc80-46ce-a907-a85913cf5dd7.png)
Follow the prompts entering the name, the token expiration date and granting the token permissions (I granted `write_repository`)

### Step 5: Personalize `Git` to be you
Run `git config user.email ....` and `git config user.name ...` to match your GitLab identity.

### Step 6: Supply the Generated Token when asked for your password
The token will by copy-able at the top once you hit `Create personal access token` at the bottom
![image](https://user-images.githubusercontent.com/23174198/217062846-03a715f1-ded5-4d80-ad4b-c647ae5e30fd.png)
![Supply Personal Access Token](https://user-images.githubusercontent.com/23174198/217062846-03a715f1-ded5-4d80-ad4b-c647ae5e30fd.png)

Once you have prepared everything it's time
![image](https://user-images.githubusercontent.com/23174198/217063198-c1bd6c3a-ebc5-444d-98ba-24ef32faa20e.png)
![Final steps](https://user-images.githubusercontent.com/23174198/217063198-c1bd6c3a-ebc5-444d-98ba-24ef32faa20e.png)


### Step 7: See the results of your hard work in GitLab
![image](https://user-images.githubusercontent.com/23174198/217063990-efaa8e81-a0eb-4b6d-842e-2ca3112bb4f7.png)
![GitLab menu](https://user-images.githubusercontent.com/23174198/217063990-efaa8e81-a0eb-4b6d-842e-2ca3112bb4f7.png)

12 changes: 6 additions & 6 deletions en/6-Gitlab/Gitlab/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1533,25 +1533,25 @@ <h2 id="important-notes"><strong>IMPORTANT NOTES</strong><a class="headerlink" h
<h3 id="step-1-locate-the-git-repo-you-want-to-clone-and-copy-the-clone-with-https-option">Step 1: Locate the Git repo you want to clone and copy the clone with HTTPS option<a class="headerlink" href="#step-1-locate-the-git-repo-you-want-to-clone-and-copy-the-clone-with-https-option" title="Permanent link">&para;</a></h3>
<p>If your repository is private, you will need to also do Step 4 (Creating a Personal Access Token) for this to go through.
For me this was a test repo
<img alt="image" src="https://user-images.githubusercontent.com/23174198/217060353-ba229ced-b5c1-4eae-8878-9608835cc65f.png" /></p>
<img alt="Clone with SSH image" src="https://user-images.githubusercontent.com/23174198/217060353-ba229ced-b5c1-4eae-8878-9608835cc65f.png" /></p>
<h3 id="step-2-paste-the-copied-link-into-one-of-your-workspace-servers">Step 2: Paste the copied link into one of your workspace servers<a class="headerlink" href="#step-2-paste-the-copied-link-into-one-of-your-workspace-servers" title="Permanent link">&para;</a></h3>
<p><img alt="image" src="https://user-images.githubusercontent.com/23174198/217060697-535df6c1-d9bb-4bc3-a42b-9f085a5386d5.png" /></p>
<p><img alt="Git clone example" src="https://user-images.githubusercontent.com/23174198/217060697-535df6c1-d9bb-4bc3-a42b-9f085a5386d5.png" /></p>
<h3 id="step-3-success">Step 3: Success!<a class="headerlink" href="#step-3-success" title="Permanent link">&para;</a></h3>
<p>As seen in the above screenshot I have cloned the repo!</p>
<h3 id="step-4-create-a-personal-access-token-for-pushing-also-used-if-pulling-from-a-private-repository">Step 4: Create a Personal Access Token for pushing (also used if pulling from a private repository)<a class="headerlink" href="#step-4-create-a-personal-access-token-for-pushing-also-used-if-pulling-from-a-private-repository" title="Permanent link">&para;</a></h3>
<p>If you try to <code>git push ....</code> you will encounter an error eventually leading you to the <a href="https://gitlab.k8s.cloud.statcan.ca/help/user/profile/account/two_factor_authentication.md#error-http-basic-access-denied-the-provided-password-or-token-">GitLab help documentation</a></p>
<p>You will need to make a Personal Access Token for this. To achieve this go in GitLab, click your profile icon and then hit <code>Preferences</code> and then <code>Access Tokens</code>
<img alt="image" src="https://user-images.githubusercontent.com/23174198/217061060-122dded8-dc80-46ce-a907-a85913cf5dd7.png" />
<img alt="Personal Access Tokens" src="https://user-images.githubusercontent.com/23174198/217061060-122dded8-dc80-46ce-a907-a85913cf5dd7.png" />
Follow the prompts entering the name, the token expiration date and granting the token permissions (I granted <code>write_repository</code>)</p>
<h3 id="step-5-personalize-git-to-be-you">Step 5: Personalize <code>Git</code> to be you<a class="headerlink" href="#step-5-personalize-git-to-be-you" title="Permanent link">&para;</a></h3>
<p>Run <code>git config user.email ....</code> and <code>git config user.name ...</code> to match your GitLab identity.</p>
<h3 id="step-6-supply-the-generated-token-when-asked-for-your-password">Step 6: Supply the Generated Token when asked for your password<a class="headerlink" href="#step-6-supply-the-generated-token-when-asked-for-your-password" title="Permanent link">&para;</a></h3>
<p>The token will by copy-able at the top once you hit <code>Create personal access token</code> at the bottom
<img alt="image" src="https://user-images.githubusercontent.com/23174198/217062846-03a715f1-ded5-4d80-ad4b-c647ae5e30fd.png" /></p>
<img alt="Supply Personal Access Token" src="https://user-images.githubusercontent.com/23174198/217062846-03a715f1-ded5-4d80-ad4b-c647ae5e30fd.png" /></p>
<p>Once you have prepared everything it's time
<img alt="image" src="https://user-images.githubusercontent.com/23174198/217063198-c1bd6c3a-ebc5-444d-98ba-24ef32faa20e.png" /></p>
<img alt="Final steps" src="https://user-images.githubusercontent.com/23174198/217063198-c1bd6c3a-ebc5-444d-98ba-24ef32faa20e.png" /></p>
<h3 id="step-7-see-the-results-of-your-hard-work-in-gitlab">Step 7: See the results of your hard work in GitLab<a class="headerlink" href="#step-7-see-the-results-of-your-hard-work-in-gitlab" title="Permanent link">&para;</a></h3>
<p><img alt="image" src="https://user-images.githubusercontent.com/23174198/217063990-efaa8e81-a0eb-4b6d-842e-2ca3112bb4f7.png" /></p>
<p><img alt="GitLab menu" src="https://user-images.githubusercontent.com/23174198/217063990-efaa8e81-a0eb-4b6d-842e-2ca3112bb4f7.png" /></p>



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ The AAW platform provides several types of storage:
Depending on your use case, either disk or bucket may be most suitable. Our [storage overview](../5-Storage/Overview.md) will help you compare them.

### Disks

[![Disks](../images/Disks.PNG)](../5-Storage/Disks.md)

<center>
[![Disks](../images/Disks.PNG)](../5-Storage/Disks.md)
</center>
**[Disks](../5-Storage/Disks.md)** are added to your notebook server by adding Data Volumes.

### Data Lakes (Coming Soon)
Expand Down
Loading

0 comments on commit 2a3e492

Please sign in to comment.