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

Blog for search update #73

Merged
merged 14 commits into from Aug 13, 2019

Conversation

@dojutsu-user
Copy link
Member

commented Jul 15, 2019

No description provided.

@dojutsu-user

This comment has been minimized.

Copy link
Member Author

commented Jul 15, 2019

I think this is mostly copied from the last year gsoc blog. 😕

@davidfischer
Copy link
Contributor

left a comment

Overall, this is pretty good. I don't mind that it would be shorter. I do think however, that you should provide a screenshot or an animated gif here. A picture can be worth a thousand words sometimes in illustrating exactly what you added.

search-update.rst Outdated Show resolved Hide resolved
search-update.rst Outdated Show resolved Hide resolved
search-update.rst Outdated Show resolved Hide resolved
search-update.rst Outdated Show resolved Hide resolved
search-update.rst Outdated Show resolved Hide resolved
So, it is now possible to get instant results without being redirected to any other page.
Read the docs `here`_.

Contributors Wanted

This comment has been minimized.

Copy link
@davidfischer

davidfischer Jul 15, 2019

Contributor

These last two paragraphs are very similar to what was in Safwan's blog from last GSoC. I think it's fine to have a shorter blog without this information.

This comment has been minimized.

Copy link
@dojutsu-user

dojutsu-user Jul 16, 2019

Author Member

I think these two sections are necessary to convey the message that we are constantly looking for new contributors.

@@ -0,0 +1,90 @@
.. post:: July 15, 2019

This comment has been minimized.

Copy link
@davidfischer

davidfischer Jul 15, 2019

Contributor

Also, I think something like sphinx-search-as-you-type.html is probably a better URL than search-update.

This comment has been minimized.

Copy link
@dojutsu-user

dojutsu-user Jul 16, 2019

Author Member

Okay.
Do I need to change the blog title also?

@ericholscher
Copy link
Member

left a comment

This looks great! I think we're definitely close to shipping it, just a few small tweaks for me. 👍 💯

:author: Vaibhav
:location: LKO

Search Update

This comment has been minimized.

Copy link
@ericholscher

ericholscher Jul 19, 2019

Member

This could definitely use a better title. We should mention what we updated, instead of being vague.

This comment has been minimized.

Copy link
@dojutsu-user

dojutsu-user Jul 20, 2019

Author Member

I am not sure about what would be a better title.
What about: Search Update: Section Linking & Search As You Type Feature

This comment has been minimized.

Copy link
@davidfischer

davidfischer Aug 12, 2019

Contributor

I think search as you type is the biggest feature and it should definitely be in the title. I wouldn't be opposed to "Adding Search as You Type to Read the Docs" or something like that.

This comment has been minimized.

Copy link
@ericholscher

ericholscher Aug 12, 2019

Member

Yea, I'd like to make this title better before merging.

This comment has been minimized.

Copy link
@dojutsu-user

dojutsu-user Aug 13, 2019

Author Member

I don't have very strong opinion but I do think that Adding Search as You Type to Read the Docs focuses only on one feature?

This comment has been minimized.

Copy link
@ericholscher

ericholscher Aug 13, 2019

Member

"Search Update" means nothing, we need to tell people what was updated. I don't feel strongly what we focus on, but it needs more.

This comment has been minimized.

Copy link
@dojutsu-user

dojutsu-user Aug 13, 2019

Author Member

I am not in favor of Search Update also.
How about -- Adding Search as You Type to Read the Docs and much more?
Or we can just go with Adding Search as You Type to Read the Docs.

This comment has been minimized.

Copy link
@ericholscher

ericholscher Aug 13, 2019

Member

GSOC 2019: Improved Search Results and Search As You Type?

This comment has been minimized.

Copy link
@dojutsu-user

dojutsu-user Aug 13, 2019

Author Member

Loved that one. ❤️

This comment has been minimized.

Copy link
@dojutsu-user

dojutsu-user Aug 13, 2019

Author Member

Updated

sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
@dojutsu-user

This comment has been minimized.

Copy link
Member Author

commented Jul 20, 2019

@ericholscher
I have updated the PR.

dojutsu-user added 2 commits Aug 9, 2019
@dojutsu-user

This comment has been minimized.

Copy link
Member Author

commented Aug 9, 2019

@ericholscher
I have updated the blog.

@ericholscher
Copy link
Member

left a comment

Looks great. A few small suggestions, but I think it's ready to ship. 🚢

PR build here: https://external-builds.readthedocs.io/html/readthedocs-blog/73/sphinx-search-as-you-type/index.html

sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
sphinx-search-as-you-type.rst Outdated Show resolved Hide resolved
@dojutsu-user

This comment has been minimized.

Copy link
Member Author

commented Aug 9, 2019

@ericholscher Updated the PR
Is there a need to change the title?

@ericholscher

This comment has been minimized.

Copy link
Member

commented Aug 9, 2019

Looks good. I'll plan to merge this on Monday, if you want to update the date, it'll be good to go.

@dojutsu-user

This comment has been minimized.

Copy link
Member Author

commented Aug 10, 2019

@ericholscher
Updated the date and few small spelling corrections.

@davidfischer
Copy link
Contributor

left a comment

I made a few small suggestions but I think this is just about ready!

:author: Vaibhav
:location: LKO

Search Update

This comment has been minimized.

Copy link
@davidfischer

davidfischer Aug 12, 2019

Contributor

I think search as you type is the biggest feature and it should definitely be in the title. I wouldn't be opposed to "Adding Search as You Type to Read the Docs" or something like that.

(`readthedocs/readthedocs.org#5968`_)
- **Search Inside Sections**:
It would be good if users have the option to get the
search results from a particular section of the documentation.

This comment has been minimized.

Copy link
@davidfischer

davidfischer Aug 12, 2019

Contributor

From this description, this isn't totally clear what it would do.

This comment has been minimized.

Copy link
@dojutsu-user

dojutsu-user Aug 13, 2019

Author Member

I added an example.

@dojutsu-user

This comment has been minimized.

@ericholscher

This comment has been minimized.

Copy link
Member

commented Aug 13, 2019

👍

@ericholscher ericholscher merged commit 2972029 into readthedocs:master Aug 13, 2019

1 check passed

continuous-documentation/read-the-docs Read the Docs build succeeded!
Details

@dojutsu-user dojutsu-user deleted the dojutsu-user:blog-search-update branch Aug 13, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.