534741 - readme tweaks

Status: RESOLVED INVALID

(Webtools :: ISPDB Server, defect)

Description

[David Ascher (:davida)]

Attachment: readme patch

the convert.main() thing should probably be replaced w/ a single script that does the right manage.py-equivalent magic.  but this is a stop-gap.

Comment 1

[Blake Winton (:bwinton) (:☕️)]

Comment on attachment 417564 [details] [diff] [review]
readme patch

>Index: README
>@@ -21,10 +21,16 @@
>   convert existing XML data to the DB:
>   # have http://svn.mozilla.org/mozillamessaging.com/sites/autoconfig.mozillamessaging.com/trunk checked out at ../autoconfig_data
>   # if autoconfig_data is somewhere else, you can set the env't var AUTOCONFIG_DATA to  point to it
>-  echo 'import convert' | python manage.py shell
>+  python manage.py shell
>+  >>> import convert
>+  >>> convert.main()

We could replace this with 
echo "import convert;convert.main()" | python manage.py shell
if we want to keep the 1-line-itude of it.

(Oh, and they both need the "--settings=local_settings", I believe.)

> Step 3:
>+   (for local dev:
>+     python manage.py runserver --settings=local_settings)
>+
>    python manage.py runserver

So, non-local-dev will need a whole new settings file, and a different way of running it, and probably won't want to import our autoconfig data, which is why I'm thinking we might want two files.  README and DEVELOPERS, or INSTALL and README, or something like that.  Then the developer's guide could go into detail about virtualenv and pip, and the deployer's guide could go into detail about how to get runserver listening on non-127.0.0.1 ip addresses.

Also, using:
python manage.py test --settings=local_settings
to run the tests should probably be documented somewhere in there.

> then hit localhost:8000

This looks a lot like local-dev to me.  ;)

Having said all of that, none of those suggestions make your patch unacceptable, or not an improvement on the current state, so with the nits fixed, it gets an r+ from me.

Thanks,
Blake.