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

Status page description field should be stripped of markdown for <meta /> and manifest.json #4739

Open
JasonHK opened this issue May 4, 2024 · 3 comments
Labels
area:status-page Everything related to the status page feature-request Request for new features to be added good first issue Good for newcomers help wanted May need your help to test or answer

Comments

@JasonHK
Copy link

JasonHK commented May 4, 2024

πŸ“‘ I have found these related issues/pull requests

None

🏷️ Feature Request Type

Status-page

πŸ”– Feature description

The description field for status page supports Markdown syntax. But currently it only put the source to <meta name="description" /> tag. For example if I put:

[Hello world](https://example.com/)

It would just rendered as:

<meta name="description" content="[Hello world](https://example.com/)">

I would like to put a full description for the page, and a short description for <meta name="description" /> and manifest.json.

βœ”οΈ Solution

Separate the description setting into "Full description" and "Short description".

❓ Alternatives

Although less ideal, just strip the Markdown syntax would be fine as well:

<meta name="description" content="Hello world">

πŸ“ Additional Context

No response

@JasonHK JasonHK added the feature-request Request for new features to be added label May 4, 2024
@CommanderStorm CommanderStorm added help wanted May need your help to test or answer area:status-page Everything related to the status page labels May 4, 2024
@CommanderStorm
Copy link
Collaborator

Why do you think separating this into a short and long description would be better?

The only reason I can think of would be SEO and that is not a core goal.
=> I would think striping the tags from the rendered markdown would be better.

@JasonHK
Copy link
Author

JasonHK commented May 4, 2024

Why do you think separating this into a short and long description would be better?

The description on my status page has some instructions regarding how to contact me when emergency situation happens to the website. I think it's really weird dumped to the meta description.

@CommanderStorm CommanderStorm added the good first issue Good for newcomers label May 4, 2024
@CommanderStorm CommanderStorm changed the title Status page description field should be seprated into one for the page and one for <meta /> and manifest.json Status page description field should be stripped of markdown for <meta /> and manifest.json May 4, 2024
@CommanderStorm
Copy link
Collaborator

CommanderStorm commented May 4, 2024

I don't think that we need to include a tuning knob for this.
Fixing this via striping the tags should be sufficient

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:status-page Everything related to the status page feature-request Request for new features to be added good first issue Good for newcomers help wanted May need your help to test or answer
Projects
None yet
Development

No branches or pull requests

2 participants