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.

Sign up for GitHub

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

Jump to bottom

[BUG]:Tutorial Create Django Project docs errors #235

Closed
rsevs3 opened this issue Jan 10, 2022 · 0 comments · Fixed by #238
Closed

[BUG]:Tutorial Create Django Project docs errors #235

rsevs3 opened this issue Jan 10, 2022 · 0 comments · Fixed by #238
Assignees
@imAsparky
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@rsevs3
Copy link
Collaborator

rsevs3 commented Jan 10, 2022 •
edited by imAsparky
Loading

Describe the bug

The follow documentation errors were identified:

  • In the readthedocs menu bar, in the Tutorials drop down, the Create Django Project tutorial is called Pre-requisites. The lead Title is missing from the document.
  • In the Before Initial Migration section, the link to the How-to Custom User is resulting in a 404 error.
  • In the README, the link to the How-to Custom User is resulting in a 404 error.
  • Improve troubleshooting section.
@rsevs3 rsevs3 added the bug Something isn't working label Jan 10, 2022
@imAsparky imAsparky added the documentation Improvements or additions to documentation label Jan 10, 2022
imAsparky added a commit that referenced this issue Jan 10, 2022
@imAsparky
fix(docs): Tutorial and README broken links #235
02aeb6c 
Fix: Create Project tutorial was not in the index correctly.
Fix: Create Project tutorial broken link to Custom User.
Fix: README broken link to Custom User.
Improve: Create Project tutorial Troubleshooting section.

closes #235
@imAsparky imAsparky mentioned this issue Jan 10, 2022
Merged
imAsparky added a commit that referenced this issue Jan 10, 2022
@imAsparky
fix(docs): Tutorial and README broken links #235 (#238)
034f522 
Fix: Create Project tutorial was not in the index correctly.
Fix: Create Project tutorial broken link to Custom User.
Fix: README broken link to Custom User.
Improve: Create Project tutorial Troubleshooting section.

closes #235
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@imAsparky imAsparky

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(docs): Tutorial and README broken links #235 imAsparky/django-cookiecutter
2 participants
@rsevs3 @imAsparky