Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed #35502: Clarified tutorial instructions #18271

Closed
wants to merge 1 commit into from

Conversation

tabiva
Copy link

@tabiva tabiva commented Jun 13, 2024

Updated startproject command in tutorial to 'django-admin startproject mysite djangotutorial' for clearer directory structure explanation.

Trac ticket number

ticket-35502

Branch description

The tutorial previously instructed users to create a 'mysite' directory and another directory with the same name inside it. This update resolves the confusion by changing the start project command to: django-admin startproject mysite djangotutorial., and updating references to the new folder. This makes it clear to which directory the tutorial is referring.

Checklist

  • This PR targets the main branch.
  • The commit message is written in past tense, mentions the ticket number, and ends with a period.
  • I have checked the "Has patch" ticket flag in the Trac system.
  • I have added or updated relevant tests.
  • I have added or updated relevant docs, including release notes if applicable.
  • I have attached screenshots in both light and dark modes for any UI changes.

Updated startproject command in tutorial to 'django-admin startproject mysite djangotutorial' for clearer directory structure explanation.
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello! Thank you for your contribution 💪

As it's your first contribution be sure to check out the patch review checklist.

If you're fixing a ticket from Trac make sure to set the "Has patch" flag and include a link to this PR in the ticket!

If you have any design or process questions then you can ask in the Django forum.

Welcome aboard ⛵️!

@sarahboyce
Copy link
Contributor

Thank you for this update @tabiva
I have gone through this change and I am no longer sure this is the best way forward (and I have added some explanation in the ticket-35502)

Note that this PR is missing some file header updates for the code snippets in the tutorial. 👍

@sarahboyce
Copy link
Contributor

(I will close this PR for now, if after discussing the changes there is a decision to go forward, let's reopen)

@sarahboyce sarahboyce closed this Jun 17, 2024
@nessita
Copy link
Contributor

nessita commented Jun 19, 2024

Another data point is that Meta already worked on this during the DjangoCon Europe sprints, the PR is #18235.

@tabiva
Copy link
Author

tabiva commented Jun 20, 2024

Hi @sarahboyce and @nessita , thank you for your feedbacks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants