Skip to content

Commit 94822b4

Browse files
agjohnsonericholscherhumitos
authored
Add blog post about rollout steps (#335)
* Add blog post about rollout steps - Fixes #329 * Apply suggestions from code review Co-authored-by: Eric Holscher <[email protected]> * Clarify more about what is changing in hosted documentation * Update content/posts/rollout-of-our-new-dashboard.rst --------- Co-authored-by: Eric Holscher <[email protected]> Co-authored-by: Manuel Kaufmann <[email protected]>
1 parent 9e52a68 commit 94822b4

File tree

2 files changed

+90
-0
lines changed

2 files changed

+90
-0
lines changed

content/images/new-dashboard.png

164 KB
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
:title: Rollout of our new dashboard
2+
:date: 2024-11-12
3+
:description: Our new dashboard will begin rolling out to users.
4+
Learn what to expect and how it will affect you and your project.
5+
:category: Changelog
6+
:tags: dashboard
7+
:authors: Anthony Johnson
8+
:status: published
9+
:image: /images/new-dashboard.png
10+
:image_credit: Reviewing build output for a project in our new dashboard
11+
12+
For the last year, you may have seen notifications and hints asking you to try
13+
out our new dashboard. This new dashboard has been a long term project to
14+
completely replace our original user interface with one that is more
15+
consistent and allows us to more easily build and maintain complex features.
16+
17+
During the next few months, we will begin the transition to our new dashboard
18+
and will move away from our current, *but soon to be legacy*, dashboard.
19+
20+
If you are not yet using our new dashboard, here is what you need to know:
21+
22+
The new dashboard will start to become the default dashboard
23+
After this change, users logging in from our website will be logging into
24+
our new dashboard. *Users will still be able to switch back to the legacy
25+
dashboard if they need to*.
26+
27+
- On `Read the Docs Community`_ this change will go into effect on **Nov 12th**
28+
- On `Read the Docs Business`_ this change will go into effect on **Dec 10th**
29+
30+
To log in to the new dashboard:
31+
32+
- Users of `Read the Docs Community`_ can log in at https://app.readthedocs.org/account/login
33+
- Users of `Read the Docs Business`_ can log in at https://app.readthedocs.com/account/login
34+
35+
The legacy dashboard will be available until Mar 11th, 2025
36+
Our legacy dashboard will remain available while users are transitioning to
37+
our new dashboard. During this period, our legacy dashboard will no longer
38+
be receiving updates or new features, but it will remain active. Our legacy
39+
dashboard will only be available for this limited period, after which it
40+
will be shut down for all users.
41+
42+
To log in to the legacy dashboard:
43+
44+
- Users of `Read the Docs Community`_ can log in at https://readthedocs.org/account/login
45+
- Users of `Read the Docs Business`_ can log in at https://readthedocs.com/account/login
46+
47+
48+
How is the new dashboard different?
49+
-----------------------------------
50+
51+
You should find that the new dashboard is more consistent and that navigation
52+
around the dashboard is easier overall. New features were added for sorting and
53+
filtering, build output is easier to browser and share, and project and version
54+
creation is more intuitive.
55+
56+
The new dashboard contains many other updates and new features as well. In the
57+
coming weeks we will be highlighting in more detail what new features were
58+
added, interfaces that have been updated, and some of the technical changes
59+
introduced.
60+
61+
Documentation page changes
62+
~~~~~~~~~~~~~~~~~~~~~~~~~~
63+
64+
Rollout of our new dashboard will also be apparent on hosted documentation.
65+
There are several pages in hosted documentation where our own dashboard is
66+
visible to readers:
67+
68+
Documentation error pages
69+
We display an error page to readers when we encounter a problem with their
70+
request, like when a requested file is missing (HTTP 404 error).
71+
72+
We do not show our error page when a custom 404 error page is provided by a
73+
project.
74+
75+
Authentication forms
76+
This includes documentation authentication pages, such as password and
77+
GitHub authentication, and documentation sharing pages, such as sharing
78+
password entry.
79+
80+
On **Dec 10th**, projects hosted on `Read the Docs Business`_ will
81+
use our new dashboard for these pages in their hosted documentation.
82+
83+
*There will be no changes to user generated documentation otherwise.*
84+
85+
If you would like to update your project to use these pages before then,
86+
`contact us`_.
87+
88+
.. _`Read the Docs Community`: https://readthedocs.org
89+
.. _`Read the Docs Business`: https://readthedocs.com
90+
.. _`contact us`: https://app.readthedocs.com/support

0 commit comments

Comments
 (0)