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

added previous year gsoc projects #6333

Merged
merged 8 commits into from Oct 31, 2019

Conversation

KartikKapil
Copy link
Contributor

@KartikKapil KartikKapil commented Oct 26, 2019

Closes #6156
Added previous year gsoc project to the gsoc.rst file

Copy link
Member

@ericholscher ericholscher left a comment

Thanks!

docs/gsoc.rst Outdated

* Search Improvement (2018) (https://summerofcode.withgoogle.com/archive/2018/projects/4656335308193792/)
* Improved Search And Search As You Type (2019) (https://summerofcode.withgoogle.com/archive/2019/projects/6376055881859072/)

Copy link
Member

@ericholscher ericholscher Oct 28, 2019

Choose a reason for hiding this comment

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

Should remove this space.

Copy link
Contributor Author

@KartikKapil KartikKapil Oct 29, 2019

Choose a reason for hiding this comment

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

removed it

Copy link
Member

@dojutsu-user dojutsu-user left a comment

This is a good first approach.
Few comments.

docs/gsoc.rst Outdated
@@ -184,6 +184,15 @@ which provide outlines on the larger tasks that we're hoping to accomplish.
.. _these issues: https://github.com/readthedocs/readthedocs.org/issues?direction=desc&labels=Feature&page=1&sort=updated&state=open
.. _milestones: https://github.com/readthedocs/readthedocs.org/milestones

Some previous year project selected in Google Summer Of Code
Copy link
Member

@dojutsu-user dojutsu-user Oct 29, 2019

Choose a reason for hiding this comment

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

I think the heading can be improved to something like: Previous Years Projects.
Currently, Some suggests that some projects are not listed.

docs/gsoc.rst Outdated
@@ -184,6 +184,15 @@ which provide outlines on the larger tasks that we're hoping to accomplish.
.. _these issues: https://github.com/readthedocs/readthedocs.org/issues?direction=desc&labels=Feature&page=1&sort=updated&state=open
.. _milestones: https://github.com/readthedocs/readthedocs.org/milestones

Some previous year project selected in Google Summer Of Code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copy link
Member

@dojutsu-user dojutsu-user Oct 29, 2019

Choose a reason for hiding this comment

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

I think this should be a separate sub-section. So It should be ---------- instead of ~~~~~~.
You can read more about this here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections

docs/gsoc.rst Outdated
* Search Improvement (2018) (https://summerofcode.withgoogle.com/archive/2018/projects/4656335308193792/)
* Improved Search And Search As You Type (2019) (https://summerofcode.withgoogle.com/archive/2019/projects/6376055881859072/)

* Building Docs For Pull Requests(2019) (https://summerofcode.withgoogle.com/archive/2019/projects/6239099793440768/)
Copy link
Member

@dojutsu-user dojutsu-user Oct 29, 2019

Choose a reason for hiding this comment

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

Issue description describes to link the blog posts published in blog.readthedocs.com and not the GSoC links. It should be something like this:

Copy link
Member

@stsewd stsewd left a comment

Would be nice to have the recent projects first (2019 first then 2018)

docs/gsoc.rst Outdated Show resolved Hide resolved
docs/gsoc.rst Outdated

* `Search Improvement (2018) <https://summerofcode.withgoogle.com/archive/2018/projects/4656335308193792/>`_
* `Improved Search And Search As You Type (2019) <https://summerofcode.withgoogle.com/archive/2019/projects/6376055881859072/>`_

Copy link
Member

@stsewd stsewd Oct 29, 2019

Choose a reason for hiding this comment

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

Suggested change

KartikKapil and others added 2 commits Oct 30, 2019
Co-Authored-By: Santos Gallegos <santos_g@outlook.com>
docs/gsoc.rst Outdated
@@ -184,6 +184,14 @@ which provide outlines on the larger tasks that we're hoping to accomplish.
.. _these issues: https://github.com/readthedocs/readthedocs.org/issues?direction=desc&labels=Feature&page=1&sort=updated&state=open
.. _milestones: https://github.com/readthedocs/readthedocs.org/milestones

Projects from previous years
------------------
Copy link
Member

@stsewd stsewd Oct 30, 2019

Choose a reason for hiding this comment

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

The length of the - should be the same as the title, that's the reason Travis is failing

Copy link
Member

@dojutsu-user dojutsu-user left a comment

This is almost ready to be merged. 👍

docs/gsoc.rst Outdated
* `Improved Search And Search As You Type (2019) <https://summerofcode.withgoogle.com/archive/2019/projects/6376055881859072/>`_

* `Building Docs For Pull Requests(2019) <https://summerofcode.withgoogle.com/archive/2019/projects/6239099793440768/>`_
* `Search Improvement (2018) <https://summerofcode.withgoogle.com/archive/2018/projects/4656335308193792/>`_
Copy link
Member

@dojutsu-user dojutsu-user Oct 30, 2019

Choose a reason for hiding this comment

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

Links should be of blog.readthedocs.com.

docs/gsoc.rst Outdated
* `Improved Search And Search As You Type (2019) <https://blog.readthedocs.com/search-improvements/>`_
* `Building Docs For Pull Requests(2019) <https://blog.readthedocs.com/building-docs-for-pull-requests/>`_
* `Search Improvement (2018) <https://blog.readthedocs.com/improved-search-and-search-as-you-type/>`_

Copy link
Member

@dojutsu-user dojutsu-user Oct 31, 2019

Choose a reason for hiding this comment

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

Links for Improved Search And Search As You Type and Search Improvement are wrong.

docs/gsoc.rst Outdated Show resolved Hide resolved
Co-Authored-By: Vaibhav Gupta <vaibhgupt199@gmail.com>
stsewd
stsewd approved these changes Oct 31, 2019
Copy link
Member

@stsewd stsewd left a comment

Thanks!

docs/gsoc.rst Outdated
* `Improved Search And Search As You Type (2019) <https://blog.readthedocs.com/search-improvements/>`_
* `Building Docs For Pull Requests (2019) <https://blog.readthedocs.com/building-docs-for-pull-requests/>`_
* `Search Improvement (2018) <https://blog.readthedocs.com/improved-search-and-search-as-you-type/>`_

Copy link
Member

@dojutsu-user dojutsu-user Oct 31, 2019

Choose a reason for hiding this comment

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

Links are not correct.
Correct links are as follows:

Copy link
Member

@stsewd stsewd Oct 31, 2019

Choose a reason for hiding this comment

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

oh, yes. The link for search improvements and search as you type are swapped

Copy link
Contributor Author

@KartikKapil KartikKapil Oct 31, 2019

Choose a reason for hiding this comment

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

i have updated the given issue

Copy link
Member

@dojutsu-user dojutsu-user left a comment

Looks Good.
Thanks @KartikKapil 🎉 🎉 💯

@stsewd stsewd merged commit d7e11e0 into readthedocs:master Oct 31, 2019
2 checks passed

* `Improved Search And Search As You Type (2019) <https://blog.readthedocs.com/improved-search-and-search-as-you-type/>`_
* `Building Docs For Pull Requests (2019) <https://blog.readthedocs.com/building-docs-for-pull-requests/>`_
* `Search Improvement (2018) <https://blog.readthedocs.com/search-improvements/>`_
Copy link
Member

@humitos humitos Nov 1, 2019

Choose a reason for hiding this comment

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

Aren't we missing Config file V2 here? https://blog.readthedocs.com/configuration-file-v2/

Copy link
Member

@stsewd stsewd Nov 1, 2019

Choose a reason for hiding this comment

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

It wasn't officially a GSoC project, so

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants