← Back to issue list

docs: Update project structure of Django tutorial

View original Github issue

Metadata

Project
rockcraft
Number
#1156
Type
issue
State
closed
Author
erinecon
Labels
—
Created
Updated
Closed

Current evaluation

Renamed the Django tutorial project directory from django-hello-world to django-tutorial via PR #1161 (commit b9be5250).

Resolution: closed resolved

Reason: PR #1161 updated the tutorial documentation and task file, then merged as commit b9be5250, resolving the confusing repeated directory names.

Evaluated by: mr-cal-bot

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
stealth/space-bunny-alpha — closed resolved Renamed the Django tutorial project directory from django-hello-world to django-tutorial via PR #1161 (commit b9be5250).
stealth/space-bunny-alpha — closed resolved Renamed the Django tutorial project directory from django-hello-world to django-tutorial to reduce confusion and align with Charmcraft. Resolved by PR #1161.
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.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/rockcraft#1161 (confidence 100%)

    Merged documentation change renaming the tutorial project directory.

Related issues

Issue Project State Summary Similarity
#1161 docs: rename Django tutorial project directory rockcraft merged Merged as commit b9be5250 after 4 approvals; renames the Django tutorial workspace dir to django-tutorial, keeping django_hello_world project and django-hello-world rock. Closes #1156.
85%
#1150 docs: clarify Django tutorial directory changes rockcraft merged Docs-only PR merged as commit af24dad8: clarified Django tutorial directory navigation (cd .. back to root) and corrected settings.py path, closing issue #1146.
78%
#2196 docs: maintain Django tutorial charmcraft merged Merged PR #2196 in commit 16bfbfce, updating the Django tutorial and task.yaml to use ./manage.py, home-relative paths, and corrected snippet indentation.
77%
#1146 docs: In Django tutorial, missing directory creation step. Rewording needed rockcraft closed Django tutorial wording and directory setup were corrected by merged docs PRs #1150 and #1161 (af24dad8 and b9be5250).
76%
#2179 Added some further structure to the Django tutorial charmcraft merged Merged PR #2179 added headings emphasizing the Django tutorial’s cyclical develop/pack/deploy workflow; changes landed in commit 2d26e5c7.
74%
#2805 docs: fix caption paths in the Django tutorial charmcraft merged Merged PR #2805 fixed Django tutorial captions for settings.py and urls.py by adding the inner django_hello_world directory; commit c1720ba1.
73%