Adding comments to a data pipeline

Starting in 6.4.0, you can add comments to a data pipeline in draft mode. You can add a comment to the pipeline and you can add comments to each plugin in the pipeline.

For example, you might want to add a comment to the data pipeline to share development notes. You might want to add comments to document how the data is transformed at each stage in the pipeline.

Comments are stored in the pipeline configuration and appear in the json for the pipeline. While you’re developing a pipeline, you can add, edit, and delete comments in the pipeline. After you deploy the pipeline, you can view the comments, but you cannot add, edit, or delete the comments.

Want to watch the video?

Adding a comment to a data pipeline

You can add a comment to a pipeline by selecting the Comments icon:

Adding a comment to a plugin

You can add comments to a plugin by right-clicking the plugin, selecting Comments from the plugin hamburger menu, or selecting the Comments icon from the Properties page of a plugin.

To add comments to a plugin in a data pipeline, follow these steps:

  1. Right-click a plugin in a data pipeline or select Comments from the hamburger menu.

  2. Select Add a comment.

  3. Type a comment and click Comment to save it.

Editing and deleting comments

After you save the comment, you can edit or delete it. Click the comments box, and then click the three dots in the upper right corner:

Viewing comments in a deployed pipeline

You can view comments in a deployed pipeline. You cannot edit or delete comments in a deployed pipeline. To view comments, click the comments box: