CONTRIBUTING.md

Contributing Guidelines

Thanks for your interest in contributing to odh-deployer.

Is this your first contribution?

Please take a few minutes to read GitHub's guide on How to Contribute to Open Source. It's a quick read, and it's a great way to introduce yourself to how things work behind the scenes in open-source projects.

Documentation

If you want to update documentation, README.md is the file you're looking for.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

How to contribute code to odh-deployer

• Configure name and email in git
• Fork this repo
• In your fork, create a branch for your feature
• Sign off your commit using the -s, --signoff option. Write a good commit message (see How to Write a Git Commit Message)
• Push your changes
• Send a PR to odh-deployer using GitHub's web interface
• We are using OpenShift CI to control merges to the deployer repository. PRs will automatically be merged when the following conditions are met:
  • A lgtm label has been added by a reviewer
  • An approved label has been added by an approver
  • The OWNERS_ALIASES file of the repository has a list of the people who can review, approve, and qe-approve PRs.

Testing the PR

• Test the changes locally, by manually running the deploy.sh script from the terminal. This definitely helps in that initial rapid iteration phase.
• Create a RHODS-live image based on the changes made. (See steps on how to build a RHODS image using rhods-live-builder)
• Use the image to install RHODS operator on an OpenShift cluster (See steps on how to install a RHODS instance on an OpenShift cluster)
• Test the changes over this installed RHODS operator to see if they work as expected.

ISV Contribution

ISV partners can contribute in this repo to display documentation in RHODS

Resource definition

In order to contribute to RHODS, we currently support three different object definitions to display different data:

• OdhApplication: Describe the Application Title displayed in the ISV section.
• OdhDocument: Represent documentation such as tutorials.
• OdhQuickStart: Quickstart definition (you can find templates here).

Preview

To preview the code output, we recommend using the quickstarts-preview extension in VS Code. The steps to run it are:

1. Install the extension in VSCode.
2. Open the desired resource file.
3. Open the command palette (Ctrl+Shift+P / Command+Shift+P) and search for Quick Starts: Preview.
4. You'll see a preview of the code in the right side of the screen.

Deployment

In order to contribute, just add the desired changes in the documentation and raise a new PR for our team to review it.

The docs are held in the following path, /odh-dashboard, in one of these three folders:

• apps: For installations on both managed and self-managed env.
• apps-managed-service: Only for installations on managed env .
• apps-on-prem: Only for installations on self-managed env.

The steps to add new information are:

1. Set up this project locally following the steps mentioned in the how to contribute section.
2. Create or modify one of the isv folders inside the path mentioned above.
3. If you are creating a new folder, add it to kustomization.yaml file in one of the two folders mentioned above.
4. Create a PR with the changes.
5. Attach the Jira Link to the PR.