Skip to content

Commit

Permalink
Added Education tab (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
arpita0911patel authored Sep 28, 2023
2 parents 2b276b1 + 46a4a34 commit e9a1b40
Show file tree
Hide file tree
Showing 10 changed files with 108 additions and 4 deletions.
70 changes: 70 additions & 0 deletions contibute.md
Original file line number Diff line number Diff line change
@@ -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 : [email protected] 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 ([email protected])
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "NextGen Framework",
"position": 1
"position": 2
}
4 changes: 4 additions & 0 deletions docs/education/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Education",
"position": 3
}
4 changes: 4 additions & 0 deletions docs/education/data-science/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Data Science",
"position": 1
}
11 changes: 11 additions & 0 deletions docs/education/data-science/datascience.md
Original file line number Diff line number Diff line change
@@ -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
<a href="https://github.com/whitelightning450/AWS_Scripts">AWS Data Science Tools</a>
:::
3 changes: 1 addition & 2 deletions docs/products/products-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/services/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Cloud Services",
"position": 2
}
6 changes: 6 additions & 0 deletions docs/services/services.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 1
---
# CIROH Cloud Services

Details about the existing CIROH Cloud Services and how to get access to it.
8 changes: 7 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,20 @@ const config = {
type: 'doc',
docId: 'services/google/google',
position: 'left',
label: 'Google Services',
label: '2i2c JupyterHub (GCP)',
},
{
type: 'doc',
docId: 'services/aws/aws',
position: 'left',
label: 'AWS Services',
},
{
type: 'doc',
docId: 'education/data-science/datascience',
position: 'left',
label: 'Education',
},
{
href: 'https://ciroh.org',
label: 'ciroh.org',
Expand Down

0 comments on commit e9a1b40

Please sign in to comment.