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.
-
To view existing documentation links, click the More options icon
> View documentation.
-
To add a pipeline documentation link:
a. Click the More options icon
> Add documentation link.
b. Provide the link and click Save.
If you want to add documentation links to more pipelines:
- Check boxes next to the pipelines to which you want to add a documentation link.
- Click Add documentation link that appears on the Filters toolbar.
- Provide the link and click Save.
Editing a pipeline documentation link
To edit a documentation link:
- For the selected pipeline, click the More options icon
> Edit documentation link. The button is displayed only for the pipelines with links attached.
- Provide the changes. Click Save.
Deleting a pipeline documentation link
To delete a pipeline documentation link:
- For the selected pipeline, click the More options icon
> Edit documentation link.
- Click the Delete icon
next to the link.
- Click Save.