Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation links to error messages #17538

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

Conversation

NobodysNightmare
Copy link
Contributor

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

image

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:

  • The format of the manual check error message was not changed
  • The doc link for the periodic check was added into a separate link

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.

@NobodysNightmare
Copy link
Contributor Author

Something I unsuccessfully tried was adding manual anchors to the docs as pure HTML, e.g. <a name="ERR_CLIENT_INVALID"></a>, so that we could not only link to the section with the error codes, but to a specific error code.

However, rendering the corresponding document via opf/openproject-website seems to always filter the HTML anchors.

Linking to two places in the documentation from the two
connection checks we have for storages.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant