Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.81 KB

CONTRIBUTION.md

File metadata and controls

45 lines (29 loc) · 2.81 KB
Raw

Contributing

Thanks for contributing to our FlexiHPC User guides repository. Below are ways you can help make the these user guides better.

The easiest way for you to help us is by raising an issue, which will require a GitHub account. For amendments to the documentation, you will need to be familiar with general Git concepts if you'd like to commit substantial changes or even whole new user guides, you will be required to set up the preview environment.

Raise an issue

The easiest way to help improve our user guides is by raising an issue in our repository at https://github.com/nesi/research-developer-cloud

If you find an issues that needs to be resolved, please have a look through the list of existing issues to see whether your issues hasn't already been reported. If it has, or a closely related issues exists, please add your comments to the existing issue.

If your issue isn't already listed, then create a New Issue. Provide details of your suggestion and include the user guide and url to which your suggestion applies. One of our team members will review your suggestion and resolve it if they can. They may contact you if they need some more clarification.

Making changes

If you would like to make a minor or substantial contribution, you'll need to ensure you have Git and python installed.

Checking out the code

For minor or substantial edits, you will need to clone the repsitory of the documentation source code. This can be done using the Git command:

git clone https://github.com/nesi/flexi-docs.git

Minor edits via github.com

Looking to make a minor edit, read our guide Minor Edits to help contribute.

Substantial edits and new user guides

To contribute substantial edits or new user guides, we recommend that you Setting up a local development environment, so you can visualise and fine tune your work before you submit it for review. You'll need some of your git skills with this.

  • Follow the Contribution Workflow to create a fork and clone to your local.
  • Step through the setup routine (Here) to set up your computer for local previews of your edits.
  • Make the edits using your favourite markdown editor.
  • Commit your changes to your branch.
  • Preview your changes using the local preview server that you set up above.
  • When you are happy with your edits or additions, commit your changes to the github repo.
  • Create a PR from your fork into the main on the github site

Please be prepared to answer questions about your edits and make additional commits.

Markdown styles and references

All markdown references can be found at the Material for MkDocs reference page.