Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port content over to the blog #258

Merged
merged 5 commits into from
Feb 19, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added content/images/jan-2024.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 0 additions & 55 deletions content/posts/2022-war-in-ukraine.rst

This file was deleted.

46 changes: 46 additions & 0 deletions content/posts/newsletter-january-2024.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
:title: Read the Docs Newsletter - January 2024
:date: Jan 10, 2024
:tags: newsletter, python
:category: Newsletter
:author: Eric
ericholscher marked this conversation as resolved.
Show resolved Hide resolved
:image: /images/jan-2024.jpg
:image_credit: Photo by <a href="https://unsplash.com/@glencarrie?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Glen Carrie</a> on <a href="https://unsplash.com/photos/january-scrabble-words-TGeFx4x4NHU?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a>


Read the Docs newsletter - January 2024
========================================

News and updates
----------------

* We have shipped `new redirects <{filename}new-improvements-to-redirects>`_, making our redirects much more powerful and flexible.
agjohnson marked this conversation as resolved.
Show resolved Hide resolved
* We have shipped an `updated approach to notifications <https://github.com/readthedocs/readthedocs.org/pull/10922>`_. Currently there isn't much UX difference, but as we move forward with this project we will be able to provide more context and control to users.
* We continue to work on improving Addons, our new approach to documentation integrations. New documentation and bug fixing continues to happen.
* We shipped version 2.0 of our `Read the Docs Sphinx Theme <https://sphinx-rtd-theme.readthedocs.io/en/stable/>`_, which adds support for new Sphinx releases and drops support for many old versions of Sphinx and Python.

You can always see the latest changes to our platforms in our `Read the Docs Changelog <https://docs.readthedocs.io/en/stable/changelog.html>`_.

Upcoming changes
----------------

* Addons will be made more configurable in our new beta dashboard, starting a trend of moving away from the old dashboard for new features.
* Our `beta dashboard <https://beta.readthedocs.org/>`_ continues to be tested in public beta, and new functionality for Addons configuration will only be available in that new interface.
* We continue to work on some business model changes enabled by the new redirects work, including allowing access to Forced Redirects for more users.

Want to follow along with our development progress? `View our full roadmap 📍️`_

.. _View our full roadmap 📍️: https://github.com/orgs/readthedocs/projects/156/views/1

Possible issues
---------------

* Users need to `update their webhooks <{filename}security-update-on-incoming-webhooks>`_ before **January 31, 2024** if they are configured without a secret. All users who need to take action should have received email and site notifications about this.
agjohnson marked this conversation as resolved.
Show resolved Hide resolved
* We are discussing removing support for all VCS systems except Git, as our userbase is heavily biased towards Git users and it will simplify maintenance and development of features. We stopped developing features for Mercurial, Subversion, and Bazaar years ago, and we are considering removing support for them entirely. We will be reaching out to these users to get feedback on this change.

-------

Questions? Comments? Ideas for the next newsletter? `Contact us`_!

.. Keeping this here for now, in case we need to link to ourselves :)

.. _Contact us: mailto:hello@readthedocs.org
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
ericholscher marked this conversation as resolved.
Show resolved Hide resolved
: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.