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

Update our GSOC page for 2019 #5210

Merged
merged 6 commits into from Feb 4, 2019
Merged

Update our GSOC page for 2019 #5210

merged 6 commits into from Feb 4, 2019

Conversation

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Jan 31, 2019

This adds a new idea for PR building.

We should also add other ideas that we've had,
especially if they are ~3-6 months out on the roadmap

@ericholscher ericholscher requested a review from Jan 31, 2019
Copy link
Member

@stsewd stsewd left a comment

There is a link at the end to a label that we don't use anymore, it has this text Looking through these issues is a

@davidfischer
Copy link
Contributor

@davidfischer davidfischer commented Jan 31, 2019

Here's some thoughts:

  • Should we remove APIv3 since @humitos is working on it actively?
  • I don't know if it is a great project but if we can attract any designers, I'd love to commission a Sphinx2 theme. Sphinx2 is going to be all HTML5 so a modern web framework could be used.
  • This is not well thought through, but getting more different types of docs (on top of Sphinx/MkDocs) would be very cool

@stsewd
Copy link
Member

@stsewd stsewd commented Jan 31, 2019

What about improving the mkdocs integration? #4588 #4924

Not sure if we want to focus on mkdocs for GSoC

Copy link
Member

@humitos humitos left a comment

I like the changes.

Also, as @davidfischer said APIv3 could be listed here and I could mentor a student on that if you consider that we want to go in that path. Although, this probably means that we won't have this feature working before September...

👍 on adding a Sphinx2 theme and 👎 on spending time adding another type of docs (I suppose that this will be replaced/done via "Upload built docs")

docs/gsoc.rst Outdated
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

@humitos humitos Feb 4, 2019

Long term storage for docs from a PR?

Copy link
Member Author

@ericholscher ericholscher Feb 4, 2019

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

@ericholscher
Copy link
Member Author

@ericholscher ericholscher commented Feb 4, 2019

I've removed apiv3 and added a Sphinx v2 theme section, but it isn't great. Will merge this today because of the application deadline, but if people have concrete additions, please propose them in new PR's

@ericholscher ericholscher requested a review from Feb 4, 2019
@ericholscher
Copy link
Member Author

@ericholscher ericholscher commented Feb 4, 2019

@rtfd/core Would love a 👍 today if folks think this is ready.

docs/gsoc.rst Outdated

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

@stsewd stsewd Feb 4, 2019

These links should go in the pull requests project

stsewd
stsewd approved these changes Feb 4, 2019
Copy link
Member

@stsewd stsewd left a comment

LGTM

@ericholscher ericholscher merged commit 2bf6e99 into master Feb 4, 2019
0 of 2 checks passed
@delete-merged-branch delete-merged-branch bot deleted the gsoc-2019 branch Feb 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants