Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

click search result, go to docs/3.0.0 #475

Closed
aladdin-add opened this issue May 10, 2018 · 9 comments
Closed

click search result, go to docs/3.0.0 #475

aladdin-add opened this issue May 10, 2018 · 9 comments
Labels
bug The site is working incorrectly

Comments

@aladdin-add
Copy link
Member

it is expected to open the latest version.

image

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label May 10, 2018
@aladdin-add aladdin-add added bug The site is working incorrectly and removed triage An ESLint team member will look at this issue soon labels May 10, 2018
@ilyavolodin
Copy link
Member

Yes, I noticed that too. It has something to do with this line: 6d951fd#diff-7693eb643e8fe8b8d46b407909b408ceR31 but I haven't had a chance to dig into DocSearch documentation yet to figure out how to correct it.

@Krinkle
Copy link

Krinkle commented Jun 6, 2018

This is actively causing 404 Not Found errors for users, making it rather difficult to find things.

Example: search for "for-direction" on https://eslint.org/.

Search Result 404
screen shot of search query screen shot screen shot of 404 page with url

This claims to be the 3.0.0 rules page, but links to for-direction which was introduced in ESLint 4.

@platinumazure
Copy link
Member

platinumazure commented Jun 6, 2018

I'm looking into this. I think I understand the issue, though I need to confirm a few things before I try to make any changes.

We'll also need to document necessary changes to docsearch configs (in https://github.com/algolia/docsearch-configs) as part of major releases. That will go in the maintainer guide.

Edit: On second thought, if we just don't index documentation from old versions of ESLint, then we wouldn't need to change the major release process. I'm not convinced we need to index old ESLint documentation at this point.

@platinumazure
Copy link
Member

platinumazure commented Jun 6, 2018

I think I have the beginning of a fix lined up:

In the Docsearch PR, I can't start from /docs because that page does not exist in the repo. So I'm starting from /docs/rules, /docs/user-guide, /docs/developer-guide, and /docs/maintainer-guide (all of which should exist). There might be other improvements we could make, but that PR (or something similar) should help fix most of the issues.

s-pace pushed a commit to platinumazure/docsearch-configs that referenced this issue Jun 7, 2018
s-pace referenced this issue in algolia/docsearch-configs Jun 7, 2018
s-pace pushed a commit to algolia/docsearch-configs that referenced this issue Jun 14, 2018
s-pace pushed a commit to algolia/docsearch-configs that referenced this issue Jun 14, 2018
@platinumazure
Copy link
Member

platinumazure commented Jun 14, 2018

We've merged the docsearch-configs change and the eslint.github.io change. Unfortunately I didn't think about the fact that the scraper probably hasn't run yet so we have the eslint.github.io changes running against the old index. It will resolve itself after the next scraper run (within 24 hours).

I'll check tomorrow to see how the search experience looks, then either close this issue or open new PRs against this issue as needed.

Apologies for any inconvenience as we're rebuilding our search config.

@platinumazure
Copy link
Member

I just checked and things are actually looking consistent-- maybe the index was built after the docsearch-configs changes were merged.

@aladdin-add @Krinkle How does it look on your end?

@Krinkle
Copy link

Krinkle commented Jun 14, 2018

@platinumazure Yep, the search seems to be working well again. Thanks!

I do note that https://eslint.org/docs/3.0.0/rules/ still lists for-direction in the table, linking to a 404 Not Found. I've filed #486 for that.

@platinumazure
Copy link
Member

Thanks for confirming @Krinkle.

I'm going to leave this open for a few days in case I want to make any more PRs to tweak the search configuration.

@platinumazure
Copy link
Member

I wrote algolia/docsearch-configs#457 to avoid indexing of blog headers, since those are identical in every post.

Closing as the main issue is resolved.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug The site is working incorrectly
Projects
None yet
Development

No branches or pull requests

4 participants