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

Where is the search? #186

Open
dmick opened this issue Oct 5, 2023 · 3 comments
Open

Where is the search? #186

dmick opened this issue Oct 5, 2023 · 3 comments

Comments

@dmick
Copy link

dmick commented Oct 5, 2023

How can you have a docs landing page without a search box?

@divyam8175
Copy link

can i solve the issue

@samccann
Copy link
Collaborator

Hey @dmick - very valid point. I'm going to ping @oraNod but I believe this will come in the future. We're mid-stream on making improvements overall to the docsite.

@oraNod
Copy link
Collaborator

oraNod commented Oct 23, 2023

hey @dmick thanks for taking the time to give us this feedback and to create the issue.

there has been some discussion around this on Matrix (feel free to join us in the docs channel if you haven't already joined). options like embedding a custom google search bar have been brought forward in the past but usually pose privacy concerns and are really of limited value to the Ansible community.

I think the ideal outcome would be full search across the entire documentation set available to the community, not just the package docs and what is currently on docs.ansible.com. we're working through some changes to host most of the content on ReadTheDocs, which offers really nice cross-project search. in fact you can try that right now by going to:

https://ansible.readthedocs.io/en/latest

look for the ReadTheDocs widget then try searching across all the subprojects:

image

this uses elastic search and is generally agreed upon as a more suitable open-source alternative. of course all opinions and insights are welcome so let us know if you have any thoughts or comments.

as @samccann mentioned we're still in-flight with this effort and have a ways to go before we can get fully integrated search on the docs landing pages that includes the package docs and everything else under the sun. that said we have made a good bit of progress and hope to get there sooner rather than later. it wasn't so long ago that search was scoped to each individual project only.

I hope this answers your questions - and if it raises any others please let us know. thanks.

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

No branches or pull requests

4 participants