Skip to content

Update our GSOC page for 2019 #5210

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

Merged
merged 6 commits into from
Feb 4, 2019
Merged
Changes from 2 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
53 changes: 23 additions & 30 deletions docs/gsoc.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
Google Summer of Code
=====================

.. note:: Thanks for your interest in Read the Docs!
We are working hard to update the ideas list now that we are accepted in GSOC.
Please give us a little while to work on things,
and check back on this page for updates.
..
.. note:: Thanks for your interest in Read the Docs!
We are working hard to update the ideas list now that we are accepted in GSOC.
Please give us a little while to work on things,
and check back on this page for updates.

Read the Docs is participating in the Google Summer of Code in 2018.
Read the Docs is hoping to be in the Google Summer of Code in 2019.
This page will contain all the information for students and anyone else interested in helping.

Skills
Expand Down Expand Up @@ -63,31 +64,6 @@ We will consider the priority on our roadmap as a factor,
along with the skill of the student,
in our selection process.

Refactor & improve our search code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Currently we're using a homegrown library for Elastic Search.
There is a new `elasticsearch-dsl <http://elasticsearch-dsl.readthedocs.io/en/latest/>`_ library that we should be using.
This project will include:

* Improving our search indexing
* Refactoring how we "model" our search data to use elasticsearch-dsl Models
* Add additional search data into our indexes, like the programming languages, type of document (tutorial, api, etc.) and other data for users to filter by
* (Optional) Improve the UX of the search for users in various ways

Finish YAML config
~~~~~~~~~~~~~~~~~~

Currently we have a basic :doc:`configuration file <config-file/v1>` for Read the Docs.
It's still considered beta,
and there are a number of features that it doesn't support.
We need to support everying users can currently do from our website dashboard inside the YAML file,
and then plan a smooth transition path from the database UI to the YAML file.

This is a *large* project and will likely require a good deal of understanding of both Python as well as web technologies.
We have a `starting list of issues <https://github.com/rtfd/readthedocs.org/milestone/28>`_ put together,
but there will be much more work.

API V3
~~~~~~

Expand Down Expand Up @@ -164,6 +140,23 @@ We should rebuild how we handle redirects across a number of cases:

There will also be a good number of things that spawn from this, including version aliases and other related concepts, if this task doesn't take the whole summer.

Autobuild docs for Pull Requests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

It would be great to automatically build docs for Pull Requests in GitHub repos that our users have.
Currently we don't support this,
and it's one of our most requested features.

This would include:

* Modeling Pull Requests as a type of version alongside Tags and Branches
* Modifying how we upload HTML docs to store them in a place like S3 for long term storage
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Long term storage for docs from a PR?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, we really don't want them on our web servers which are already space limited.

* Build integration with GitHub to send the status notifications when a PR is building and complete

More info here:

* https://github.com/rtfd/readthedocs.org/issues/1340
* https://github.com/rtfd/readthedocs.org/issues/2465
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links should go in the pull requests project


Additional Ideas
~~~~~~~~~~~~~~~~
Expand Down