Background

Rockcraft is a tool to create rocks – a new generation of secure, stable and OCI-compliant container images, based on Ubuntu.

Documentation should include factual information that helps users with the product. Why use Rockcraft? does therefore not belong in the documentation as it has a more marketing-oriented tone.

Task

Remove Why use Rockcraft? from the documentation. The content is interesting and potentially useful. Assess if any of it can be reused and added to the homepage introductory paragraphs, which explain what Rockcraft is, who is it for, and why should it be used.

Once you’re assigned this issue, please open a pull request directly into canonical/rockcraft. In order to contribute, you must sign the Canonical contributor license agreement.

What you will learn

By completing this issue, you will learn the following:

• Working with the GitHub pull request workflow.
• Identifying key information and adapting existing content.
• Critically assessing what content belongs in documentation.

Outcome

docs/explanation/rockcraft.rst is removed from the repository and the homepage is potentially updated.

Resources

• Rockcraft repository
• Obsolete file
• Rockcraft homepage
• Contributing to the Rockcraft documentation
• Rockcraft CONTRIBUTING.md -- helpful for setting up a development environment

Mentor

The mentor for this issue is @asanvaq. They are the Technical Author for Rockraft and Chisel.

Please feel free to reach out to the mentor on Matrix if you have further questions.