Skip to content

feat(status-page): add help text for 'Description' in monitor edit status page#6254

Merged
CommanderStorm merged 10 commits intolouislam:masterfrom
notashutosh:feature/helptext-for-edit-status
Oct 27, 2025
Merged

feat(status-page): add help text for 'Description' in monitor edit status page#6254
CommanderStorm merged 10 commits intolouislam:masterfrom
notashutosh:feature/helptext-for-edit-status

Conversation

@notashutosh
Copy link
Copy Markdown
Contributor

@notashutosh notashutosh commented Oct 24, 2025

@notashutosh notashutosh changed the title #6180 add help text for 'Description' in edit status page (draft) #6180 add help text for 'Description' in monitor edit status page (draft) Oct 24, 2025
@CommanderStorm CommanderStorm changed the title #6180 add help text for 'Description' in monitor edit status page (draft) add help text for 'Description' in monitor edit status page (draft) Oct 24, 2025
@notashutosh
Copy link
Copy Markdown
Contributor Author

Changes
Added a tooltip help text to the "Description" field in the Edit Monitor page to guide users about HTML formatting.

Details:

  • Added an info icon next to the "Description" label
  • On hover, displays: "Please remove leading spaces in HTML to avoid formatting issues"
  • Styled tooltip with dark theme matching the UI

Screenshot
Screenshot 2025-10-25 at 1 37 18 AM

Testing
Linting passes (npm run lint)
Help text displays correctly on hover

Please let me know what I should do further to complete this PR. Thank you!

Copy link
Copy Markdown
Collaborator

@CommanderStorm CommanderStorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None of the code currently uses the way you are doing tooltips.+
I'd like to not add more entropy like this.

Please add a helptext (like for the other fields) instead.
The short helptext should:

  • explian what this field does in terms of where we use it
  • and that the content is sanitised.

Copilot AI review requested due to automatic review settings October 27, 2025 05:35
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds help text to the 'Description' field in the monitor edit page to inform users that Markdown is supported and will be sanitized before display.

  • Added a help text element below the description input field
  • Added the corresponding translation key with explanation text about Markdown support

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/pages/EditMonitor.vue Added help text display element below the description input field
src/lang/en.json Added translation entry for the description help text explaining Markdown support

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@notashutosh
Copy link
Copy Markdown
Contributor Author

Thanks. Now idiomatically showing helptext similar to other fields. Not sure if the text is too long. Thought I should mention spaces and indentation being preserved as highlighting that was the motivation for this fix. Let me know if it works.
Screenshot 2025-10-27 at 11 07 32 AM

Copilot AI review requested due to automatic review settings October 27, 2025 12:27
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot AI review requested due to automatic review settings October 27, 2025 12:27
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot AI review requested due to automatic review settings October 27, 2025 12:28
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link
Copy Markdown
Collaborator

@CommanderStorm CommanderStorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks ❤️

@CommanderStorm CommanderStorm marked this pull request as ready for review October 27, 2025 12:30
@CommanderStorm CommanderStorm added this to the 2.1.0 milestone Oct 27, 2025
@CommanderStorm CommanderStorm changed the title add help text for 'Description' in monitor edit status page (draft) feat(status-page): add help text for 'Description' in monitor edit status page Oct 27, 2025
Copilot AI review requested due to automatic review settings October 27, 2025 19:31

This comment was marked as spam.

@CommanderStorm CommanderStorm merged commit ea3a4f6 into louislam:master Oct 27, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants