From a7d2b89a87d7c390cd887346343e81d82347470e Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Wed, 2 Feb 2022 16:11:39 -0800 Subject: [PATCH 1/5] Add initial Feb 2022 newsletter I've revamped the format a little bit to be less focused on each of our own goals, and to simplify writing it each month. --- newsletter-february-2022.rst | 82 ++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 newsletter-february-2022.rst diff --git a/newsletter-february-2022.rst b/newsletter-february-2022.rst new file mode 100644 index 00000000..860076f2 --- /dev/null +++ b/newsletter-february-2022.rst @@ -0,0 +1,82 @@ +.. post:: Feb 2, 2022 + :tags: newsletter, python + :author: Eric Holscher + :location: BND + +.. meta:: + :description lang=en: + Company updates and new features from last month, + current focus, and upcoming features in February. + +Read the Docs newsletter - February 2022 +======================================== + +Welcome to the latest edition of our monthly newsletter, where we +share the most relevant updates around Read the Docs, +offer a summary of new features we shipped +during the previous month, +and share what we'll be focusing on in the near future. + +Company updates +--------------- + +- We have mostly finished migrating Read the Docs for Business users to Cloudflare for SSL. + There are lots of interesting features this will enable, + so stay tuned for updates there. +- We're sad to announce that Juan Luis has moved on from Read the Docs as our developer advocate. + The work he did was vital towards getting our :doc:`CZI grant ` mostly finished, and we thank him for his time spent bettering the RTD, Sphinx, and docs community. +- On a related note, we're going to be hiring again soon to fill another position. + It will be a bit different and likely a product-focused Python development position. + If you're interested, please `let us know`_. + +.. _let us know: mailto:ads@readthedocs.org?subject=Job%20Posting + +New features +------------ + +In January we continued to work on refactors and internal changed. +Among the major user-facing changes: + +- We fixed a bug in BitBucket that didn't allow us to properly sync user permissions. + This resulted in a few support requests, but has now been resolved. +- We improved our ability to mark projects at non-spam, + so that we can validate a project isn't spam and then make sure it doesn't get flagged by our automated system. + +You can always see the latest changes to our platforms in our :doc:`Read the Docs +Changelog `. + +Upcoming features +----------------- + +- We're looking at tracking 404 pages in our project analytics, + so that projects can easily fix up missing or outdated page links. +- We are hoping to launch our revamped landing pages this month, + which will give our front page a much needed refresh. +- We are working to define a policy for canonical docs and cloned versions, + so that we can more easily remove outdated docs for projects. +- We're working to investigate supporting a CDN on Read the Docs for Business, + which will be an exciting new feature for our users there. +- We're `looking at how to support `_ multiple ``readthedocs.yml`` files in a single git repo. + +Possible issues +--------------- + +We continue to see a good place of development on the Sphinx project, +with them adding support for docutils 0.18, +and removing jQuery in a major refactor of their Javascript. +We're working to ensure that our theme and other parts of the ecosystem don't break with these changes, +and trying to be procative to address any possible issues. +That said, +there will likely still be some issues that sneak through with the release of Sphinx 4.5 (docutils upgrade) and Sphinx 5.0 (JS refactor). + +---- + +Considering using Read the Docs for your next Sphinx or MkDocs project? +Check out `our documentation `_ to get started! + +.. _Ana: https://github.com/nienn +.. _Anthony: https://github.com/agjohnson +.. _Eric: https://github.com/ericholscher +.. _Juan Luis: https://github.com/astrojuanlu +.. _Manuel: https://github.com/humitos +.. _Santos: https://github.com/stsewd From f39661a5a567f11af05c51398fd2c382cf07e791 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Wed, 2 Feb 2022 16:15:38 -0800 Subject: [PATCH 2/5] Fix link --- newsletter-february-2022.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/newsletter-february-2022.rst b/newsletter-february-2022.rst index 860076f2..b323300c 100644 --- a/newsletter-february-2022.rst +++ b/newsletter-february-2022.rst @@ -24,7 +24,7 @@ Company updates There are lots of interesting features this will enable, so stay tuned for updates there. - We're sad to announce that Juan Luis has moved on from Read the Docs as our developer advocate. - The work he did was vital towards getting our :doc:`CZI grant ` mostly finished, and we thank him for his time spent bettering the RTD, Sphinx, and docs community. + The work he did was vital towards getting our :doc:`CZI grant ` mostly finished, and we thank him for his time spent bettering the RTD, Sphinx, and docs community. - On a related note, we're going to be hiring again soon to fill another position. It will be a bit different and likely a product-focused Python development position. If you're interested, please `let us know`_. From 0a703c26ba9ea4955b24257f65349f027c383fc2 Mon Sep 17 00:00:00 2001 From: Eric Holscher <25510+ericholscher@users.noreply.github.com> Date: Tue, 8 Feb 2022 13:18:59 -0800 Subject: [PATCH 3/5] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Anthony Co-authored-by: Manuel Kaufmann Co-authored-by: Juan Luis Cano Rodríguez --- newsletter-february-2022.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/newsletter-february-2022.rst b/newsletter-february-2022.rst index b323300c..aac746da 100644 --- a/newsletter-february-2022.rst +++ b/newsletter-february-2022.rst @@ -29,17 +29,17 @@ Company updates It will be a bit different and likely a product-focused Python development position. If you're interested, please `let us know`_. -.. _let us know: mailto:ads@readthedocs.org?subject=Job%20Posting +.. _let us know: mailto:hello@readthedocs.org?subject=Job%20Posting New features ------------ -In January we continued to work on refactors and internal changed. +In January we continued to work on refactors and internal changes. Among the major user-facing changes: -- We fixed a bug in BitBucket that didn't allow us to properly sync user permissions. +- We fixed a bug in Bitbucket that didn't allow us to properly sync user permissions. This resulted in a few support requests, but has now been resolved. -- We improved our ability to mark projects at non-spam, +- We improved our ability to mark projects as non-spam, so that we can validate a project isn't spam and then make sure it doesn't get flagged by our automated system. You can always see the latest changes to our platforms in our :doc:`Read the Docs @@ -61,7 +61,7 @@ Upcoming features Possible issues --------------- -We continue to see a good place of development on the Sphinx project, +We continue to see a good pace of development on the Sphinx project, with them adding support for docutils 0.18, and removing jQuery in a major refactor of their Javascript. We're working to ensure that our theme and other parts of the ecosystem don't break with these changes, From e4ae2b72a719d13148e8c511249a445b749f9978 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 8 Feb 2022 13:20:25 -0800 Subject: [PATCH 4/5] A few small updates --- _themes/rtd-blog/social.html | 4 +--- hiring/details.rst | 11 +++++++---- hiring/intro.rst | 2 +- newsletter-february-2022.rst | 5 ++++- 4 files changed, 13 insertions(+), 9 deletions(-) diff --git a/_themes/rtd-blog/social.html b/_themes/rtd-blog/social.html index 7bbbaf1a..3af67306 100644 --- a/_themes/rtd-blog/social.html +++ b/_themes/rtd-blog/social.html @@ -46,12 +46,10 @@

