Which site best fits your project?
Free for open-source software.
Sign upPlans starting at $50/month.
Sign upWhich site best fits your project?
Free for open-source software.
Sign upPlans starting at $50/month.
Sign upPhoto by Wilhelm Gunkel on Unsplash
Read the Docs has been building and hosting documentation for open source projects since 2010. We’re proud to be a part of the open source ecosystem, and today we wanted to take a moment to thank one of our biggest supporters: Amazon Web Services.
We have been a member of the AWS Open Source Credits program since 2021. In that time, they have provided us with almost $500,000 in credits, which covers all of our server-related costs each year for the Community platform.
This post will cover a bit more about how we use AWS, the infrastructure we run on it, and how it helps us support the open source projects that rely on Read the Docs.
In the past 30 days, our Community hosting platform has:
Since our creation in 2010, we have been a cornerstone of the Python open source ecosystem, and now host documentation for many other languages and frameworks as well.
Read the Docs has a pretty simple architecture, because we have a small team of 5 people running a very large web service. The major AWS services that we rely on are:
We use a number of other AWS services as well, including Cloudwatch for monitoring, Route 53 for DNS, and many more.
Before we moved to AWS, we were running on dedicated servers. This meant that every build server and web server was a fixed resource, and we had to manually add and remove servers as needed. This led to a lot of wasted resources during off-peak times, and inability to scale up quickly during load spikes.
To spin up a new web server, we'd have to copy hundreds of gigabytes of data from an existing server to a new one, which could take hours. Moving to AWS has allowed us to migrate this data into S3, and now servers can start up in seconds instead of hours.
Similarly, our build servers now autoscale based on demand. We used to have to sit idly and watch our build queue grow during peak times, but now we know that the load will be handled automatically within a few minutes.
This has led to a much better experience for our users, and allowed us to consider projects like pull request builds which we couldn't have supported before. Having pull request builds has increased our build demand, and requires more flexibility in our hosting infrastructure to expire them 30 days after the pull request is closed.
Read the Docs is a critical component of the open source software ecosystem. And their PR builds are the best and most trustworthy implementation out there.
Here are just a few of the big projects whose docs we build and host:
Read the Docs plays a large part in enabling a small volunteer team to maintain our docs. Without the generous Community plan, we couldn't have afforded anything close to the CI/build resources that we got with Read the Docs.
Keeping all this documentation online, building every commit, storing every artifact, and serving content to the entire world—costs a lot of money. We have been given almost $500,000 in credits from AWS since 2021, which covers the lion’s share of our Community infrastructure bill each year.
These credits are important for us in a few major ways:
Without partners like AWS, our Community site wouldn't be the reliable home for documentation that it is today.