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

Add workflows to use github-issues-scraper after docs-scraper on deploy #404

Closed
wants to merge 5 commits into from

Conversation

tpayet
Copy link
Member

@tpayet tpayet commented Jun 11, 2020

This PR add the github-issues-scraper run after docs-scraper during deploy of documentation.
It adds the ability to search through GitHub issues & PR of meilisearch/meilisearch from the documentation search bar.

The worklfow is almost done but I still have an issue regarding links that are not directing to GitHub

@tpayet tpayet requested a review from curquiza June 11, 2020 13:23
Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

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

Are all the settings set up to this repo? 🙂

.github/workflows/gh-pages-scraping.yml Outdated Show resolved Hide resolved
.github/workflows/gh-pages-scraping.yml Outdated Show resolved Hide resolved
@tpayet tpayet force-pushed the scrap-github-issues-for-search branch 3 times, most recently from fc0ad4c to 48c2673 Compare June 16, 2020 13:41
.github/workflows/gh-pages-scraping.yml Outdated Show resolved Hide resolved
@tpayet tpayet force-pushed the scrap-github-issues-for-search branch from 48c2673 to e92e34b Compare June 16, 2020 13:46
@tpayet
Copy link
Member Author

tpayet commented Jun 16, 2020

Are all the settings set up to this repo? 🙂

Yes, I just added them!

@tpayet tpayet marked this pull request as ready for review June 16, 2020 13:55
@tpayet tpayet force-pushed the scrap-github-issues-for-search branch from e92e34b to 598ea2f Compare June 16, 2020 13:56
@tpayet tpayet requested a review from curquiza June 16, 2020 16:43
Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

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

I approve but it should be a draft since we cannot merge it because of the issue I'm fixing right now.

Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

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

Hum, I realize I don't really like the display for the GitHub results:

Capture d’écran 2020-06-17 à 17 36 46

All the results are the same issue, except there are different comments. But the results do not bring new useful information: there are all the same information.

We use a distinctUrl on url field. It means if 2 results have the same url, it will only display the first one. But currently, all your URLs are unique because of the comments urls that look like this:
https://github.com/meilisearch/MeiliSearch/issues/655#issuecomment-636310981

I would like your github-issues-scraper to use url only for the PR or issue url (https://github.com/meilisearch/MeiliSearch/issues/655) and the anchor for the comment (issuecomment-636310981).

I will adapt the code in this PR (for the front part) once you fixed that, if you agree with me @tpayet .

@curquiza
Copy link
Member

Question

Are the closed PRs and issues added to MeiliSearch? 🙂

@bidoubiwa
Copy link
Contributor

Where are we with this PR ?

@fharper
Copy link
Contributor

fharper commented Dec 28, 2020

Any news about this PR?

@fharper
Copy link
Contributor

fharper commented Dec 28, 2020

I approve but it should be a draft since we cannot merge it because of the issue I'm fixing right now.

I changed the status to draft based on what you wrote @curquiza

@fharper fharper marked this pull request as draft December 28, 2020 19:47
@guimachiavelli guimachiavelli changed the title Add worklfows to use github-issues-scraper after docs-scraper on deploy Add workflows to use github-issues-scraper after docs-scraper on deploy Aug 18, 2021
@guimachiavelli
Copy link
Member

@meilisearch/docs-team has discussed this PR today and decided to close it. This is due to relevancy and usability reasons:

  1. As @curquiza's screenshot illustrates, results currently include repeated links of the same issue;
  2. We believe it can be confusing for the same search bar to possibly lead a user to two different locations (docs website and github issue) without any indication of what they're going to get once they click the search result;
  3. Although the issues add extra information, that information might be distracting rather than useful.

We are looking into a different solution for this problem which would involve taking the user to github issues only if no relevant results can be found on the docs.

@curquiza curquiza deleted the scrap-github-issues-for-search branch December 20, 2021 09:43
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 this pull request may close these issues.

6 participants