Skip to content

Fixed #35485 Added how to guide for project and app templates. #18804

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

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

MisterRios
Copy link
Contributor

Trac ticket number

ticket-35485

Branch description

Provide a concise overview of the issue or rationale behind the proposed changes.

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.

@MisterRios MisterRios force-pushed the ticket_35485 branch 2 times, most recently from cf9187e to 08ca7b9 Compare November 13, 2024 08:21
@MisterRios
Copy link
Contributor Author

Hi- problems with misspellings of... "Javascript" "Kubernetes" "toml" and "frontend".

Also, I mention "settings" as a string within a file, and it gets flagged. Perhaps I should remove the backticks for that example?

Also, having trouble with the links to the source code.

Copy link
Contributor

@sarahboyce sarahboyce left a comment

Choose a reason for hiding this comment

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

Thank you @MisterRios I really like this ⭐

I have some initial comments

Also you should:

  • add this to docs/howto/index.txt
  • add a link to this how-to in the startapp startproject ref docs

Comment on lines 81 to 82
Creating your own Project and App Templates
===========================================
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should add a verbose example with template files doing something common

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sarahboyce Do you mean an example of running default commands and the resulting default structure before even getting into the custom examples? Interesting. A bit redundant, but if you're coming to this page not from the command documentation, it does show what the current behavior is. I'll work on it, and let you know how far I get.

Copy link
Contributor

Choose a reason for hiding this comment

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

Do you mean an example of running default commands and the resulting default structure before even getting into the custom examples?

No sorry. I mean having an explicit example customization for this howto.
For example, for the app template this could add a urls.py file or replace the tests.py with a folder with test_models.py and test_views.py

@MisterRios MisterRios force-pushed the ticket_35485 branch 2 times, most recently from 6320db5 to 971d960 Compare February 24, 2025 15:53
@MisterRios MisterRios marked this pull request as draft June 2, 2025 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants