Skip to main content

Contributing to CIROH DocuHub

Thank you for your interest in contributing to CIROH's DocuHub, our technical documentation site! Whether you're commenting on project information or submitting a pull request, we appreciate all kinds of contributions. This guide will help you understand the process of contributing code to the CIROH DocuHub.

Our website is constructed using Docusaurus, a modern static website generator.

Contributing simple changes to DocuHub

Visit the Documentation

1. Visit the documentation

Visit docs.ciroh.org and navigate to the page you wish to modify.

Edit page

2. Edit page

Click on "Edit page" at the bottom of the page to make any necessary changes.

Submit a pull request

3. Submit a Pull Request

Submit a pull request with your changes to the repository.

Submitting a blog post to DocuHub

Write your blog post

1. Write your blog post

Blog posts submitted to CIROH DocuHub should discuss projects that make use of CIROH's cyberinfrastructure.

Pull Request Template

2. Fill out the issue template

Click the button below to access and fill out the blog post issue template with your project's information and the content of your blog post.

Submit the request form

3. Submit the request form

Submit the filled-out issue template for your blog posts. CIROH's tech team will review your PR for publishing shortly.

Requesting a product page on DocuHub

Upload your project to GitHub

1. Upload your project to GitHub

Ensure that your project is publicly visible on GitHub and includes an informative README.md file.

Pull Request Template

2. Fill out the issue template

Click the button below to access and fill out the product page issue template with your project's information.

Submit the request form

3. Submit the request form

Submit the filled-out issue template for your product. CIROH's tech team will review your submission shortly.

For developers

If you'd like to get more closely involved with DocuHub's development, please see the subpages below:

Help and support

If you have any questions or issues contributing, please don't hesitate to reach out via Slack or email.

Contact us