diff --git a/contibute.md b/contibute.md new file mode 100644 index 0000000..d1a4eab --- /dev/null +++ b/contibute.md @@ -0,0 +1,70 @@ +# How to Contribute Code + +Thank you for your interest in contributing to CIROH technical documentation site! From commenting on and adding CIROH project details and sending PRs, all contributions are welcome. In this document, we'll cover the steps to contributing code to CIROH Docusite. + +This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. + +For major changes: + 1. When contibuting to this repository, please first open an issue ticket and submit new issue. + 2. On the Issue ticket, under Development click on "Create a branch". + 3. Create a new branch and checkout locally. + 4. Make your changes in the branch and commit the changes. + NOTE: Follow the steps below to test the changes locally. + +For a minor changes: + Go to "docs.ciroh.org" and follow the steps below: + + - Click on Edit page for adding new content. + - Create a Pull Request. + - Changes will be reviewed and Merged by admin. + +Send email to : ciroh-it-admin@ua.edu if anything. + +========================================= + +### Steps to test the changes in local machine: + +1. Download and Install node js LTS version from https://nodejs.org/en if not already installed. + +2. How to build and run this project locally. + +``` +npm install +npm run build +npm run start +``` + +### Local Development + +``` +$ npm run start +``` + +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. + +### Build + +``` +$ npm run build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. + +### Deployment + +To deploy the website, we need to compile this project to deployable package. + +``` +$ npm run build +``` + +above command will create **build** directory in your project folder. We can now deploy the content of that directory to the web server. + +### Cheatsheet + +- [markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) +- [tina.io](https://tina.io/) +- [Infima](https://infima.dev/docs/getting-started/introduction) + +### Contributors +- Arpita Patel (apatel54@ua.edu) diff --git a/docs/products/NextGen Framework/NWM-intro.md b/docs/education/NextGen Framework/NWM-intro.md similarity index 100% rename from docs/products/NextGen Framework/NWM-intro.md rename to docs/education/NextGen Framework/NWM-intro.md diff --git a/docs/products/NextGen Framework/_category_.json b/docs/education/NextGen Framework/_category_.json similarity index 67% rename from docs/products/NextGen Framework/_category_.json rename to docs/education/NextGen Framework/_category_.json index c27f375..f4be030 100644 --- a/docs/products/NextGen Framework/_category_.json +++ b/docs/education/NextGen Framework/_category_.json @@ -1,4 +1,4 @@ { "label": "NextGen Framework", - "position": 1 + "position": 2 } \ No newline at end of file diff --git a/docs/education/_category_.json b/docs/education/_category_.json new file mode 100644 index 0000000..84cd91f --- /dev/null +++ b/docs/education/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Education", + "position": 3 +} \ No newline at end of file diff --git a/docs/education/data-science/_category_.json b/docs/education/data-science/_category_.json new file mode 100644 index 0000000..23a3051 --- /dev/null +++ b/docs/education/data-science/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Data Science", + "position": 1 +} \ No newline at end of file diff --git a/docs/education/data-science/datascience.md b/docs/education/data-science/datascience.md new file mode 100644 index 0000000..5de086f --- /dev/null +++ b/docs/education/data-science/datascience.md @@ -0,0 +1,11 @@ +--- +sidebar_position: 1 +--- + +# AWS Data Science Tools + +A collection of Amazon Web Services (AWS) scripts supporting Water Data Science. This repository can serve as a resoruces for those looking to connect and leverage the power of AWS products, specifically AWS S3 storage. + +:::info +AWS Data Science Tools +::: diff --git a/docs/products/products-intro.md b/docs/products/products-intro.md index 555fd09..20f9322 100644 --- a/docs/products/products-intro.md +++ b/docs/products/products-intro.md @@ -7,8 +7,7 @@ sidebar_position: 0 CIROH scientists and engineers work to improve the understanding of hydrologic processes, operational hydrologic forecasting techniques and workflows, community water modeling, translation of forecasts to actionable products, and use of water predictions in decision making. CIROH Open Source Projects: -- NextGen Framework - - NextGen In A Box +- NextGen In A Box - Advancing Snow Model - Streamflow Evaluation Tool - RTI Evaluation diff --git a/docs/services/_category_.json b/docs/services/_category_.json new file mode 100644 index 0000000..e304bfc --- /dev/null +++ b/docs/services/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Cloud Services", + "position": 2 +} \ No newline at end of file diff --git a/docs/services/services.md b/docs/services/services.md new file mode 100644 index 0000000..50bda67 --- /dev/null +++ b/docs/services/services.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 1 +--- +# CIROH Cloud Services + +Details about the existing CIROH Cloud Services and how to get access to it. \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 1a37ab6..2586cf6 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -66,7 +66,7 @@ const config = { type: 'doc', docId: 'services/google/google', position: 'left', - label: 'Google Services', + label: '2i2c JupyterHub (GCP)', }, { type: 'doc', @@ -74,6 +74,12 @@ const config = { position: 'left', label: 'AWS Services', }, + { + type: 'doc', + docId: 'education/data-science/datascience', + position: 'left', + label: 'Education', + }, { href: 'https://ciroh.org', label: 'ciroh.org',