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.

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

Docs cleanup #26

Open
madcowfred opened this issue Jul 1, 2013 · 2 comments
Open

Docs cleanup #26

madcowfred opened this issue Jul 1, 2013 · 2 comments
Assignees
Labels

Comments

@madcowfred
Copy link
Owner

Issue to track things that need improving in the docs.

  • README is wildly out of date.
  • Use readthedocs to rewrite the large amount of install/config information in a more usable format.
    • Stress that you absolutely should use virtualenv
    • Setup info for nginx
    • Expand worker setup info
      • Link to Celery docs for automatic startup/management things
    • Remove mentions of SQLite support since it has multiple issues
    • List general steps to take when updating from source
  • Make some sort of simple feature showcase site to explain what EVEthing does, link to github/readthedocs
  • Developer information
    • Extra requirements for editing static files (node 😢)
    • What the magical Makefile is for
    • Attempt to explain the haphazard layout of files
    • Explain how tasks work and the ridiculous number of places you need to add things to to add a task
@ghost ghost assigned madcowfred Jul 1, 2013
@operinko
Copy link

If you need it, I can provide you with setup instructions for nxing+uwsgi+php_fpm.

@Deichscheich
Copy link

operinko, that would be great! I'm currently trying to get it working with Apache, but I can't quite figure it out. In general, the readme could be ten times longer :)

Dependencies I've found so far that are not included in the readme: libmysqlclient-dev python-mysqldb python-dev

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants