diff --git a/contibute.md b/contibute.md deleted file mode 100644 index d1a4eab..0000000 --- a/contibute.md +++ /dev/null @@ -1,70 +0,0 @@ -# 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/education/education.md b/docs/education/education.md new file mode 100644 index 0000000..56f1f1b --- /dev/null +++ b/docs/education/education.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 1 +--- +# Education and Training Materials + +Educational portal to tutorials, guides, and other informational materials. + +- Data Science +- NextGen Framework \ No newline at end of file diff --git a/docs/products/_category_.json b/docs/products/_category_.json index b5f9a92..18e0e34 100644 --- a/docs/products/_category_.json +++ b/docs/products/_category_.json @@ -1,4 +1,4 @@ { - "label": "Documentation", + "label": "CIROH Products", "position": 1 } \ No newline at end of file diff --git a/docs/products/products-intro.md b/docs/products/products-intro.md index 20f9322..5a36e79 100644 --- a/docs/products/products-intro.md +++ b/docs/products/products-intro.md @@ -2,11 +2,11 @@ sidebar_position: 0 --- -# CIROH Products +# Products 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: +CIROH Open Source Projects using Cloud Infrastructure: - NextGen In A Box - Advancing Snow Model - Streamflow Evaluation Tool diff --git a/docs/services/services.md b/docs/services/services.md index 50bda67..3fc596d 100644 --- a/docs/services/services.md +++ b/docs/services/services.md @@ -3,4 +3,7 @@ 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 +Details about the existing CIROH Cloud Services and how to get access to it. + +- AWS Cloud Services +- 2i2c JupyterHub (GCP) Cloud Services \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 2586cf6..eadb26c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -60,26 +60,20 @@ const config = { type: 'doc', docId: 'products/products-intro', position: 'left', - label: 'Documentation', - }, - { - type: 'doc', - docId: 'services/google/google', - position: 'left', - label: '2i2c JupyterHub (GCP)', - }, + label: 'Products', + }, { type: 'doc', - docId: 'services/aws/aws', + docId: 'services/services', position: 'left', - label: 'AWS Services', + label: 'Cloud Services', }, { type: 'doc', - docId: 'education/data-science/datascience', + docId: 'education/education', position: 'left', label: 'Education', - }, + }, { href: 'https://ciroh.org', label: 'ciroh.org', @@ -91,8 +85,8 @@ const config = { position: 'right', }, { - href: '/contact', - label: 'Contact us', + href: '/Contribute', + label: 'How to contribute', position: 'right', }, { diff --git a/src/pages/contact.md b/src/pages/contact.md deleted file mode 100644 index e597845..0000000 --- a/src/pages/contact.md +++ /dev/null @@ -1,12 +0,0 @@ -# Contact Us - -## Email us - -For general inquiries, contact us at : 'ciroh-it-admin@ua.edu' - -Have a content to add to this docusite contact us at : 'ciroh-it-admin@ua.edu' - - -## CIROH Slack channel - -Connect with us on CIROH Slack channel : ciroh-ua-it-admin \ No newline at end of file diff --git a/src/pages/contribute.md b/src/pages/contribute.md new file mode 100644 index 0000000..9222f98 --- /dev/null +++ b/src/pages/contribute.md @@ -0,0 +1,89 @@ +# How to Contribute Code? + +Thank you for your interest in contributing to the CIROH technical documentation site! We welcome contributions in various forms, whether it's commenting on and adding CIROH project details or submitting pull requests (PRs). In this guide, we'll walk you through the process of contributing code to the CIROH Docusite. + +Our website is constructed using [Docusaurus](https://docusaurus.io/), a modern static website generator. + +## Major Changes + +For significant changes, please follow these steps: + +1. Before contributing to this repository, start by opening an issue ticket and creating a new issue. +2. On the issue ticket, navigate to the "Development" section and click on "Create a branch." +3. Create a new branch and check it out locally. +4. Implement your changes within the branch, commit them, and push them to the branch you created in Step 3. + - Please note: Follow the subsequent steps to test your changes locally. +5. Open a Pull Request, and after review by an admin, it will be merged into the main branch. +6. GitHub Actions will automatically trigger and update the site. + +## Minor Changes + +For minor changes, follow these steps: + +1. Visit [docs.ciroh.org](https://docs.ciroh.org) and proceed with the following actions: +2. Click on "Edit page" to add new content. +3. Create a Pull Request. +4. Your changes will be reviewed and merged by an admin. + +If you encounter any issues or have questions, please don't hesitate to send an email to ciroh-it-admin@ua.edu. We appreciate your contributions! + + +========================================= + +### 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) + +## Email us + +For general inquiries, contact us at : 'ciroh-it-admin@ua.edu' + +Have a content to add to this docusite contact us at : 'ciroh-it-admin@ua.edu' + + +## CIROH Slack channel + +Connect with us on CIROH Slack channel : ciroh-ua-it-admin \ No newline at end of file