sqlitecloud / docs

1 stars 0 forks source link

Build re-indexing of search into CI/CD process #1

Closed btholt closed 2 days ago

btholt commented 1 month ago

As of right now, our docs are not re-index every time we ship new documentation so every time a user searches, they're using an outdated index that doesn't match current documentation. We should rebuild the index every single time new markdown gets committed.

andinux commented 1 month ago

The current search engine has been manually updated with an updated database based on current documentation. To automatically rebuld the index on every commit to docs, we should configure the new nodes on AWS:

marcobambini commented 1 month ago

We need a GitHub action that can perform automatically the following steps after each commit:

  1. Compile docbuilder from https://github.com/sqlitecloud/tools/tree/main/docbuilder
  2. Execute docbuilder <input_docs_path> <output_db_path> where:
    • <input_docs_path> is the local path to docs directory, and
    • <output_db_path> is the full path to the output documentation.sqlite database to be created.
  3. Once the process completes the documentation.sqlite database must be UPLOADED WITH REPLACE into the doc-search cluster at https://dashboard.sqlitecloud.io/projects/cdrehk1lik/nodes
Gioee commented 1 week ago

@marcobambini @btholt @andinux can I close this issue? I think we're done with https://github.com/sqlitecloud/docsearch-action