The story and tech of Read the Docs
- 1. The story and tech of Read the Docs Eric Holscher http://ericholscher.com Djangocon 2011
- 2. What this talk is » Talk about the history of Read the Docs » Technology Involved » Interesting outcomes of openness » Lessons learned
- 3. Who am I » I come from Django » Work at Urban Airship » Like automating systems
- 4. Why I’m here » Feedback » Ideas » Hopefully you’ll learn something too! » Shameless self-promotion
- 5. The story
- 7. Charles Leifer Bobby Grace (Design) Me
- 8. Doc Hosting Sucks » packages.python.org » Github Pages » Your own janky cronjobs
- 9. `
- 10. Sphinx » Standard documentation tool for python » Uses reStructured Text
- 12. Had a workable site in 48 hours
- 14. Fully Open Source » github.com/rtfd/readthedocs.org » github.com/ericholscher/chef-django-example » ericholscher.com/tag/chef-series/
- 16. Officially Hosted » Celery » Fabric » Nose, py.test » Virtualenv, Pip » Django CMS » Django Grapelli/Floppyforms/Sentry » mod_wsgi (woo!)
- 17. DEMO
- 18. What makes it tick
- 19. Features
- 20. Git, Hg, Bzr, Svn
- 22. Custom Theme
- 23. Full-text search
- 24. Tags & Branches = Versions
- 25. PDF Generation
- 26. Virtualenvs
- 27. rtfd.org
- 28. Tech
- 29. Subdomains
- 30. CNAME Support
- 31. Cname Support » Request for docs.fabfile.org » docs.fabfile.org -> fabric.readthedocs.org » In middleware, resolve CNAME and determine docs to serve. » Cache it.
- 32. Architecture +-----------+ | | +-----| Varnish |------+ | +-----------+ | | | +---------+ +---------+ +-------------+ | | | | +--------------+ | |-----| Nginx | | Nginx |----| | | File | +---------+ +---------+ | File | | System | | | | System | +-------------+ +---------+ +--------+ +---------+ +--------------+ | | | | | | | | | | | +---------|Gunicorn |--|Postgres|--|Gunicorn |--------+ | | +---------+ +--------+ +---------+ | | | | | | | | +------------------+ | | | | | +---------------------| Build Server |-------------------+ | | +------------------+
- 33. Haystack & Solr
- 34. Chef
- 35. Nagios & Munin
- 36. Upstart
- 37. REST API
- 38. CoffeeScript
- 39. CLI
- 41. Patches
- 43. Slow Loris
- 44. Trust
- 46. Lessons
- 47. Think about your URLs. Really hard.
- 48. Lay your project out sanely
- 49. Write tests!
- 50. Build around a standard tool
- 51. Passing data through systems is hard
- 52. Serving static files is annoying
- 53. Log. Everything.
- 54. Promote (Hi!)
- 55. Find a designer!
- 56. Follow the Unix Philosophy
- 57. Have a mission
- 58. Thanks
- 59. Revsys
- 60. PSF
- 61. Mozilla
- 62. Divio
- 63. Pyladies
- 64. Questions? » readthedocs.org / rtfd.org » #readthedocs on Freenode » github.com/rtfd/readthedocs.org » [email protected]
Editor's Notes
- #2: \n
- #3: \n
- #4: \n
- #5: \n
- #6: \n
- #7: \n
- #8: \n
- #9: \n
- #10: \n
- #11: \n
- #12: \n
- #13: \n
- #14: \n
- #15: \n
- #16: \n
- #17: \n
- #18: \n
- #19: \n
- #20: \n
- #21: \n
- #22: \n
- #23: \n
- #24: \n
- #25: \n
- #26: \n
- #27: \n
- #28: \n
- #29: \n
- #30: \n
- #31: \n
- #32: \n
- #33: \n
- #34: \n
- #35: \n
- #36: \n
- #37: \n
- #38: \n
- #39: \n
- #40: \n
- #41: \n
- #42: \n
- #43: \n
- #44: \n
- #45: \n
- #46: \n
- #47: \n
- #48: \n
- #49: \n
- #50: \n
- #51: \n
- #52: DB -> Django Template -> Sphinx Config -> Jinja Template \n
- #53: \n
- #54: \n
- #55: \n
- #56: \n
- #57: \n
- #58: \n
- #59: \n
- #60: \n
- #61: \n
- #62: \n
- #63: \n
- #64: \n
- #65: \n