Skip to content

Commit

Permalink
Added steps on how to contribute (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
arpita0911patel authored Sep 28, 2023
2 parents e9a1b40 + f5b739b commit f80964e
Show file tree
Hide file tree
Showing 8 changed files with 113 additions and 100 deletions.
70 changes: 0 additions & 70 deletions contibute.md

This file was deleted.

9 changes: 9 additions & 0 deletions docs/education/education.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 1
---
# Education and Training Materials

Educational portal to tutorials, guides, and other informational materials.

- Data Science
- NextGen Framework
2 changes: 1 addition & 1 deletion docs/products/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Documentation",
"label": "CIROH Products",
"position": 1
}
4 changes: 2 additions & 2 deletions docs/products/products-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion docs/services/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,7 @@ sidebar_position: 1
---
# CIROH Cloud Services

Details about the existing CIROH Cloud Services and how to get access to it.
Details about the existing CIROH Cloud Services and how to get access to it.

- AWS Cloud Services
- 2i2c JupyterHub (GCP) Cloud Services
22 changes: 8 additions & 14 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -91,8 +85,8 @@ const config = {
position: 'right',
},
{
href: '/contact',
label: 'Contact us',
href: '/Contribute',
label: 'How to contribute',
position: 'right',
},
{
Expand Down
12 changes: 0 additions & 12 deletions src/pages/contact.md

This file was deleted.

89 changes: 89 additions & 0 deletions src/pages/contribute.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]. 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 ([email protected])

## Email us

For general inquiries, contact us at : '[email protected]'

Have a content to add to this docusite contact us at : '[email protected]'


## CIROH Slack channel

Connect with us on CIROH Slack channel : ciroh-ua-it-admin

0 comments on commit f80964e

Please sign in to comment.