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

Add a number of new ideas for GSOC #3552

Merged
merged 1 commit into from
Jan 26, 2018
Merged
Changes from all 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
67 changes: 67 additions & 0 deletions docs/gsoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,73 @@ It would be great to have wrappers for the following as a start:
The goal would also be to make it quite easy for users to contribute third party build steps for Read the Docs,
so that other useful parts of the Sphinx ecosystem could be tightly integrated with Read the Docs.

Refactor 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:`/yaml-config` 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.

Integrated Redirects
~~~~~~~~~~~~~~~~~~~~

Right now it's hard for users to rename files.
We support redirects,
but don't create them automatically on file rename,
and our redirect code is brittle.

We should rebuild how we handle redirects across a number of cases:

* Detecting a file change in git/hg/svn and automatically creating a redirect
* Support redirecting an entire domain to another place
* Support redirecting versions

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.

API V3
~~~~~~

Copy link
Member

Choose a reason for hiding this comment

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

This would be a cool project

We currently have a "v2" API that isn't well documented and doesn't allow users to write to it.
We want to continue using Django REST Framework for this,
but rethink how we're presenting our information to our users.

Currently we're showing everything as simple "models",
and we want to start exposing "methods" on our data,
similar to GitHub.

This is a large project and should only be done by someone who has done some basic API design previously.

Improve Translation Workflow
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Currently we have our documentation & website translated on Transifex,
but we don't have a management process for it.
This means that translations will often sit for months before making it back into the site and being available to users.

This project would include puting together a workflow for translations:

* Communicate with existing translators and see what needs they have
* Help formalize the process that we have around Transifex to make it easier to contribute to
* Improve our tooling so that integrating new translations is easier

Additional Ideas
~~~~~~~~~~~~~~~~

Expand Down