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

The "search" feature of concourse-ci.org needs some love (e.g. zero results for "pinning") #181

Closed
marco-m opened this issue Mar 18, 2019 · 7 comments

Comments

@marco-m
Copy link
Contributor

@marco-m marco-m commented Mar 18, 2019

Concourse 5 replaced "resource pausing" with "resource pinning". This is a fundamental aspect of Concourse, but searching for "pin" or "pinning" in the search bar on the top right of the website gives 0 results, although actually there is some text in the release notes in the https://concourse-ci.org/download.html page.

Not finding "pinning" is just an example; I remember other cases where I was looking for a Concourse concept in the search bar and had to fall back to various google search incantations to find it.

This is unfortunate because this means that also if the documentation of a feature/concept exists, it is actually invisible to somebody who doesn't already know it well.

@vito

This comment has been minimized.

Copy link
Member

@vito vito commented Apr 29, 2019

search was pretty broken and couldn't find simple results like 'vault', which is now fixed via 64b707d

however the specific things mentioned in this issue are not fixed by fixing search - that's more the fault of the documentation being literally nonexistant for pinning at the moment. release notes shouldn't really count as docs, and they aren't on the site anymore - we now put the release notes directly in the github releases.

maybe the next step would be to extend the search to also search content, not just titles? (and make sure that doesn't get in the way) it looks like we at least use the word 'pinned' here: https://concourse-ci.org/get-step.html#get-step-version

@marco-m

This comment has been minimized.

Copy link
Contributor Author

@marco-m marco-m commented Apr 30, 2019

Ah, I see. Yes, search should extend to content also. While we are talking about titles, the search has this (in my opinion counter-productive) characteristics of searching for single letters if a title has multiple words, generating wrong hits. I have to fall back to searching google with site: concourse-ci.org in the hope to find something :-(

@vito

This comment has been minimized.

Copy link
Member

@vito vito commented Apr 30, 2019

@marco-m Do you have an example of that with the new search functionality?

@vito vito closed this in f318f82 Apr 30, 2019
@vito

This comment has been minimized.

Copy link
Member

@vito vito commented Apr 30, 2019

Ok, I think this is all addressed by the above commit. 🙂 I special-cased single-letter word searches so they now require an exact match, and it'll now fall back on searching content if the title doesn't match. Content matches are also suggested after title matches so they don't get in the way of more likely searches.

@marco-m

This comment has been minimized.

Copy link
Contributor Author

@marco-m marco-m commented Apr 30, 2019

Thanks a lot vito! :-)
The exact match works, but I am not sure about the

it'll now fall back on searching content if the title doesn't match.

For example, the content contains the word "metal" (https://concourse-ci.org/generic-oauth.html), but if I search for metal, I get 0 hits. Or am I misunderstanding ?

@vito

This comment has been minimized.

Copy link
Member

@vito vito commented Apr 30, 2019

@marco-m Woops, hadn't pushed it yet. Should work once the GitHub deploy propagates:

Screenshot 2019-04-30 at 7 42 07 PM

@marco-m

This comment has been minimized.

Copy link
Contributor Author

@marco-m marco-m commented May 1, 2019

@vito thanks! This is a great improvement! ❤️

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