graphql-python / graphql-python/graphene

Tutorial mistakes

Open Beginner friendly
#1,389 5 comments 2 reactions 0 assignees View on GitHub
🐛 bug
Dominant language
Python
Stars
8.2k
Forks
818
PR merge metrics
No merged PRs in 30d

Description

Hey :). Don't know where else to post this so...

Found 2 mistakes in this tutorial:

https://docs.graphene-python.org/projects/django/en/latest/tutorial-plain/

Where it says: "Now sync your database for the first time:"
There is no manage.py in that directory. One must go back one directory. So, `cd ..` first, and then execute the `python manage.py` migrate command.

Where it says: "Don’t forget to create & run migrations:"
This will fail because in `class IngredientsConfig(AppConfig): ` we have `name = 'ingredients'`. The name is wrong. It should be `name = 'cookbook.ingredients'`

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the tutorial at docs.graphene-python.org/projects/django/en/latest/tutorial-plain/ and locate its source in the repository. Verify the database migration command's directory and the IngredientsConfig name, then update the tutorial and confirm both steps work as documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, graphql, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.