Top Banner
Read the Docs Eric Holscher http://ericholscher.com OSCON 2011 Friday, July 22, 2011
60

Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Apr 16, 2018

Download

Documents

vuthien
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Read the Docs

Eric Holscherhttp://ericholscher.com

OSCON 2011

Friday, July 22, 2011

Page 2: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

What this talk is

» Talk about the history of Read the Docs

» Technology Involved

» Interesting outcomes of openness

Friday, July 22, 2011

Page 3: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Who am I

» I come from Django

» Work at Urban Airship

» Like automating systems

Friday, July 22, 2011

Page 4: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Why I’m here

» Feedback

» Ideas

» Hopefully you’ll learn something too!

» Shameless self-promotion

Friday, July 22, 2011

Page 6: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Officially Hosted» Celery

» Fabric

» Pip

» Virtualenv

» Django CMS

» Django Grapelli/Floppyforms/Sentry

» Lots more

Friday, July 22, 2011

Page 7: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

The story

Friday, July 22, 2011

Page 8: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

2010 Django Dash

Friday, July 22, 2011

Page 9: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Charles LeiferBobby Grace (Design)

Me

Friday, July 22, 2011

Page 10: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Doc Hosting Sucks

» packages.python.org

» Github Pages

» Your own janky cronjobs

Friday, July 22, 2011

Page 11: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Friday, July 22, 2011

Page 12: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Had a workable site in 48 hours

Friday, July 22, 2011

Page 13: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Fully Open Source

Friday, July 22, 2011

Page 15: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Friday, July 22, 2011

Page 16: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

No excuse

Friday, July 22, 2011

Page 17: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

What makes it tick

Friday, July 22, 2011

Page 18: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Features

Friday, July 22, 2011

Page 19: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Git, Hg, Bzr, Svn

Friday, July 22, 2011

Page 20: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Post commit hooks

Friday, July 22, 2011

Page 21: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Custom Themes

Friday, July 22, 2011

Page 22: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Full-text search

Friday, July 22, 2011

Page 23: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Tags & Branches

Friday, July 22, 2011

Page 24: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

PDF Generation

Friday, July 22, 2011

Page 25: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Man Pages

Friday, July 22, 2011

Page 26: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Virtualenvs

Friday, July 22, 2011

Page 27: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Tech

Friday, July 22, 2011

Page 28: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Sphinx

Friday, July 22, 2011

Page 29: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Subdomains

Friday, July 22, 2011

Page 30: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

CNAME Support

Friday, July 22, 2011

Page 31: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Haystack & Solr

Friday, July 22, 2011

Page 32: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Celery

Friday, July 22, 2011

Page 33: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Varnish

Friday, July 22, 2011

Page 34: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Chef

Friday, July 22, 2011

Page 35: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Multiple Servers

Friday, July 22, 2011

Page 36: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Architecture +-----------+ | | +-----| Varnish |------+ | +-----------+ | | | +---------+ +---------+ +-------------+ | | | | +--------------+ | |-----| Nginx | | Nginx |----| | | File | +---------+ +---------+ | File | | System | | | | System | +-------------+ +---------+ +--------+ +---------+ +--------------+ | | | | | | | | | | | +---------|Gunicorn |--|Postgres|--|Gunicorn |--------+ | | +---------+ +--------+ +---------+ | | | | | | | | +------------------+ | | | | | +---------------------| Build Server |-------------------+ | | +------------------+

Friday, July 22, 2011

Page 37: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Nagios & Munin

Friday, July 22, 2011

Page 38: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Nginx & Gunicorn

Friday, July 22, 2011

Page 39: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Upstart

Friday, July 22, 2011

Page 40: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

REST API

Friday, July 22, 2011

Page 41: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

CoffeeScript

Friday, July 22, 2011

Page 42: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

CLI

Friday, July 22, 2011

Page 43: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Lessons

Friday, July 22, 2011

Page 44: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Think about your URLs.Really hard.

Friday, July 22, 2011

Page 45: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Lay your project out sanely

Friday, July 22, 2011

Page 46: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Write tests!

Friday, July 22, 2011

Page 47: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Build around a standard tool

Friday, July 22, 2011

Page 48: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Promote (Hi!)

Friday, July 22, 2011

Page 49: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Find a designer!

Friday, July 22, 2011

Page 50: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Log. Everything.

Friday, July 22, 2011

Page 51: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Follow the Unix Philosophy

Friday, July 22, 2011

Page 52: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Have a mission

Friday, July 22, 2011

Page 53: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Open Source Outcomes

Friday, July 22, 2011

Page 54: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Patches

Friday, July 22, 2011

Page 55: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Known architecture information

Friday, July 22, 2011

Page 56: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Slow LorisFriday, July 22, 2011

Page 57: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Trust

Friday, July 22, 2011

Page 58: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

People Writing Docs

Friday, July 22, 2011

Page 59: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

DEMO

Friday, July 22, 2011

Page 60: Read the Docs - O'Reilly Mediaassets.en.oreilly.com/1/event/61/A Completely Open Source Django... · » Talk about the history of Read the Docs ... » I come from Django » Work at

Questions?

» readthedocs.org / rtfd.org

» #readthedocs on Freenode

» github.com/rtfd/readthedocs.org

» [email protected]

» twitter.com/ericholscher

» Urban Airship

Friday, July 22, 2011