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

Index docs.quarkiverse.io #143

Open
gastaldi opened this issue Jan 15, 2024 · 6 comments · May be fixed by #260
Open

Index docs.quarkiverse.io #143

gastaldi opened this issue Jan 15, 2024 · 6 comments · May be fixed by #260

Comments

@gastaldi
Copy link

It would be nice if we could also add a search box to docs.quarkiverse.io using the same mechanism in https://quarkus.io/guides/.

Bonus points if Quarkiverse guides are shown in https://quarkus.io/guides too.

@yrodiere
Copy link
Member

yrodiere commented Jan 15, 2024

Thanks for filing this.

Copying my comments from Zulip:

  1. Currently we only index the quarkiverse docs that are mentioned on quarkus.io, which is not a lot. We'll need to find some other index (+ metadata) if we want to index more than that. We may also need to retrieve the pages differently (currently we do HTTP requests, I don't think that will scale -- cloning the GitHub Pages branch would be better).
  2. We'll need a separate UI. Since @ia3andy 's work will lead to the UI being implemented quite differently, it would probably be best to wait for that to be done and use it from the start.
  3. I think Quarkiverse docs are multi-page, so we'll need to think how we handle that (i.e. should search results show guides with a link pointing to the beginning of the guide, or pages with a link pointing directly to the relevant page)

And also:

Bonus points if Quarkiverse guides are shown in https://quarkus.io/guides too.

one challenge would be to properly boost up the non-quarkiverse guides in the search results to avoid some quarkiverse docs "taking over" quarkus.io :)

@holly-cummins
Copy link

  1. Currently we only index the quarkiverse docs that are mentioned on quarkus.io, which is not a lot. We'll need to find some other index (+ metadata) if we want to index more than that. We may also need to retrieve the pages differently (currently we do HTTP requests, I don't think that will scale -- cloning the GitHub Pages branch would be better).

The site at http://quarkus.io/extensions lists each extension's guide, so that might be a natural starting point for the index, since it comes with some built-in metadata. (Well, sort of.)

@gsmet
Copy link
Member

gsmet commented Jan 16, 2024

Other potential entry point if you plan to clone the repositories and want to parse the AsciiDoc: https://github.com/quarkiverse/quarkiverse-docs/blob/main/antora-playbook.yml

@yrodiere
Copy link
Member

Note to implementors, see #157:

Also, for now we still duplicate Quarkiverse guides per Quarkus version, but we could probably get rid of that too if we were to solve #143 by:

  • Taking metadata for those guides from a version-independent source (e.g.
    the Quarkiverse docs GitHub repo).
  • AND allowing search results on quarkus.io to return Quarkiverse guides
    independently from whether they are referenced in
    quarkus.yaml/quarkiverse.yaml.

@marko-bekhta marko-bekhta linked a pull request May 13, 2024 that will close this issue
@marko-bekhta
Copy link
Collaborator

Hey all 😃

I've drafted something that would index the Quarkiverse docs. It'll automatically include them in the search results on https://quarkus.io/guides/.

Someone might think I went for the bonus points right away 😄:

Bonus points if Quarkiverse guides are shown in https://quarkus.io/guides too.

Now as for the https://docs.quarkiverse.io/index/explore/index.html ... there's no search at all on this page at the moment. Hence I'm thinking that we can add the search input here at the top:

image

and then display the results in the main area as:

image

any other ideas?

@gastaldi
Copy link
Author

Awesome! It would be nice if it had some indicator saying that the area represents the search results (maybe a different background color?)

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 a pull request may close this issue.

5 participants