richardartoul/tigrisdb-docs

TigrisDB documentation project in Gitbook format

docs.tigrisdata.com

This website is built using Docusaurus 2, a modern static website generator.

Prerequisites

Node.js version >= 14 or above (which can be checked by running node -v).

Protobuffet

Install protoc. change for your OS as necessary

brew install protobuf

Install protoc-gen-doc. this depends on golang.

go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc

Installation

npm install

Local development

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Updating Proto documentation

tigrisdb-api is included as a submodule. After updating the submodule to pull in new proto changes, the documentation can be updated using the following steps:

protoc --doc_out=./fixtures --doc_opt=json,proto_workspace.json --proto_path=external/tigrisdb-api/ server/v1/api.proto
npx docusaurus generate-proto-docs

# Code Quality

1. Linting

The coding style rules are defined by Prettier and enforced by Eslint

2. Git Hooks

We use pre-commit to automatically setup and run git hooks.

On every git commit we check the code quality using prettier and eslint.