Ook

Ook is the librarian indexing the Vera C. Rubin Observatory's technical documentation. Ook's primary deployment is on the Roundtable platform. It retrieves triggers from documentation builds, GitHub Actions, and other sources through both Kafka (SQuaRE Events) and an HTTP API. Ook indexes that content and saves records to an Algolia database, which is used to power the Rubin Observatory technical documentation website, www.lsst.io.

Links

Phalanx Env. Argo CD	API URL	API Docs
roundtable-prod	https://roundtable.lsst.cloud/ook	Swagger · Redoc · AsyncAPI
roundtable-dev	https://roundtable-dev.lsst.cloud/ook	Swagger · Redoc · AsyncAPI

Documentation and related reading

• ook.lsst.io — Documentation site.
• SQR-086 — Deep linking to data documentation with IVOA DataLink
• SQR-090 — System for collecting user feedback in Rubin documentation

Development

Ook is developed with SQuaRE's Safir framework for FastAPI apps.

Environment set up

nox -s init-dev

Or if in an existing Python virtual environment:

nox -s init

Testing and linking nox sessions

nox -s test
nox -s typing
nox -s lint

Running the app

nox -s run

See square.env for using 1Password credentials for local development.

Database migrations

See alembic/README.md for instructions on how to create and apply database migrations.

Preparing release notes

Create a changelog fragment in the changelog.d directory.

nox -s scriv-create

To collect fragments into the CHANGELOG.md file for a release, run:

nox -s scriv-collect -- X.Y.Z