← Back to issue list

docs: clarify Django tutorial directory changes

View original Github issue

Metadata

Project
rockcraft
Number
#1150
Type
pull request
State
merged
Author
gcomneno
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

No scores available.

Issue body

## Summary - clarify the Django tutorial wording when entering the project subdirectory - make the return to the tutorial root explicit with `cd ..` - improve consistency with the related Charmcraft tutorial wording Closes #1146

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b 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.
qwen3.6-35b-a3b-mtp-q6 Merged docs clarifying Django tutorial directory navigation and correcting the settings.py path. Reviewer feedback on explicit commands and accurate paths was applied. A project directory rename was deferred to issue #1156.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update clarifying Django tutorial directory navigation and paths. Reviewers corrected the settings.py path and suggested a broader directory rename, which was deferred to a separate issue. Closes #1146.

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.
80%
#1156 docs: Update project structure of Django tutorial rockcraft closed 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.
79%
#2196 docs: maintain Django tutorial charmcraft merged Merged documentation updates for the Django tutorial. Changes standardize the manage command, correct path references, and fix code indentation. Approved by reviewers and merged with 17 lines changed across two files.
78%
#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.
74%
#2179 Added some further structure to the Django tutorial charmcraft merged Merged after three approvals, the update restructured Django tutorial headings to emphasize the develop/pack/deploy cycle. Reviewers requested consistent infinitive phrasing and rebased the commit to resolve a CLA email mismatch. The change added 46 lines and removed 11 across one file.
74%
#2805 docs: fix caption paths in the Django tutorial charmcraft merged Merged docs fix correcting missing inner package paths in Django tutorial captions for settings.py and urls.py. Updates align captions with the actual layout, passed all CI checks, and received approval from two reviewers.
72%
#2257 Docs: 12-factor tutorial updates charmcraft merged Merged documentation updates for the 12-factor tutorials. Changes clarify architecture instructions, fix Django tutorial terminology, convert admonitions to paragraphs, and correct variable formatting. Approved by reviewers and merged.
70%
#2440 docs: align Flask tutorial structure with Django tutorial charmcraft merged Aligns Flask tutorial structure with Django tutorial through section reorganization, added introductory text, and typo fixes. Approved by three reviewers and merged after passing CI checks.
70%