← Back to issue list

Feedback on the Django tutorial

View original Github issue

Metadata

Project
charmcraft
Number
#2235
Type
issue
State
closed
Author
evildmp
Labels
—
Created
Updated
Closed

Current evaluation

Most Django tutorial feedback was implemented in merged docs PRs #2251, #2257, #2263, #2276, #2282, and #2287; remaining requests were declined or discussed before closure.

Resolution: closed resolved

Reason: The documentation changes landed through six PRs, including #2251 (592d93aa) and #2276 (5cacee4a). The maintainer closed the issue after confirming that feedback had been addressed through those PRs and follow-up discussion.

Evaluated by: mr-cal-bot

No scores available.

Issue body

* [x] _If you’re new to the charming world_ note - the eyes skip over this somewhat. Should probably just be a normal paragraph, after the very first one int he document. * [x] _Warning: This tutorial requires version 3.2.0 or later of Charmcraft_ - seems quite out of order here, we don't get near charm craft till much later. If we are serious about using Multipass as described, we'll _know_ what the user has installed. * [x] _First, install Multipass_ > _Install Multipass if you don't already have it installed. See How to install Multipass._ * [x] _[Multipass | How to install Multipass](https://multipass.run/docs/install-multipass)_ link is broken. * [x] After _juju bootstrap microk8s dev-controller_ seems like the right point for a rest, before `mkdir django-hello-world` - perhaps the `Create the Django app` heading should be here. * [x] _Create the Django app_ - _app_ is highly overloaded, perhaps _Start a new Django project_ * [x] `requirements.txt` - `touch` seems superfluous; why not just edit with nano? * [x] The `django-hello-world/django_hello_world/django_hello_world` structure is very confusing. We might not be able to escape `django_hello_world/django_hello_world`, but at least the first part could be different, e.g. `django-charm-project`. * [x] `MULTIPASS_PRIVATE_IP` - all-caps suggests a constant * [x] At that point, http://192.168.64.14:8000 worked perfectly in Safari but not in Chrome ("the site could not be reached"). Unclear why and not sure what to suggest. * [x] _Pack the Django app into a rock_ - this is the moment at which I'd appreciate a few words about what a rock is, as reminder if nothing else. Also helps signal that we are entering rock world. * [x] _We’ll use Juju later to easily deploy a database._ - no _easily_ please. * [x] _Ensure that platforms includes the architecture of your host_. It's ambiguous, should it include anything else? Suggest: _Platforms must match the architecture of your host_. * [x] _If your host uses ARM architecture, open rockcraft.yaml in a text editor, comment out amd64, and include arm64 under platforms._ > _Edit the platforms entry in rockcraft.yaml if required_. * [x] Paragraph _We’ll need to update the settings.py file to prepare..._ is quite a lot of verbiage to assimilate and turn into action. Why not say _Back in settings.py..._ and let the user work it out, they need that muscle memory of where to find it. * [x] database settings code has indentation of 3 and 6 instead of 4 and 8. * [x] _Now let’s pack the rock:_ - worth noting that we have made changes (e.g. db settings) that we can't verify. We are hovering uncomfortably between development and deployment worlds. But at least we can check for syntax errors, if we try the runserver again, we should get a `CommandError: You must set settings.ALLOWED_HOSTS if DEBUG is False.` Not sure what to advise though. * [x] _Note In older versions of Rockcraft_ - why? - we just installed it at the beginning, in a new VM * [x] _Depending on your system and network, this step can take several minutes to finish._ which makes it an excellent to stop and go into a little explanation of what is happening. * [x] _Note If you aren’t on AMD64 architecture_ - turn it round: _Note that the name of the rock file will reflect your system's architecture_; get the user used to taking responsibility for this file and its name. Make it normal, not a special note. * [x] `rockcraft.skopeo` - definitely suggest dropping the $(dpkg --print-architecture) part of it; that should become the user's responsibility. Can you format this so that the flags and arguments are explained in comments? That whole three-line command is an incantation without explanation. * [x] _See also [Ubuntu manpage | skopeo](https://manpages.ubuntu.com/manpages/jammy/man1/skopeo.1.html)_ isn't really going to provide information anyone needs to see. * [x] Remind me why this launches a _managed ubuntu 22.04_- why so old? * [x] `charmcraft init --profile django-framework --name django-hello-world` deserves a little explanation, especially the --profile * [x] _We will need to connect the Django app to the PostgreSQL database_ - we're not actually doing any connecting now; need to find a different way to describe this. * [x] `Open the charmcraft.yaml file and add the following section to the end of the file` - Try to avoid _mechanical_ actions, like "open", unless you need to. Instead, aim for _functional_ actions, like "edit". * [x] _charmcraft pack_ - a good time to stop and explain what is happening, what is being generated, etc - context for the user * [x] _If you aren’t on AMD64 architecture_ - again, let the user build the muscle memory by being told to observe it - don't deny the user that important learning experience; let them become comfortable finding the file and associating its name with other actions. * [x] _A Juju model_ - you're introducing a big concept, deserves a word of introduction * [x] _Set the Juju model constraints with_ - avoid $(dpkg --print-architecture), let the user work it out * [x] _juju config django-hello-world django-debug=true_ - if you note that this will set an environment variable, then you give the user a way to connect this command with a concept that's already familiar (just one example of this opportunity, there are others) * [x] "App" is very overloaded - _"The generated Django app doesn’t come with an app"_ ### Documentation location https://canonical-charmcraft.readthedocs-hosted.com/en/latest/tutorial/kubernetes-charm-django/

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Most Django tutorial feedback was implemented in merged docs PRs #2251, #2257, #2263, #2276, #2282, and #2287; remaining requests were declined or discussed before closure.
stealth/space-bunny-alpha — closed resolved Most Django tutorial feedback was implemented in six documentation PRs (#2251–#2287); other requests were declined or discussed, and the issue was closed as complete.
qwen3.6-35b-a3b-mtp-q6 — — Most feedback was incorporated into the Django tutorial via multiple PRs. Some suggestions were declined due to tooling constraints or stylistic preferences. All points were reviewed and addressed, resolving the issue.
qwen/qwen3.6-35b-a3b — — Documentation feedback was implemented across multiple PRs. Most suggestions were incorporated, while a few were declined due to tooling constraints or style preferences. All points were addressed and the issue closed.
qwen/qwen3.6-35b-a3b — — Documentation feedback was reviewed and incorporated across multiple PRs. Most suggestions were implemented, with a few declined due to tooling constraints. All points were resolved through linked PRs and discussion.
qwen3.6-35b-a3b-mtp-q6 — — Documentation feedback was addressed via multiple PRs. Most suggestions were incorporated, while a few were rejected or deferred due to tooling constraints. All comments were resolved through discussion.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/charmcraft#2276 (confidence 99%)

    Applied six feedback items from #2235 across the 12-factor tutorials in commit 5cacee4a.

  • Likely Fixed By: canonical/charmcraft#2251 (confidence 98%)

    Merged documentation updates for the 12-factor tutorials in commit 592d93aa.

  • Likely Fixed By: canonical/charmcraft#2257 (confidence 90%)

    Merged tutorial updates in commit e549afa7.

  • Likely Fixed By: canonical/charmcraft#2263 (confidence 90%)

    Merged 12-Factor tutorial updates in commit 410dcd0b.

  • Likely Fixed By: canonical/charmcraft#2282 (confidence 90%)

    Merged further 12-factor tutorial updates in commit 2199bc08.

  • Likely Fixed By: canonical/charmcraft#2287 (confidence 85%)

    Merged follow-up alignment of the FastAPI and Django tutorials.

Related issues

No related issues found above the similarity threshold.