Read the Docs: A completely open source Django project

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

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

Who am I » I come from Django » Work at Urban Airship » Like automating systemsThursday, July 28, 2011

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

The storyThursday, July 28, 2011

2010 Django DashThursday, July 28, 2011

Charles Leifer Bobby Grace (Design) MeThursday, July 28, 2011

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

`Thursday, July 28, 2011

Sphinx » Standard documentation tool for python » Uses reStructured TextThursday, July 28, 2011

Thursday, July 28, 2011

Had a workable site in 48 hoursThursday, July 28, 2011

Fully Open SourceThursday, July 28, 2011

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

Thursday, July 28, 2011

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

What makes it tickThursday, July 28, 2011

FeaturesThursday, July 28, 2011

Git, Hg, Bzr, SvnThursday, July 28, 2011

Post commit hooksThursday, July 28, 2011

Custom ThemeThursday, July 28, 2011

Full-text searchThursday, July 28, 2011

Tags & Branches = VersionsThursday, July 28, 2011

PDF GenerationThursday, July 28, 2011

VirtualenvsThursday, July 28, 2011

rtfd.orgThursday, July 28, 2011

TechThursday, July 28, 2011

SubdomainsThursday, July 28, 2011

CNAME SupportThursday, July 28, 2011

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

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

Haystack & SolrThursday, July 28, 2011

ChefThursday, July 28, 2011

Nagios & MuninThursday, July 28, 2011

UpstartThursday, July 28, 2011

REST APIThursday, July 28, 2011

CoffeeScriptThursday, July 28, 2011

CLIThursday, July 28, 2011

LessonsThursday, July 28, 2011

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

Lay your project out sanelyThursday, July 28, 2011

Write tests!Thursday, July 28, 2011

Build around a standard toolThursday, July 28, 2011

Passing data through systems is hardThursday, July 28, 2011

Serving static ﬁles is annoyingThursday, July 28, 2011

Log. Everything.Thursday, July 28, 2011

Promote (Hi!)Thursday, July 28, 2011

Find a designer!Thursday, July 28, 2011

Follow the Unix PhilosophyThursday, July 28, 2011

Have a missionThursday, July 28, 2011

Open Source OutcomesThursday, July 28, 2011

PatchesThursday, July 28, 2011

Known architecture informationThursday, July 28, 2011

Slow LorisThursday, July 28, 2011

TrustThursday, July 28, 2011

People Writing DocsThursday, July 28, 2011

DEMOThursday, July 28, 2011

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

http://lanyrd.com	10
http://www.techgig.com	3
http://lanyrd.dev:8000	1

Read the Docs: A completely open source Django project

by ericholscher

Accessibility

Categories

Upload Details

Usage Rights

3 Embeds 14

Statistics

Read the Docs: A completely open source Django project Presentation Transcript