← Back to issue list

docs: In Django tutorial, missing directory creation step. Rewording needed

View original Github issue

Metadata

Project
rockcraft
Number
#1146
Type
issue
State
closed
Author
asanvaq
Labels
Type: Documentation
Created
Updated
Closed

Current evaluation

Django tutorial wording and directory setup were corrected by merged docs PRs #1150 and #1161 (af24dad8 and b9be5250).

Resolution: closed resolved

Reason: PR #1150 merged as commit af24dad8 and closed #1146, clarifying directory navigation and correcting the settings.py path. PR #1161 subsequently standardized the workspace directory name in commit b9be5250.

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 In the Django tutorial: - The wording in "change into the django_hello_world directory” is not clear. "Change" should be reworded to “enter” - There is an error with the directories in the last step of [Create the Django app](https://documentation.ubuntu.com/rockcraft/latest/tutorial/django/#create-the-django-app), one is missing. This should be reworded similar to https://documentation.ubuntu.com/charmcraft/stable/tutorial/kubernetes-charm-django/#run-the-django-app-locally. ### Document location https://documentation.ubuntu.com/rockcraft/latest/tutorial/django/

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Django tutorial wording and directory setup were corrected by merged docs PRs #1150 and #1161 (af24dad8 and b9be5250).
stealth/space-bunny-alpha — closed resolved Resolved in merged PR #1150 (commit af24dad8), which clarified Django directory navigation, added the missing setup step, and corrected the settings.py path.
stealth/space-bunny-alpha — closed resolved Django tutorial directory wording and setup steps were corrected in merged PRs #1150 (af24dad8) and #1161 (b9be5250).
qwen/qwen3.6-35b-a3b — — 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.
qwen/qwen3.6-35b-a3b — — Closed after a contributor volunteered to update the Django tutorial wording and add the missing directory step. Documentation changes were likely implemented or pending.
qwen/qwen3.6-35b-a3b — — Documentation updates for the Django tutorial were requested to clarify wording and add a missing directory creation step. The request was abandoned and closed without resolution or a submitted fix.
qwen3.6-35b-a3b-mtp-q6 — — Abandoned. A contributor volunteered to fix the missing directory step and wording, but no pull request was submitted.

Update history

No update history recorded yet.

Related work

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

    Merged documentation fix for the reported wording and directory errors.

  • Related To: canonical/rockcraft#1161 (confidence 90%)

    Follow-up merged change that renamed the Django tutorial workspace directory.

Related issues

Issue Project State Summary Similarity
#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.
80%
#1156 docs: Update project structure of Django tutorial rockcraft closed Renamed the Django tutorial project directory from django-hello-world to django-tutorial via PR #1161 (commit b9be5250).
76%
#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.
75%
#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%
#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.
72%