This talk goes over the infrastruct

1. Read the Docs
Eric Holscher
http://ericholscher.com
OSCON 2011
Thursday, July 28, 2011

2. What this talk is
» Talk about the history of Read the Docs
» Technology Involved
» Interesting outcomes of openness
Thursday, July 28, 2011

3. Who am I
» I come from Django
» Work at Urban Airship
» Like automating systems
Thursday, July 28, 2011

4. Why I’m here
» Feedback
» Ideas
» Hopefully you’ll learn something too!
» Shameless self-promotion
Thursday, July 28, 2011

5. The story
Thursday, July 28, 2011

6. 2010 Django Dash
Thursday, July 28, 2011

7. Charles Leifer
Bobby Grace (Design)
Me
Thursday, July 28, 2011

8. Doc Hosting Sucks
» packages.python.org
» Github Pages
» Your own janky cronjobs
Thursday, July 28, 2011

9. `
Thursday, July 28, 2011

10. Sphinx
» Standard documentation tool for python
» Uses reStructured Text
Thursday, July 28, 2011

11. Thursday, July 28, 2011

12. Had a workable site in 48 hours
Thursday, July 28, 2011

13. Fully Open Source
Thursday, July 28, 2011

14. Fully Open Source
» github.com/rtfd/readthedocs.org
» github.com/ericholscher/chef-django-example
» ericholscher.com/tag/chef-series/
Thursday, July 28, 2011

15. Thursday, July 28, 2011

16. Officially Hosted
» Celery
» Fabric
» Nose, py.test
» Virtualenv, Pip
» Django CMS
» Django Grapelli/Floppyforms/Sentry
» Lots more
Thursday, July 28, 2011

17. What makes it tick
Thursday, July 28, 2011

18. Features
Thursday, July 28, 2011

19. Git, Hg, Bzr, Svn
Thursday, July 28, 2011

20. Post commit hooks
Thursday, July 28, 2011

21. Custom Theme
Thursday, July 28, 2011

22. Full-text search
Thursday, July 28, 2011

23. Tags & Branches = Versions
Thursday, July 28, 2011

24. PDF Generation
Thursday, July 28, 2011

25. Virtualenvs
Thursday, July 28, 2011

26. rtfd.org
Thursday, July 28, 2011

27. Tech
Thursday, July 28, 2011

28. Subdomains
Thursday, July 28, 2011

29. CNAME Support
Thursday, July 28, 2011

30. Cname Support
» Request for docs.fabfile.org
» docs.fabfile.org -> fabric.readthedocs.org
» In middleware, resolve CNAME and determine
docs to serve.
» Cache it.
Thursday, July 28, 2011

31. Architecture
+-----------+
| |
+-----| Varnish |------+
| +-----------+ |
| |
+---------+ +---------+
+-------------+ | | | | +--------------+
| |-----| Nginx | | Nginx |----| |
| File | +---------+ +---------+ | File |
| System | | | | System |
+-------------+ +---------+ +--------+ +---------+ +--------------+
| | | | | | | | | |
| +---------|Gunicorn |--|Postgres|--|Gunicorn |--------+ |
| +---------+ +--------+ +---------+ |
| | |
| | |
| +------------------+ |
| | | |
+---------------------| Build Server |-------------------+
| |
+------------------+
Thursday, July 28, 2011

32. Haystack & Solr
Thursday, July 28, 2011

33. Chef
Thursday, July 28, 2011

34. Nagios & Munin
Thursday, July 28, 2011

35. Upstart
Thursday, July 28, 2011

36. REST API
Thursday, July 28, 2011

37. CoffeeScript
Thursday, July 28, 2011

38. CLI
Thursday, July 28, 2011

39. Lessons
Thursday, July 28, 2011

40. Think about your URLs.
Really hard.
Thursday, July 28, 2011

41. Lay your project out sanely
Thursday, July 28, 2011

42. Write tests!
Thursday, July 28, 2011

43. Build around a standard tool
Thursday, July 28, 2011

44. Passing data through systems is
hard
Thursday, July 28, 2011

45. Serving static files is annoying
Thursday, July 28, 2011

46. Log. Everything.
Thursday, July 28, 2011

47. Promote (Hi!)
Thursday, July 28, 2011

48. Find a designer!
Thursday, July 28, 2011

49. Follow the Unix Philosophy
Thursday, July 28, 2011

50. Have a mission
Thursday, July 28, 2011

51. Open Source Outcomes
Thursday, July 28, 2011

52. Patches
Thursday, July 28, 2011

53. Known architecture information
Thursday, July 28, 2011

54. Slow Loris
Thursday, July 28, 2011

55. Trust
Thursday, July 28, 2011

56. People Writing Docs
Thursday, July 28, 2011

57. DEMO
Thursday, July 28, 2011

58. Questions?
» readthedocs.org / rtfd.org
» #readthedocs on Freenode
» github.com/rtfd/readthedocs.org
» eric@ericholscher.com
Thursday, July 28, 2011