search

suborbital / docs

Documentation monorepo for Suborbital projects and products
https://docs.suborbital.dev
Apache License 2.0
8 stars 5 forks source link

Laura/78 add algolia search support 1 #120

Closed LauraLangdon closed 2 years ago

LauraLangdon commented 2 years ago

Referred to env vars for DocSearch secrets.

arbourd commented 2 years ago

It seems that the build step is failing due to:

Error:  ValidationError: "algolia.apiKey" is required

This is probably because the env var is null or "", which makes sense because we haven't provided it in this PR.

119 would need to be merged first but you can combine them into one PR here which would test the whole flow.

LauraLangdon commented 2 years ago

It seems that the build step is failing due to:

Error:  ValidationError: "algolia.apiKey" is required

This is probably because the env var is null or "", which makes sense because we haven't provided it in this PR.

119 would need to be merged first but you can combine them into one PR here which would test the whole flow.

I've searched up "combine pull requests" but I'm mostly finding GitHub actions to do this. Is there a specific way you had in mind?

LauraLangdon commented 2 years ago

Woohoo, the connection is made! Obligatory Elastica (why doesn't YouTube have an embed option for GitHub? 😛).

I'll work on setting up a crawl on Monday.

LauraLangdon commented 2 years ago

The tests all passed on Friday but failed today, so something's buggy. Maybe related: I'm now getting [ERROR] ValidationError: "algolia.apiKey" is required when I run npm start on the branch I've been working on this in, despite having set up the secrets in GitHub for for the API key and the appID. 🤔

LauraLangdon commented 2 years ago

There is that pesky package-lock.json again! You will need to remove those changes from the PR.

Oops! Will do.

Also let's move the link checker to its own PR.

The PR for the link checker is already merged; I'm not sure how it ended up here.

I have updated the docs to use the latest Docusaurus Beta 18 to make sure the crawler on the public site gets everything right. Because of this you will need to rebase the branch on main (and will probably see conflicts due to package-lock.json, you should be able to discard your local changes and go with the file on main).

Great! I'll give that a go.

I had to tweak the crawler configuration from the original to have it correctly pick up the headings, it's still not perfect but much better, and we should spend some thought on #64 and generally on tweaking the docs structure in the coming weeks.

I'll check that out!

image The search in the preview now works as expected so let's get this merged!

Woohoo!

flaki commented 2 years ago

Closing in favor of #126