Charmed Ceph: Stylistic inconsistencies in the how-to index

[skoech]

[! IMPORTANT] Notice that this task contains a workshop label; this means that it has been created for the live DjangoCon/Ubucon 2025 Open Documentation Academy workshop to assist community members make their first documentation contribution. Please, do not work on this task unless it is assigned to you.

Background

The Charmed Documentation how-to index lacks stylistic uniformity. Only some subsections appear in bold; this formatting is applied inconsistently, as carets appear in both bold and plain-font subheadings.

The lack of uniform structuring violates the principles of clear and consistent labelling and structured, scannable formatting. This decreases the functional quality of the work. In the case of the index, the cognitive load is clearly increased, as the user will be drawn to the bold content first, assuming it has a higher hierarchy, and will need to look further if the subsection they are interested in is in plain-font format.

Task

Apply the bold font for only the highest hierarchy level (H1 level) to ensure consistency and make it easier to find the main
sections when the user expands the index.

Resources

• Charmed Ceph docs
• Follow our documentation contributing guide
  • especially how to edit docs on Discourse
• Read the Ubuntu Code of Conduct.
• Visit the academy website to learn more

Thank you in advance for your contribution!

[iamDREAMO]

Hi @skoech ,
I want to work on this.

[skoech]

Hello @iamDREAMO, thank you for your interest in this task. However, since it contains the workshop label, it means that it has been created specifically for a live Open Documentation Academy workshop.
I created this one specifically for the workshop we are running today at DjangoCon/UbuCon 2025. If you are here, please attend the session and let us know, and we will assign it to you.

If you are not an attendee, and the task is not claimed by any workshop participant, I will assign it to you later today.

I am sorry that this was not clear to you, and I have added a disclaimer at the top of the description to prevent this from happening again. Thank you.

[rimubytes]

Hey, I would like to work on this

[skoech]

Hi @rimubytes, go for it!

[skoech]

@rimubytes, how's it going?

[rimubytes]

Still building up trust level, should I still keep on adding up on the read time?

[skoech]

Yes, I'm surprised you still can't make edits. Weren't you already on Trust Level 1? https://blog.discourse.org/2018/06/understanding-discourse-trust-levels/

[rimubytes]

Yeah I was, let me go through it. Thank you

[skoech]

No problem, thanks!