canonical/open-documentation-academy

Rockcraft: Updating recommended text editor in web app framework tutorials

Fermée

#373 ouverte le 17 août 2026

 (3 commentaires) (0 réaction) (1 personne assignée)Python (99 forks)auto 404
claeditgood first issuesize 1

Métriques du dépôt

Stars
 (119 étoiles)
Métriques de merge PR
 (Merge moyen 6j 22h) (2 PRs mergées en 30 j)

Description

Background

Rockcraft contains native support for web app frameworks, including Django, Express, FastAPI, Spring Boot, Go and Flask. Each of these frameworks has a dedicated tutorial to create a simple “Hello, world” app, package its contents into an OCI-compliant image, and use the container image in some simple ways.

Currently, vi is presented as the recommended text editor. User research has shown nano is the preferred option.

Task

For all six web app framework tutorials, at the end of the "Setup" section, replace vi with nano.

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 ReST syntax.
  • Working with the GitHub pull request workflow.

Outcome

The web app framework tutorials recommend using nano as a text editor.

Resources

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.

Guide contributeur