-
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.
Added steps on how to contribute (#12)
- Loading branch information
Showing
8 changed files
with
113 additions
and
100 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,9 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
# Education and Training Materials | ||
|
||
Educational portal to tutorials, guides, and other informational materials. | ||
|
||
- Data Science | ||
- NextGen Framework |
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": "Documentation", | ||
"label": "CIROH Products", | ||
"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
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
This file was deleted.
Oops, something went wrong.
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,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 |