Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add characters limits for displayName & description #18

Merged
merged 1 commit into from
Sep 6, 2023
Merged

docs: add characters limits for displayName & description #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ To make a new application available for installation, you'll need to:
- Fork this repository.
- Add a new entry to the [index.yaml](index.yaml) file with:
- **name**: application name as described in your YAML file.
- **displayName**: name to be displayed in the GitOps catalog.
- **displayName**: name to be displayed in the GitOps catalog (120 characters maximum).
- **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.
- **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:
- App management
- Architecture
Expand Down
6 changes: 3 additions & 3 deletions index.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ apps:
displayName: Argo Events
website: "https://github.com/argoproj/argo-events"
imageUrl: "https://argoproj.github.io/argo-events/assets/logo.png"
description: "Argo Events is an event-driven workflow automation framework for Kubernetes which helps you trigger K8s objects, Argo Workflows, Serverless workloads, etc. on events from a variety of sources like webhooks, S3, schedules, messaging queues, gcp pubsub, sns, sqs, etc"
description: "Argo Events is an event-driven workflow automation framework for Kubernetes which helps you trigger K8s objects, Argo Workflows, Serverless workloads, etc. on events from a variety of sources."
categories:
- CI/CD

- name: argo-rollouts
displayName: Argo Rollouts
website: "https://github.com/argoproj/argo-rollouts"
imageUrl: "https://argoproj.github.io/static/3748e3a7881fe3b037f2401b65943dc0/93d75/rollouts.png"
description: "Argo Rollouts is a Kubernetes controller and set of CRDs which provide advanced deployment capabilities such as blue-green, canary, canary analysis, experimentation, and progressive delivery features to Kubernetes."
description: "A Kubernetes controller & set of CRDs which provide advanced deployment capabilities such as blue-green, canary, canary analysis, experimentation, & progressive delivery features to Kubernetes."
categories:
- CI/CD

Expand Down Expand Up @@ -49,7 +49,7 @@ apps:
displayName: Kubernetes Dashboard
website: "https://github.com/kubernetes/dashboard"
imageUrl: "https://raw.githubusercontent.com/kubernetes/kubernetes/master/logo/logo.svg"
description: "Kubernetes Dashboard is a general purpose, web-based UI for Kubernetes clusters. It allows users to manage applications running in the cluster and troubleshoot them, as well as manage the cluster itself."
description: "Kubernetes Dashboard is a general purpose, web-based UI for Kubernetes clusters. It allows users to manage apps running in the cluster & troubleshoot them, as well as manage the cluster itself."
categories:
- Observability

Expand Down