Thank you!

-

Follow us

diff --git a/hiring/details.rst b/hiring/details.rst index 1d9608e7..75270f79 100644 --- a/hiring/details.rst +++ b/hiring/details.rst @@ -26,23 +26,26 @@ given the grant work that will be part of this role. **We realize that you might not know all of our tools, please reach out if you think you'd be a good fit.** -We are a fully remote company and our team is currently based in the US, South America, and in Europe. +We are a fully remote company and our team is currently based in the US, South America, and Europe. We hope to work with people that are based in timezone where we have some overlap with the entire team, -which is around UTC-8 to UTC+1. - +which is around **UTC-8 to UTC+1**. Structure --------- -We are currently only able to offer contracts to work on the project. +We are currently only able to offer a contract to work on the project. We would contract you to work 4-5 days a week. Half of our team works 4 days, and the other half works 5 days, and we are happy to be flexible with whatever works best for you. +We do offer the ability to expense work-related computer equipment, +home office gear, and other approved expenses. After an initial interview, we normally do a small paid project (4-6 hours) to see how we work together. Assuming that goes well, we will offer a contract until the end of the calendar year. +This contract then would be renewed yearly, +along with evaluating pay and other benefits. The pay rate will vary with experience and the number of days worked. As a small, self-sustaining open source project we are not able to pay as much as large companies. diff --git a/hiring/intro.rst b/hiring/intro.rst index 7e220ceb..8877833d 100644 --- a/hiring/intro.rst +++ b/hiring/intro.rst @@ -1,5 +1,5 @@ Thanks for your interest in working at Read the Docs. -We are a small team of 5, and we're looking to add 2-3 people in 2021, +We are a small team of 7, and we're looking to add 1-2 people in 2022, and we'd love for you to be one of them. About the company diff --git a/newsletter-february-2022.rst b/newsletter-february-2022.rst index aac746da..a388039f 100644 --- a/newsletter-february-2022.rst +++ b/newsletter-february-2022.rst @@ -23,7 +23,7 @@ Company updates - We have mostly finished migrating Read the Docs for Business users to Cloudflare for SSL. There are lots of interesting features this will enable, so stay tuned for updates there. -- We're sad to announce that Juan Luis has moved on from Read the Docs as our developer advocate. +- We're sad to announce that `Juan Luis`_ has moved on from Read the Docs as our developer advocate. The work he did was vital towards getting our :doc:`CZI grant ` mostly finished, and we thank him for his time spent bettering the RTD, Sphinx, and docs community. - On a related note, we're going to be hiring again soon to fill another position. It will be a bit different and likely a product-focused Python development position. @@ -48,6 +48,7 @@ Changelog `. Upcoming features ----------------- +- Cancelling a build is a long requested feature, and we're getting close to implementing it. - We're looking at tracking 404 pages in our project analytics, so that projects can easily fix up missing or outdated page links. - We are hoping to launch our revamped landing pages this month, @@ -74,6 +75,8 @@ there will likely still be some issues that sneak through with the release of Sp Considering using Read the Docs for your next Sphinx or MkDocs project? Check out `our documentation `_ to get started! +.. Keeping this here for now, in case we need to link to ourselves :) + .. _Ana: https://github.com/nienn .. _Anthony: https://github.com/agjohnson .. _Eric: https://github.com/ericholscher From 65eb78625bfc80c1818b1f5dfdde4182dee91de7 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 8 Feb 2022 13:21:07 -0800 Subject: [PATCH 5/5] Change publish date --- newsletter-february-2022.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/newsletter-february-2022.rst b/newsletter-february-2022.rst index a388039f..a5ffb770 100644 --- a/newsletter-february-2022.rst +++ b/newsletter-february-2022.rst @@ -1,4 +1,4 @@ -.. post:: Feb 2, 2022 +.. post:: Feb 8, 2022 :tags: newsletter, python :author: Eric Holscher :location: BND