Skip to content

Latest commit

 

History

History
133 lines (97 loc) · 5.89 KB

job-frontend.rst

File metadata and controls

133 lines (97 loc) · 5.89 KB
orphan:

Job Posting: Frontend developer with design skills

Update: This role has been filled. If you're interested in working with us, we're always happy to hear from you, but we aren't actively hiring for this role currently.

About the job

This job will be our first frontend developer hire. We have a couple members of the team who have some knowledge in this space, but we hope you will grow to lead our efforts in this area over time.

At the beginning of the year, we received a :doc:`grant to support scientific software</czi-grant-announcement>`. Given this grant, the job will have two major parts:

  • Around half your time will be spent working on work related to scientific software. This focuses on improving our documentation embedding client in JavaScript, and working to integrate it into widely used scientific development platforms (eg. Jupyter).
  • The other half of your time will be spent working on Read the Docs itself, outside of the grant funding. We are working on a site redesign, along with many other places where we have long-standing UX and design issues.

We have two major places that users interact with Read the Docs:

  • Our application, where users manage their documentation builds.
  • The "documentation pages" which we publish, where 99% of users only read docs, and might not even know Read the Docs is hosting.

Our goal is to improve both of these experiences for our users.

We are working on a full dashboard redesign which is around 80% finished. One of our first priorities would be for you to come onboard and help us get it finished. This project will give you a very wide understanding of the platform from the start.

The other major priority with the grant work will be a greenfield implementation of a JavaScript client to embed documentation from the Read the Docs API. We have some initial prototypes of this work, but you will be responsible for architecting and shipping this new library for the grant. We have some ideas on the direction we want to go here, but you'll have a lot of influence in this major new initiative.

Technical Details

Read the Docs is a large open source web application. The current technologies that we're using are:

  • Semantic UI for views and styles in our application
  • Knockout for view/model binding
  • Webpack for bundling of CSS and JavaScript
  • Django templates for our application views
  • Jinja templates for our marketing content and Sphinx theme design

You don't need to be familiar with these exact technologies, but having experience with a web-based stack is helpful (eg. Rails, Node, PHP).

Our team has more experience with Python and Django than with JavaScript, so our application UI is driven by a hybrid system that primarily relies on application code and Django templates for display. Most of the work that will go into maintaining our application views will be working with Semantic UI inside Django templates, with Knockout connecting HTML to client side code where client side rendering and interaction is preferred.

Our marketing and landing page content will be a separate project that will use some of the same underlying technologies, but will have very few visual constraints compared to our application. We will be looking for your guidance here in building this project out.

Separate from our application, we also maintain a widely used Sphinx theme. You'll share some of the maintenance effort on this theme, however it is also a fairly mature project that mostly requires bug fixes.

Applying

We will be accepting applications on an ongoing basis until the position is filled.

Update: This role has been filled. If you're interested in working with us, we're always happy to hear from you, but we aren't actively hiring for this role currently.