Introduction

If you are unfamiliar with GitHub pull requests (PRs), open a ticket you may also submit the necessary information as a ticket on the EWC Support Portal.

To formally submit an initial version of your Item, or to request the indexing of a followup version, you must fill all required information (also known as Item metadata) and share it with the EWC team.

Item Metadata

The key, at the top of an item's metadata, must be unique and match the value the `name` attribute.

A contact (email or URL) is required for successful submission.

We use YAML format to structure the required Item metadata. Take as example the metadata of the  "ECMWF Data Flavour" Item, published on GitHub:

(Item's Metadata Excerpt)

When preparing your own metadata, we recommend you to its example YAML contents and adapt the attribute values according to your case.
Please note that detailed information on all the supported metadata attributes, both required and optional, is also publicly available. The current version of the Items schema definition is hosted on GitHub, at https://github.com/ewcloud/ewc-community-hub/blob/main/schemas/items/v1alpha1.json.

Submission Steps

Once you have all the required information at hand, you may proceed to:

  1. Fork the EWC Community Hub repository
  2. Append your metadata to the catalog file, named items.yaml
  3. Validate your metadata (see details on the "Schema Validation" section of repository's README file)
  4. Submit the metadata by opening a pull request, between your fork and the main branch of official repository
  5. If you have submitted via pull request, assign one or two of the official repository maintainers for review

OR

Open a support ticket on the EWC Support Portal, including the metadata of your Item (in the aforementioned format), and let a support engineer open the pull request on your behalf.

Related Articles