Skip to content

Commit

Permalink
docs(linker): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
d4x1 committed May 28, 2024
1 parent fd88b22 commit c232144
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/Plugins/linker.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@ This document comprehensively explains Linker and provides guidance on implement

## Summary

Just like the DORA plugin, the linker works on the domain layer and attempts to link domain layer data.
Just like the DORA plugin, the linker works on the domain layer and attempts to link the domain layer data.

For example, in the current version, the linker uses regular expressions to extract issue_keys from pull requests' titles and description fields,
and it tries to relate existing issues, storing the relations in the `pull_request_issues` table.
For example, in the current version, the linker uses regular expressions to extract issue_keys from pull requests' title and description fields, and it tries to relate existing issues with PRs, storing the relations in the `pull_request_issues` table.


## Supported Versions
The linker was added in release v1.0.0-beta10 and has been available ever since.

## Configuration
You can find the project settings page by clicking on the 'Settings' tab in the project overview.
You can find it on the project settings page.
![](/img/Plugins/linker-configuration.png)

0 comments on commit c232144

Please sign in to comment.