Adding a sample to the catalog and repo

Dan Debrunner edited this page Mar 19, 2018 · 6 revisions
Clone this wiki locally

The samples catalog is a web page that allows you to search all the samples in this repository and also see related blog posts.

You have two options to add a sample.

  • You can create a pull request so that the sample will be hosted in this repository.
  • If the sample is already hosted in another repository on GitHub, you can also just add it to the catalog by opening an issue.

Regardless of the method you choose, here are the general guidelines as well as how to submit a sample for addition.

Get the sample ready

Make sure your sample project has a README.md file that contains information about the sample, including, but not limited to:

  • Supported streams versions
  • Instructions on how to run the sample (Any submission or compile time variables, ports, e.t.c that must be specified)
  • Dependencies, such as additional toolkits, or third party libraries that must be downloaded.
  • Streaming Analytics support: Can the sample be run in the Streaming Analytics service on IBM Cloud? If yes, would it be possible to include a .sabfile ready for deployment? Specify the location of the sab file within the project if you do.
  • Helpful comments in the code.

Cloud readiness:

If the sample cannot be run in the Streaming Analytics service on IBM Cloud as-is, are there some minor modifications that can be made to get it ready? Please look at some common obstacles and their workarounds on Streamsdev.

Submitting the sample

As was mentioned before, you can either create a pull request to add your sample to this repository or open an issue so that it is referenced in the catalog.

In your issue or pull request, please provide the following information:

  1. A descriptive name, not just the application name, e.g. "How to parse data in parallel using the Parse operator" is more informative than "ParallelParseApp" and brief summary of what the application does.
  2. Link to the related blog post on Streamsdev or elsewhere, if applicable.
  3. Toolkit(s) and operators used/demonstrated. Omit if no specialized toolkits are used.

We will review your pull request as quickly as possible! Thank you for contributing!