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

Algolia search index is outdated/broken #27139

Closed
1 task done
Alchemik opened this issue Sep 1, 2024 · 11 comments
Closed
1 task done

Algolia search index is outdated/broken #27139

Alchemik opened this issue Sep 1, 2024 · 11 comments
Labels
area: triage $$ bug-bounty $$ https://www.jhipster.tech/bug-bounties/ theme: undefined $200 https://www.jhipster.tech/bug-bounties/
Milestone

Comments

@Alchemik
Copy link

Alchemik commented Sep 1, 2024

1. Overview of the issue

The issue is related to jhipster.github.io. As it cannot be created in the original repository, I'm reporting it here.

Algolia search index seems to be outdated for at least some parts of the JHipster documentation.

2. Motivation for or Use Case

The search functionality on JHipster’s official documentation, powered by Algolia, appears to be using an outdated index. When I search for certain terms or topics, the results include outdated pages or miss recent additions and updates to the documentation.

3. Reproduce the error
  • Navigate to the JHipster documentation and use the Algolia search functionality:
    • In the search bar, enter a keyword which no longer exists in docs, in this case, jpaDerivedIdentifier
      image
  • Review the search results:
    • Notice that results point to outdated version of documentation, which was modified > 1 year ago
      image
  • Cross-check with the latest documentation:
    • Confirm that updates are missing from the search results
      image

2nd example

  • In the search bar, enter a keyword angularSuffix appearing on docs/jdl/options.mdx
  • Cross-check with the latest documentation and confirm that search result does not reference the searched page
    image
4. Related issues

N/A

5. Suggest a Fix

N/A

6. JHipster Version(s)

N/A

7. JHipster configuration

N/A

8. Browsers and Operating System
  • OS: macOS Sonoma, v14.6.1
  • Browser: Google Chrome, Version 128.0.6613.85 (Official Build) (arm64)
  • Checking this box is mandatory (this is just to show you read everything)
@Alchemik Alchemik changed the title Algolia search index is outdated Algolia search index is outdated/broken Sep 3, 2024
@mraible mraible added $$ bug-bounty $$ https://www.jhipster.tech/bug-bounties/ $200 https://www.jhipster.tech/bug-bounties/ labels Sep 13, 2024
@mraible
Copy link
Contributor

mraible commented Sep 13, 2024

Added a bug bounty to try and get this fixed.

@omurthy
Copy link

omurthy commented Sep 15, 2024

It needs to be re-indexed. I applied using the link below. They sent an email to the person registered with Alogolia on behalf of Jhipster. The instructions in that email need to be completed.

https://docsearch.algolia.com/

@SvMak
Copy link

SvMak commented Sep 18, 2024

Detailed docs about search configuration for Docusaurus and fix this issue https://docusaurus.io/docs/search#using-algolia-docsearch

It is necessary to compare the current configuration with the recommended one and manually reindex the new website, by someone with access to the Algolia account.

@mraible
Copy link
Contributor

mraible commented Sep 18, 2024

@jdubois Do you have access to the Algolia account or know who does?

@jdubois
Copy link
Member

jdubois commented Sep 18, 2024

This was setup by @sahbi-ktifa several years ago, I'm not sure we have anything else than a token to connect.

@omurthy
Copy link

omurthy commented Sep 24, 2024

I asked for any solution regarding this issue from the Algolia discord channel.

@omurthy
Copy link

omurthy commented Oct 9, 2024

@jdubois I contacted Algolia about access. They gave me access to the Algolia UI console. Also, Algolia's crawling method has changed. They informed us by email about the update but we missed it. Anyway, they told me that we need to update/migrate Jhipster's Algolia account. It took some time to work together and finally, it's done. I deployed it on my side for testing. It looks good. If everything is good enough for you, I'll change it to the live system as well.

@Alchemik Please check the new search on my testing page:
https://omurthy.github.io/jhipster.github.io/

@jdubois
Copy link
Member

jdubois commented Oct 9, 2024

Oh thanks so much, I did a quick test and that's good!!!

@Alchemik
Copy link
Author

Alchemik commented Oct 9, 2024

@omurthy thanks for the effort, is the test instance still up? I got 404 on every page except landing page

@omurthy
Copy link

omurthy commented Oct 9, 2024

@Alchemik check here :
https://deploy-preview-1396--jhipster-site.netlify.app/

@Alchemik
Copy link
Author

Alchemik commented Oct 9, 2024

LGTM 👍

@mraible mraible closed this as completed Oct 28, 2024
@mraible mraible added this to the 8.7.2 milestone Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: triage $$ bug-bounty $$ https://www.jhipster.tech/bug-bounties/ theme: undefined $200 https://www.jhipster.tech/bug-bounties/
Projects
None yet
Development

No branches or pull requests

5 participants