Skip to content

Commit

Permalink
Port content over from #202
Browse files Browse the repository at this point in the history
  • Loading branch information
ericholscher committed Feb 13, 2024
1 parent b471d8c commit e52e326
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 5 deletions.
6 changes: 3 additions & 3 deletions content/posts/2022-war-in-ukraine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ War in Ukraine and what it means for Read the Docs
:category: News
:tags: stats, year-in-review, homepage
:authors: David Fischer
:description: With news surrounding the invasion of Ukraine evolving rapidly, we felt it was necessary to provide an update.
:status: draft
:image:
:description: With news surrounding the invasion of Ukraine evolving rapidly, we felt it was necessary to provide an update.
:status: published
:image:
:image_credit:

With news surrounding the invasion of Ukraine evolving rapidly,
Expand Down
4 changes: 2 additions & 2 deletions content/posts/read-the-docs-2021-stats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Read the Docs 2021 Stats
:tags: stats, year-in-review, homepage
:authors: Eric Holscher, David Fischer
:description: 2021 continued in the realm of being a tough year. That said, Read the Docs had a lot of good things happen this year.
:status: draft
:image:
:status: published
:image:
:image_credit:

2021 continued in the realm of being a tough year.
Expand Down
63 changes: 63 additions & 0 deletions content/posts/website-migration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
Read the Docs website migration
===============================

:date: Mar 9, 2023
:category: Changelog
:tags: website, migration
:authors: Eric Holscher
:description: Read the Docs has a new home for website and content pages that were previously part of our application.
:status: published
:image: /images/posts/screenshot-new-website.png
:image_credit:

Read the Docs is in the process of migrating our primary marketing website to a single site: https://about.readthedocs.com.
The new site offers users more information about our products and their features,
in a combined presentation of what was previously divided between two websites (Read the Docs Community and Read the Docs for Business).
At the same time, the new site will also serve as a single entrypoint for users that are logging in to Read the Docs accounts.
There has been a good deal of confusion around our two sites,
and this change makes it more clear which site you're going to.

Importantly,
**we are keeping both our Community and Business sites separate for logged in users.**
There are no changes in our commitment to offering free hosting for open source,
or the separation of infrastructure for Business customers.

Marketing website migration process
-----------------------------------

The process that we're taking to migrate our marketing site is as follows:

#. ✅ The initial work here was creating a proper marketing site,
and deploying it to https://about.readthedocs.com.
This was done in January 2023.
#. ✅ Redirecting *logged out* Business (``readthedocs.com``) users to the new site.
This was done in February 2023, and we've been monitoring the impact of this change.
#. ✅ Redirect *logged out* Community (``readthedocs.org``) users to the new site.
This was done in August 2023, to make sure the experience is smooth for users who are used to our application web pages.

We're excited about our new website,
because historically we have done a poor job of explaining our products.
Being able to have a single site that explains the features of our various sites,
and the value that Read the Docs brings to the documentation ecosystem is exciting for us.

Technical details
-----------------

Historically,
our marketing pages were generated from our Django application,
and updated only when we deployed a new version of the site.
With our new approach,
our marketing site is actually hosted by Read the Docs itself.

Self-hosting our marketing website gives us many benefits that our users love about hosting their docs with us:

* A proper static site generator built for making a website and blog.
* Pull request previews to allow us to review content changes.
* Instant deployment of updates whenever we merge to ``main``.
* All the rest of our features that we offer to our users.

We're using our new build customization features to build our site with `Pelican <https://getpelican.com/>`__,
and it's been a really fun way to expand the capabilities of our build system.

We hope that you'll join us for the next stage of Read the Docs,
where we will continue to provide the best documentation hosting for all software projects.

0 comments on commit e52e326

Please sign in to comment.