pyvideo / richard

video indexing site
Other
216 stars 55 forks source link

hacking howto docs are way out of date #285

Closed willkg closed 9 years ago

willkg commented 9 years ago

We've made a lot of changes to how richard works. Additionally, time and best practices have changed over time.

This issue covers updating http://richard.readthedocs.org/en/latest/contributors/dev_hacking.html until it's correct again.

willkg commented 9 years ago

From IRC:

<lgp171188> http://richard.readthedocs.org/en/latest/contributors/dev_hacking.html#id4
<lgp171188> I am sorry, this one - http://richard.readthedocs.org/en/latest/contributors/dev_hacking.html#configure
<willkg> yeah, that's definitely wrong.
<lgp171188> couldn't find any settings_local.py-dist
<willkg> ok... mmm... let me do a pass on that document now.
<lgp171188> Under "Install python requirements"
<lgp171188> /venv/bin/pip install -e .\[dev\] can be modified to pip install -e .\[dev\]
<lgp171188> because once the virtualenv is activated as described in the previous command,
pip command will be the one inside the virtualenv
<lgp171188> So no need to referer it by full path
willkg commented 9 years ago

From IRC:

<lgp171188> In http://richard.readthedocs.org/en/latest/contributors/dev_hacking.html#set-up-database-schema-and-create-superuser
<lgp171188> the command throws an error saying that there is no --migrate option
<lgp171188> I guess ./manage.py migrate is sufficient
lgp171188 commented 9 years ago

We have to mention the command to create the superuser since ./manage.py migrate no longer automatically creates a superuser account. There must be a note saying that the email address of the superuser account must be the same as that of the Persona account used to login to the site.