Skip to content

Conversation

@erinecon
Copy link
Contributor

Three updates that expand over all four tutorials. These changes were suggested from one or more UX sessions.

Summary of changes:

  1. If the user needs to open rockcraft.yaml or charmcraft.yaml to update the architecture to arm64, have them also comment out amd64. While there's no harm or issue with having both architectures available, for novice users, this change will eliminate any possible concern or worry over including both architectures in the YAML file(s).
  2. Provide more explanation and reassurance about the web app entering a blocked state when adding the PostgreSQL database.
  3. Rephrase the "tear things down" section to tell the users that they can just delete the whole instance if they're not going to keep the VM.

Additional reviewer: @jdkandersson

If your host uses ARM64 architecture, open ``rockcraft.yaml`` in a
text editor and include ``arm64`` under ``platforms``.
If your host uses ARM architecture, open ``rockcraft.yaml`` in a
text editor, comment out ``amd64``, and include ``arm64`` under ``platforms``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lengau Can Charmcraft run on ARMhf systems?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically yes, but the last time snapcraft.io reports a nonzero number of users on armhf (2) was April of last year. One would have to deploy their own juju runners to run charms on armhf AFAIK.

Comment on lines +781 to +782
If you'd like to manually reset your working environment, you can run the
following in the rock directory ``~/django-hello-world`` for the tutorial:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note for work in the next cycle: In other tutorials I made this a required step, even though it was optional. We're not to fork in tutorials.

Comment on lines +676 to +677
If you'd like to manually reset your working environment, you can run the
following in the rock directory ``~/fastapi-hello-world`` for the tutorial:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you'd like to manually reset your working environment, you can run the
following in the rock directory ``~/fastapi-hello-world`` for the tutorial:
If you'd like to manually reset your working environment, you can run the
following in the ``~/fastapi-hello-world`` directory:

This flows more cleanly to me, but I might be missing the meaning.

@lengau lengau changed the title Docs: Tutorial updates docs: Tutorial updates Mar 18, 2025
@lengau lengau merged commit f9e6860 into canonical:main Mar 18, 2025
25 of 26 checks passed
@erinecon erinecon deleted the tutorial-updates branch April 17, 2025 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants