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 orama-db generator #65

Open
AugustinMauroy opened this issue Aug 8, 2024 · 9 comments
Open

add orama-db generator #65

AugustinMauroy opened this issue Aug 8, 2024 · 9 comments

Comments

@AugustinMauroy
Copy link
Member

We need to generate a local Orama db. To accomplish that we will you the open source part of Orama. On nodejs.org we use orama cloud to build our search bar.

To build that, there are some step:

And on further step we will be able to use the generated db in the docs app.

@ovflowd
Copy link
Member

ovflowd commented Nov 18, 2024

🤔 -- I just wonder if this should actually fall under the api-docs-tooling.

@AugustinMauroy
Copy link
Member Author

🤔 Claudio go to sleep or idk but we are in api-docs-tooling 😁

@ovflowd
Copy link
Member

ovflowd commented Nov 18, 2024

🤔 Claudio go to sleep or idk but we are in api-docs-tooling 😁

?? -- Im questioning if this should be here. Because Orama isn't related to API docs but to the Node.js Website, this isn't the place for generating the Orama Database. (Although I acknowledge the part of the database indexes our API docs endpoints)

@AugustinMauroy
Copy link
Member Author

IDK where but you ask for this issue

@ovflowd
Copy link
Member

ovflowd commented Nov 18, 2024

I don't recall that?

@AugustinMauroy
Copy link
Member Author

AugustinMauroy commented Nov 18, 2024

#55 (comment)

@bmuenzenmeyer
Copy link
Collaborator

it's fine - we all have the capacity to change our minds, especially as implementation starts revealing new information.

on it's surface, I agree that orama is very specific to the website. can we de-prioritize this for now? we can always pick it back up later

@ovflowd
Copy link
Member

ovflowd commented Nov 18, 2024

I synced offline with @AugustinMauroy and I recall now why this was required -- We need to integrate Orama also on the API docs react generator, so we will need local generated databases as we cannot use Orama Cloud here I think.

@ovflowd
Copy link
Member

ovflowd commented Nov 18, 2024

We could have a GitHub Action for Prod deployments to use a cloud database, but all local builds should be able to generate local databases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants