Charmed Ceph: Replace gerunds with imperatives #278
Description
[! IMPORTANT] Notice that this task contains a
workshoplabel; 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
In the Charmed Ceph how-to guides, the use of gerund instead of imperative violates a our style guide. It also creates an inconsistent voice in both the index and text. The use of imperative delivers a clear command and helps users understand they need to perform an action. The use of gerund can hint at a description, and can lead to confusion, as users might think an explanation will follow. This reduces the precision of the documentation and reduces the functional quality. Since the information is not presented in the most actionable way, it can be harder to engage with and feel less intuitive to the user, which could decrease the deep quality.
For example, “Replace OSD disks” rather than “Replacing OSD disks” is clearer that it is a step to be followed rather than an explanation, and, therefore, more actionable.
Task
Replace all gerunds in the index with imperatives, e.g. change “Installing Ceph” to “Install Ceph”.
Resources
- Charmed Ceph docs
- Follow our documentation contributing guide](https://canonical-microceph.readthedocs-hosted.com/latest/contributing/)
- 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!