docs: Update project structure of Django tutorial
Metadata
Current evaluation
Resolved after a contributor volunteered to rename the tutorial project directory from django-hello-world to django-tutorial, fixing user navigation confusion and aligning with Charmcraft.
Suggested action: —
No scores available.
Issue body
### Check existing issues
- [x] I've verified that this request isn't described by any existing issues.
### Request
### Issue
The Django tutorial contains many iterations of `django hello world` in its project structure. User feedback has revealed that this project structure is very confusing for users, and it's difficult for them to understand and complete the tutorial at times because of the repeated instances.
For example: At one point in the tutorial, the user is invited to update a configuration in `~/django-hello-world/django_hello_world/django_hello_world/settings.py`. There have been a couple of users during UXR sessions who couldn't find the file.
Some of those `django hello world` instances cannot be avoided due to Django's setup scheme, but we do have control over one instance: the name of the tutorial project directory, which is currently `django-hello-world`.
### Proposal
Update the tutorial project directory to `django-tutorial`.
This change would align the Django tutorial with its counterpart in Charmcraft, in which this change has already been implemented. See https://github.com/canonical/charmcraft/pull/2574
This change would affect the following files:
* https://github.com/canonical/rockcraft/blob/main/docs/tutorial/django.rst
* https://github.com/canonical/rockcraft/blob/main/docs/tutorial/code/django/task.yaml
### Document location
https://github.com/canonical/rockcraft/blob/main/docs/tutorial/django.rst
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Resolved after a contributor volunteered to rename the tutorial project directory from django-hello-world to django-tutorial, fixing user navigation confusion and aligning with Charmcraft. | |
| qwen/qwen3.6-35b-a3b | — | — | The Django tutorial project directory was renamed from django-hello-world to django-tutorial to improve clarity. The issue was closed after the documentation changes were merged. | |
| qwen/qwen3.6-35b-a3b | — | — | Accepted and assigned to a contributor for implementation. The proposal to rename the Django tutorial directory from django-hello-world to django-tutorial was approved to reduce user confusion. Closed after volunteer assignment. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | The proposal to rename the tutorial directory to django-tutorial was accepted and assigned to a contributor. The issue was closed. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
40
Complexity:
10
Confidence:
90
Support Request:
0
|
needs triage | Rename the Django tutorial project directory from django-hello-world to django-tutorial to reduce user confusion and align with Charmcraft. A contributor volunteered and received approval; awaiting assignment. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1161 docs: rename Django tutorial project directory | rockcraft | merged | Merged after addressing review feedback. Renamed the Django tutorial project directory from django-hello-world to django-tutorial. Approved by four reviewers, passed all CI checks, and closed issue #1156. | |
| #1150 docs: clarify Django tutorial directory changes | rockcraft | merged | Merged documentation update clarifying Django tutorial directory navigation and adding explicit return commands. Reviewers requested path corrections and suggested renaming the project directory to reduce confusion, which was scoped out and tracked separately. | |
| #1146 docs: In Django tutorial, missing directory creation step. Rewording needed | rockcraft | closed | Requested Django tutorial documentation fixes were closed and abandoned. A contributor volunteered to address the wording and missing directory step, but no pull request or changes were submitted. |