-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
108 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]) |
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
...roducts/NextGen Framework/_category_.json → ...ucation/NextGen Framework/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
{ | ||
"label": "NextGen Framework", | ||
"position": 1 | ||
"position": 2 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Education", | ||
"position": 3 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Data Science", | ||
"position": 1 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Cloud Services", | ||
"position": 2 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters