Skip to content

Commit

Permalink
Merge branch 'master' of github.com:MaastrichtU-IDS/dsri-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chriskuipers committed May 30, 2024
2 parents 49a141e + af12e32 commit aa7574a
Show file tree
Hide file tree
Showing 10 changed files with 52 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ v3-website/yarn.lock
v3-website/node_modules
v3-website/i18n/*
v3-website/package-lock.json
website/static/img/Thumbs.db

# Docusaurus v2:
/node_modules
Expand All @@ -42,3 +43,4 @@ build
npm-debug.log*
yarn-debug.log*
yarn-error.log*

8 changes: 8 additions & 0 deletions website/docs/catalog-utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ Start Ubuntu with the `root` user which has `sudo` permissions to install anythi

You can start the application using the **Ubuntu** template in the [Catalog web UI](https://console-openshift-console.apps.dsri2.unimaas.nl/catalog) (make sure the **Templates** checkbox is checked)

:::info Login Credentials

Username: **root**

Password: **Template creation password**

:::

This template uses the Ubuntu image hosted on DockerHub, see its documentation at https://hub.docker.com/r/ubuntu

:::info Persistent data folder
Expand Down
18 changes: 17 additions & 1 deletion website/docs/deploy-jupyter.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,20 @@ You can also enable and use the [JupyterLab Git extension](https://github.com/ju
It will prompt you for a username and password if the repository is private.
<img src="https://raw.githubusercontent.com/jupyterlab/jupyterlab-git/master/docs/figs/preview.gif" alt="JupyterLab Git extension" style={{maxWidth: '100%', maxHeight: '100%'}} />
<img src="https://raw.githubusercontent.com/jupyterlab/jupyterlab-git/master/docs/figs/preview.gif" alt="JupyterLab Git extension" style={{maxWidth: '100%', maxHeight: '100%'}} />
### 🐶 Example
Initialize repository
<img src="/img/sample_git_page.png" alt="Initialize repo" style={{maxWidth: '100%', maxHeight: '100%'}} />
Include git details in DSRI project setup
<img src="/img/sample_git_details_jupyter.png" alt="git details" style={{maxWidth: '100%', maxHeight: '100%'}} />
Verify automatic deployment
<img src="/img/sample_workspace.png" alt="workspace" style={{maxWidth: '100%', maxHeight: '100%'}} />
<img src="/img/sample_requirements.png" alt="requirements" style={{maxWidth: '100%', maxHeight: '100%'}} />
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ module.exports={
"image": "img/undraw_online.svg",
"footer": {
"links": [],
"copyright": "Copyright © 2022 <a href='https://maastrichtuniversity.nl/ids' target='_blank' rel='noopener noreferrer'>Institute of Data Science</a> at Maastricht University",
"copyright": `Copyright © ${new Date().getFullYear()} <a href='https://maastrichtuniversity.nl/ids' target='_blank' rel='noopener noreferrer'>Institute of Data Science</a> at Maastricht University`,
"logo": {
"src": "img/favicon.ico",
"href": "https://maastrichtuniversity.nl/"
Expand Down
1 change: 1 addition & 0 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
},
"devDependencies": {
"@types/node": "^17.0.9",
"react-native-dotenv": "^3.4.11",
"remarkable-extlink": "^1.1.0"
},
"dependencies": {
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/static/img/sample_git_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/static/img/sample_requirements.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/static/img/sample_workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 23 additions & 1 deletion website/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2420,13 +2420,15 @@
"@docusaurus/plugin-content-docs" "2.1.0"
"@docusaurus/plugin-content-pages" "2.1.0"
"@docusaurus/plugin-debug" "2.1.0"
"@docusaurus/plugin-google-analytics" "2.1.0"
"@docusaurus/plugin-google-gtag" "2.1.0"
"@docusaurus/plugin-sitemap" "2.1.0"
"@docusaurus/theme-classic" "2.1.0"
"@docusaurus/theme-common" "2.1.0"
"@docusaurus/theme-search-algolia" "2.1.0"
"@docusaurus/types" "2.1.0"

"@docusaurus/[email protected]", "react-loadable@npm:@docusaurus/[email protected]":
"@docusaurus/[email protected]":
version "5.5.2"
resolved "https://registry.yarnpkg.com/@docusaurus/react-loadable/-/react-loadable-5.5.2.tgz#81aae0db81ecafbdaee3651f12804580868fa6ce"
integrity sha512-A3dYjdBGuy0IGT+wyLIGIKLRE+sAk1iNk0f1HjNDysO7u8lhL4N3VEm+FAubmJbAztn94F7MxBTPmnixbiyFdQ==
Expand Down Expand Up @@ -5101,6 +5103,11 @@ [email protected]:
dependencies:
dotenv-defaults "^1.0.2"

dotenv@^16.4.5:
version "16.4.5"
resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-16.4.5.tgz#cdd3b3b604cb327e286b4762e13502f717cb099f"
integrity sha512-ZmdL2rui+eB2YwhsWzjInR8LldtZHGDoQ1ugH85ppHKwpUHL7j7rN0Ti9NCnGiQbhaZ11FpR+7ao1dNsmduNUg==

dotenv@^6.2.0:
version "6.2.0"
resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-6.2.0.tgz#941c0410535d942c8becf28d3f357dbd9d476064"
Expand Down Expand Up @@ -7981,6 +7988,21 @@ react-loadable-ssr-addon-v5-slorber@^1.0.1:
dependencies:
"@babel/runtime" "^7.10.3"

"react-loadable@npm:@docusaurus/[email protected]":
version "5.5.2"
resolved "https://registry.yarnpkg.com/@docusaurus/react-loadable/-/react-loadable-5.5.2.tgz#81aae0db81ecafbdaee3651f12804580868fa6ce"
integrity sha512-A3dYjdBGuy0IGT+wyLIGIKLRE+sAk1iNk0f1HjNDysO7u8lhL4N3VEm+FAubmJbAztn94F7MxBTPmnixbiyFdQ==
dependencies:
"@types/react" "*"
prop-types "^15.6.2"

react-native-dotenv@^3.4.11:
version "3.4.11"
resolved "https://registry.yarnpkg.com/react-native-dotenv/-/react-native-dotenv-3.4.11.tgz#2e6c4eabd55d5f1bf109b3dd9141dadf9c55cdd4"
integrity sha512-6vnIE+WHABSeHCaYP6l3O1BOEhWxKH6nHAdV7n/wKn/sciZ64zPPp2NUdEUf1m7g4uuzlLbjgr+6uDt89q2DOg==
dependencies:
dotenv "^16.4.5"

react-router-config@^5.1.1:
version "5.1.1"
resolved "https://registry.yarnpkg.com/react-router-config/-/react-router-config-5.1.1.tgz#0f4263d1a80c6b2dc7b9c1902c9526478194a988"
Expand Down

0 comments on commit aa7574a

Please sign in to comment.