canonical / multipass.run

Codebase for multipass marketing site
GNU General Public License v3.0
4 stars 27 forks source link

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

Open petesfrench opened 2 weeks ago

petesfrench commented 2 weeks ago

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.

Screenshot

image

Comment thread

sharder996: @giuliazanchi Any ideas?

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: This issue is related to the web app, 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: 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.

petesfrench commented 2 weeks ago

JIRA: https://warthogs.atlassian.net/browse/WD-14938

giuliazanchi commented 23 hours ago

Thanks @petesfrench for investigating and getting in touch. I'll copy here what I shared via chat, for future reference.

So, the previous formatting, where the bold within a code block worked, was:

[note type="caution"]
When increasing the disk size of an instance, the partition may not expand automatically to use the new available space. This usually happens if the partition was already full when trying to increase the disk size. In such cases, the partition must be expanded manually, as follows:

<pre>
$ multipass shell handsome-ling
ubuntu@handsome-ling$ <b>sudo parted /dev/sda resizepart 1 100%</b>
Warning: Not all of the space available to /dev/sda appears to be used, you can fix the GPT to use all of the space (an extra 4194304 blocks) or continue with the current setting?
Fix/Ignore? <b>fix</b>
Partition number? <b>1</b>
Warning: Partition /dev/sda1 is being used. Are you sure you want to continue?
Yes/No? <b>yes</b>
ubuntu@handsome-ling$ <b>sudo resize2fs /dev/sda1</b>
</pre>
[/note]

Then I reformatted this block to remove the <pre> tags and use the Markdown `` notation instead, but this other way of formatting content did NOT render the` tags correctly.

For now, I'll revert to using <pre>, but please let me know if there's a better way of doing it. Thanks!