Skip to content

Commit

Permalink
docs: add a note about testing ourselves since it's complicated
Browse files Browse the repository at this point in the history
Also fixed typos.
  • Loading branch information
fharper committed Nov 15, 2023
1 parent 605007c commit 70c1fb6
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ The kubefirst GitOps Catalog repository is a community-driven series of cloud na

## Contributing



To make a new application available for installation, you'll need to:

- Fork this repository.
Expand All @@ -20,7 +22,7 @@ To make a new application available for installation, you'll need to:
- **website**: application website or GitHub repository.
- **imageUrl**: full web URL for the application's logo. It will be displayed in the GitOps catalog. _For now, it needs to be located on a third-party server, but we'll update this field to grab them from the GitHub repository soon, so it doesn't depend on external URL._
- **description**: an insightful description about your application. It will be displayed in the GitOps Catalog (200 characters maximum).
- **categories**: one category amongts the following ones:
- **categories**: one category amongst the following ones:
- App management
- Architecture
- CI/CD
Expand All @@ -46,7 +48,7 @@ We may remove an application from the GitOps Catalog with no notice if a severe

### Testing

If you want to test the application you are adding to the catalog, you need to run a couple of things locally.
If you want to test the application you are adding to the catalog, you need to run a couple of things locally. The process is a bit complicated, so feel free to submit a pull request without all the local tests, and we'll happily do the testing for you. If you want to proceed by yourself, follow these steps.

Firstly, if it's not already done, you need to [create a fork](https://github.com/kubefirst/kubefirst-api/fork) of the gitops-catalog repository.

Expand All @@ -72,4 +74,4 @@ If you already installed the application, to reinstall it another time without r

### Need Help

As always, we are on our [Slack community](https://kubefirst.io/slack) in the #gitops-catalog channel if you need any help. We also welcome any constructive feedback or feature suggestions.
As always, we are on our [Slack community](https://kubefirst.io/slack) in the #gitops-catalog channel if you need any help. We also welcome any constructive feedback, feature or application suggestions.

0 comments on commit 70c1fb6

Please sign in to comment.