Add documentation links to error messages #17538
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Linking to two places in the documentation from the two connection checks we have for storages.
Ticket
https://community.openproject.org/projects/openproject/work_packages/57337
What are you trying to accomplish?
Adding cross references between error messages and
Screenshots
What approach did you choose and why?
The error message for manually triggered connection checks was changed as requested. However, in contrast to acceptance criteria two changes were made:
Both are because the error message of the periodic check is much less structured. That check purely shows a string stored in the database as an error message. Thus it was easy to wrap the link around the error code for the manual check, but much harder to do the same for the periodic check.