Usethis: Search is partially broken

[jennybc]

The usethis site has search now 🎉 but some searches lead to bad URLs that 404.

https://usethis.r-lib.org

Successful search terms: "create", "credentials".
Unsuccessful search terms: "https", "ssh", "git2r", "continuous".

The unsuccessful terms produce a promising dropdown menu, but all of the associated links are broken in this sort of way:

https://usethis.r-lib.org/reference/undefined?q=continuous#section-continuous-integration
https://usethis.r-lib.org/reference/undefined?q=ssh#value
https://usethis.r-lib.org/reference/undefined?q=git2r#arguments

I cannot break the dplyr search in the same way. I note that dplyr's site uses tidytemplate. Is that somehow the favourable difference?

[jennybc]

Probably related to

https://github.com/tidyverse/dplyr/issues/4151

https://github.com/algolia/docsearch-configs/commit/cc56f8b7885ca46a37a719419d964c7d92a3ba26

[jayhesselberth]

Your config needs to match the tidyverse config. In particular, you are missing this section:

  "custom_settings": {
    "separatorsToIndex": "_",
    "attributesToRetrieve": [
      "hierarchy",
      "content",
      "anchor",
      "url",
      "url_without_anchor"
    ]
  },

Where did you get your config? Was it auto-generated?

[jennybc]

Yeah that just "happened".

[jayhesselberth]

You mean pkgdown generated the docsearch config? If so, we should update the default.

[jennybc]

We got algolia turned on in August 2018 (as the creation date of their config suggests), but then I didn't do anything about it until just now. So perhaps the config they would generate now would be correct? But in any case, I think I need to ask them to update it to match what you've got above.

[jennybc]

You mean pkgdown generated the docsearch config? If so, we should update the default.

I have no idea who made it. I assume they do?

[jayhesselberth]

Ah, yes @s-pace can help you out.

[jennybc]

Algolia config for usethis:

https://github.com/algolia/docsearch-configs/blob/master/configs/usethis.json

[jayhesselberth]

pkgdown auto-gernerates one for you. Yours is here:

https://usethis.r-lib.org/docsearch.json

[jennybc]

So I want algolia to update their config to match the auto-generated one within usethis's site?

Or I can take matters into my own hands and fix this myself?

[jayhesselberth]

Yes Algolia needs to update their config to the auto-generated one.

You could also submit a PR to the dosearch-config repo but usually @s-pace just makes this happen.

[jennybc]

I made a PR with the auto-generated config, in case it saves @s-pace some work.

[s-pace]

👋

@jennybc Thank you for the PR 🙏

It should solves this issue. I let you integrate the suggestions an I will merge it ASAP.

[jennybc]

Fixed via https://github.com/algolia/docsearch-configs/pull/818