docs: add slack username helptext #5259
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
| @@ -20,6 +20,9 @@ | |||
| <i18n-t tag="p" keypath="aboutWebhooks" style="margin-top: 8px;"> | |||
| <a href="https://api.slack.com/messaging/webhooks" target="_blank">https://api.slack.com/messaging/webhooks</a> | |||
| </i18n-t> | |||
| <p style="margin-top: 8px;"> | |||
| {{ $t("aboutUsername", [$t("slack"), $t("Username"), $t("Friendly Name")]) }} | |||
There was a problem hiding this comment.
I know that in other translations (in this file) this is done, but I don't like this pulling things out unless that makes translation simpler.
=> let's inline this one
Suggested change
| {{ $t("aboutUsername", [$t("slack"), $t("Username"), $t("Friendly Name")]) }} | |
| {{ $t("aboutSlackUsername") }} |
There was a problem hiding this comment.
Indeed, it seems easier to manage.
(Also, when viewed in Japanese, it feels somewhat difficult to read since only parts are translated.)
src/lang/en.json
Outdated
| @@ -731,6 +731,7 @@ | |||
| "Icon Emoji": "Icon Emoji", | |||
| "signalImportant": "IMPORTANT: You cannot mix groups and numbers in recipients!", | |||
| "aboutWebhooks": "More info about Webhooks on: {0}", | |||
| "aboutUsername": "The {0} {1} can change the display name of the message sender. This is not for mentions. If you want to mention someone, include it in the {2}.", | |||
There was a problem hiding this comment.
lets reword it like this, what do you think?
Suggested change
| "aboutUsername": "The {0} {1} can change the display name of the message sender. This is not for mentions. If you want to mention someone, include it in the {2}.", | |
| "aboutSlackUsername": "Changes the display name of the message sender. If you want to mention someone, include it in the friendly name instead.", |
| @@ -20,6 +20,9 @@ | |||
| <i18n-t tag="p" keypath="aboutWebhooks" style="margin-top: 8px;"> | |||
| <a href="https://api.slack.com/messaging/webhooks" target="_blank">https://api.slack.com/messaging/webhooks</a> | |||
| </i18n-t> | |||
| <p style="margin-top: 8px;"> | |||
| {{ $t("aboutUsername", [$t("slack"), $t("Username"), $t("Friendly Name")]) }} | |||
There was a problem hiding this comment.
also, lets move this up to where the username field is, so that it is not so out of place
CommanderStorm
added
the
pr:please address review comments
|
@CommanderStorm I feel that the help text has become clearer. Thank you! |
CommanderStorm
approved these changes
Oct 28, 2024
CommanderStorm
changed the title
CommanderStorm
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma
Tick the checkbox if you understand [x]:
Description
Add help text about how to use the slack
Usernameand the difference from mentions.Fixes #4560
Type of change
Please delete any options that are not relevant.
Checklist
Screenshots (if any)
Please do not use any external image service. Instead, just paste in or drag and drop the image here, and it will be uploaded automatically.
My slack test message:
