---

The streamsx.documentation is a community-based documentation project for IBM Streams. The goal of the project is to provide easy-to-follow documentation and development guides to help users get started with Streams.

Contents

IBM Streams: Java Support

• Java Application API Development Guide
• Java Operator Development Guide

IBM Streams: Python Support

• Developing applications (v1.6)   (v1.4)
• API reference (v1.6)

IBM Streams: Scala Support

• Developing applications

IBM Streams 4.2

• Introduction to Streams v4.2 Quick Start Edition (QSE)
• Getting Started with IBM Streams v4.2 Quick Start Edition
• Installing Streams Quick Start Edition VM Image
• Installing the Streams Quick Start Edition for Linux
• IBM Streams and Data Governance
  • IBM Streams Data Governance Quickstart
• Cybersecurity Toolkit
  • Cybersecurity Toolkit - Getting Started
  • Cybersecurity Toolkit Migration Guide (v1.0.0 -> v2.0.0)
• Messaging Toolkit
  • Getting Started with JMS operators
  • Getting Started with Kafka Operators
  • WebSphere MQ - Sample steps for creating queues and bindings file

IBM Streams 4.1

• Documentation for IBM Streams v4.1

SPL Samples For Beginners

• IBM Streams Samples Catalog
• Over 100 useful SPL Samples for Beginners

Streams Product Documentation

• Streams Product Documentation (versions 1.2.1 - current)

Need Help with IBM Streams?

1. Ask your questions on Streams Forum
2. If project is on IBM Streams Github, open an issue to the related project.
3. Ask your questions on StackOverflow

Contributing

If you have ideas on how we can better document or explain some of the concepts, we would love to have your contribution! The streamsx.documentation site uses Github Pages and Jekyll markdown for our documentation.

Refer to this documentation on Github Markdown: Writing on Github

Refer to this documentation to get started: Using Jekyll with Pages

To contribute, clone this project locally, make your changes, and create a pull request. You can also click on the “Edit Me” button, then click on “Edit this file” to make changes right in your browser.

To learn more on how to do this, refer to this documentation: Contribute to IBM Streams Github Project

Providing Feedback

To provide feedback on our documentation:

1. Navigate to the documentation page that you would like to provide feedback for.
2. Click on the Feedback button in the top right corner.

This will open an issue for the page that you are currently visiting.

New Documentation

To request new documentation, please open an issue here: