mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
Link and formatting fix (#101243)
* docs: ✏️ make "Risk Matrix" link absolute The page can be rendered in different environments, so we should have this link absolute so that it always works, for example, it would not work in PRs themselves. * docs: ✏️ remove formatting breaks In PRs Markdown formatting breaks are rendered incorrectly, so we remove them.
This commit is contained in:
parent
d4ecee6ba0
commit
2354f07802
1 changed files with 3 additions and 5 deletions
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -21,18 +21,16 @@ Delete any items that are not applicable to this PR.
|
|||
|
||||
Delete this section if it is not applicable to this PR.
|
||||
|
||||
Before closing this PR, invite QA, stakeholders, and other developers to
|
||||
identify risks that should be tested prior to the change/feature release.
|
||||
Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.
|
||||
|
||||
When forming the risk matrix, consider some of the following examples and how
|
||||
they may potentially impact the change:
|
||||
When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:
|
||||
|
||||
| Risk | Probability | Severity | Mitigation/Notes |
|
||||
|---------------------------|-------------|----------|-------------------------|
|
||||
| Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. |
|
||||
| Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. |
|
||||
| Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. |
|
||||
| [See more potential risk examples](../RISK_MATRIX.mdx) |
|
||||
| [See more potential risk examples](https://github.com/elastic/kibana/blob/master/RISK_MATRIX.mdx) |
|
||||
|
||||
|
||||
### For maintainers
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue