Working with pipeline documentation links

You can add pipeline documentation links to associate a pipeline with its corresponding internal documentation page.

Documentation links can help jump-start the debugging process for an alert because they enable users to access internal documentation from the Databand alert details. You can perform the following actions on documentation links:

Adding and viewing pipeline documentation links

When you add a documentation link, it gets added to the details of any triggered alerts on the Alerts page of the associated pipelines.

To add or view pipeline documentation links, navigate to the pipeline you want to view or add documentation links to and complete the relevant step

  • To view existing documentation links, click the More options icon More options > View documentation.
  • To add a pipeline documentation link:
    1. Click the More options icon More options > Add documentation link.
    2. Provide the link and click Save.
If you want to add documentation links to more pipelines:
  1. Check the boxes next to the pipelines to which you want to add a documentation link.
  2. Click Add documentation link, which appears on the Filters toolbar.
  3. Provide the link and click Save.

Editing a pipeline documentation link

To edit a documentation link:
  1. For the selected pipeline, click the More options icon More options > Edit documentation link. The button is displayed only for the pipelines with links attached.
  2. Provide the changes, then click Save.

Deleting a pipeline documentation link

To delete a pipeline documentation link:
  1. For the selected pipeline, click the More options icon More options > Edit documentation link.
  2. Click the Delete icon Delete next to the link.
  3. Click Save.