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

Feat/add docsearch #194

Merged
merged 3 commits into from
Mar 29, 2019
Merged

Feat/add docsearch #194

merged 3 commits into from
Mar 29, 2019

Conversation

s-pace
Copy link

@s-pace s-pace commented Mar 19, 2019

👋 Hello team,

Following helm/helm#4679, this PR add a search experience to the docs.

I'm part of the project called DocSearch which goal is to enhance documentation websites with exhaustive, fast and relevant search. You might have seen DocSearch live already on websites like Bootstrap, Reactjs or Gulp.

I have created a quick demo of what DocSearch enables on your documentation thanks to this PR. You can try it out here.
Live Demo

Happy to update the PR if needed.

Resolves #56

@flynnduism
Copy link
Member

Sylvian this is perfect! 🎉🎉🎉

Thank you for integrating this. Happy to 👍 this PR

@s-pace
Copy link
Author

s-pace commented Mar 19, 2019

@flynnduism thank you for the feedback 🙏. I have just cleaned up the noise introduced by the PR.

Feel free to ping me if you need anything before merging it.

@bacongobbler
Copy link
Member

Hi @s-pace! Thank you for working on this and showing us docsearch. Very neat piece of tech 👍

I had a question about the billing model. By merging this PR, are we subject to the pricing models displayed on the site? Is this service free for open source projects like Helm, or are we subject to the same billing model as others? How does that work? Thanks!

@s-pace
Copy link
Author

s-pace commented Mar 19, 2019

Hi @bacongobbler,

Thank you for your feedback 🎉. DocSearch is entirely free for open source project :). Helm does qualify in its entirety. It is our way to give back to the community.

If you want to have access to the analytics we provide for your DocSeach index (helm), please apply from here.

Copy link
Member

@bacongobbler bacongobbler left a comment

Choose a reason for hiding this comment

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

LGTM

@bridgetkromhout
Copy link
Member

Checked out https://docsearch-helm.surge.sh/docs/ and it looks good. Also checked out the local preview: https://deploy-preview-194--helm-merge.netlify.com/docs/ - LGTM.

@s-pace
Copy link
Author

s-pace commented Mar 29, 2019

@bridgetkromhout Thank you for the feedback 🙏

@bacongobbler Let us know if you need anything to make this happen 🔍

@flynnduism flynnduism merged commit 88b70c7 into helm:master Mar 29, 2019
@s-pace s-pace deleted the feat/add_docsearch branch March 29, 2019 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants