canonical / canonical/multipass.run

Formatting issues on "How to modify an instance" documentation page

Open
#339 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
5
Forks
25
PR merge metrics
No merged PRs in 30d

Description

This issue is copied from here: https://github.com/canonical/multipass/issues/3675

## Summary

Description of documentation issue or suggestion
HTML tags are not escaped in this code block on [How to modify an instance](https://multipass.run/docs/modify-an-instance).

## Screenshot

![image](https://github.com/user-attachments/assets/49d15e35-dc4e-42fd-abc4-2a7f1b1eb97a)

## Comment thread

[sharder996](https://github.com/sharder996): @giuliazanchi Any ideas?

[giuliazanchi](https://github.com/giuliazanchi): Thanks for raising this issue, it looks like something changed on our backend as this was displayed correctly at some point in the past. I’ve removed the HTML formatting tags for now, so that it’s easier to read, but I’ll keep this issue open and assign it to myself to explore what went wrong and find a better solution.

[petesfrench](https://github.com/petesfrench): This issue is related to the web app, [multipass.run](https://multipass.run/), so should live under https://github.com/canonical/multipass.run/issues
@giuliazanchi @sharder996 I don't have the appropriate permissions on this repo to transfer the issue. Are you able to?

[ricab](https://github.com/ricab): Hi @petesfrench, I can transfer the issue, but multipass.run is not on the available options I get. Feel free to close this one and link/copy content if you prefer.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the “How to modify an instance” page linked in the issue and inspect how its code block is rendered by the multipass.run site. Reproduce the unescaped HTML-tag display, then verify that the code block shows the intended text without formatting tags.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.