-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
95530e9
Update our GSOC page for 2019
ericholscher b43bf44
Comment out old warning
ericholscher 5ba4038
Update feature link
ericholscher 1d846c7
Remove api v3
ericholscher a3be0e7
Add new sphinx theme
ericholscher 79bef64
Move links
ericholscher File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
@@ -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 | ||
~~~~~~ | ||
|
||
|
@@ -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 | ||
* 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These links should go in the pull requests project |
||
|
||
Additional Ideas | ||
~~~~~~~~~~~~~~~~ | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.