Showcase your pipeline

Requirements

In order to limit the content you need to edit and we need to host, the showcase automatically scrubs your pipeline repository using the Github API. Here is a list of the content it will search for you can act upon :

1. Your pipeline logo (if you have once, else we use the boilerplate Github logo).

   Here you have some options, but there are a few requirements. Its name must be prefixed by the name of your pipeline and end with the suffix -logo. It must be in PNG format. You also need to place it in a directory named assets. Your setup should look like this for a single logo to use across themes :

   • Directoryroot

     • Directoryassets

       • <pipeline_name>-logo.png

   However, the website uses a light and a dark theme for users convenience. If your logo contains colors that do not render well in a given theme, you can provide one for each :

   • Directoryroot

     • Directoryassets

       • <pipeline_name>-light-logo.png
       • <pipeline_name>-dark-logo.png

2. Github Topics. They appear as keywords in bullet in the detailled view.

3. An excerpt of the README, displayed as a description.

   Tip

   We only extract a few sentences from the first paragraph, excluding badges, titles, tables and images. Make it count !

4. The license users must follow when running the pipeline.

5. The tag of the last release.

Include your pipeline in the showcase

Using the browser

1. If you don’t own a fork of the website repository, naviguate to it in your browser and create one

   

2. On your forked repository page, naviguate to src/content/pipelines and click on the Add file button in the top right corner and select the Create new file option.

   

3. Name the new file <pipeline name>.yaml and edit its content to reflect the following :

   name: <name of the pipeline>
   organisation: <name of the host organisation on Github>
   documentation: <(optional) link to the pipeline's documentation website>

4. Commit your changes to a new branch on your fork, and open an Pull Request on the main website repository

Using a local clone

1. If you don’t own a fork of the website repository, naviguate to it in your browser, create one and clone it locally.

   

2. Create a new branch to host the code modifications.

3. Add a new file in src/content/pipelines, named <pipeline name>.yaml and edit its content to reflect the following :

   name: <name of the pipeline>
   organisation: <name of the host organisation on Github>
   documentation: <(optional) link to the pipeline's documentation website>

4. Commit your changes, push the branch and open an Pull Request on the main website repository