From 70c1fb6a77ec3e1f12d199b9f53d8ac941e4a3d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Harper?= Date: Wed, 15 Nov 2023 16:42:59 -0500 Subject: [PATCH 1/2] docs: add a note about testing ourselves since it's complicated Also fixed typos. --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3492621..951b2f0 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 @@ -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. @@ -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. From 73b80fd67a66522ad5d74ba6e994b206c54742dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Harper?= Date: Wed, 15 Nov 2023 18:44:29 -0500 Subject: [PATCH 2/2] fix Markdown --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 145bb43..78b363d 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,6 @@ 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.