nuke/docs
Thomas Arrow 186ffeb744
docs: clarify botstopper kubernetes instructions (#1404)
This makes it clear that when generating a kubernetes secret to pull the bot stopper image that:
- no email is required
- a user is required but the actual value of the username is not checked
- the GH token needs to be pasted in

Signed-off-by: Thomas Arrow <tarrow@users.noreply.github.com>
2026-01-15 11:13:10 +00:00
..
blog fix: correct typos (#1398) 2026-01-12 01:23:58 +00:00
docs docs: clarify botstopper kubernetes instructions (#1404) 2026-01-15 11:13:10 +00:00
manifest fix: correct typos (#1398) 2026-01-12 01:23:58 +00:00
src docs: point get started button to the per-environment setup docs (#1213) 2025-10-24 19:19:29 +00:00
static chore: add Databento as diamond tier sponsor 2025-12-30 10:56:58 -05:00
.dockerignore chore(docs): add fly.toml file as a hail mary 2025-07-10 06:05:17 -04:00
.gitignore add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
Dockerfile fix(docs): use node:lts (#1274) 2025-11-14 03:14:00 +00:00
docusaurus.config.ts chore(docs): add link to status page in the footer (#814) 2025-07-12 13:32:24 -04:00
fly.toml chore(docs): add fly.toml file as a hail mary 2025-07-10 06:05:17 -04:00
package-lock.json test: basic nginx smoke test (#1365) 2025-12-28 23:18:25 +00:00
package.json test: basic nginx smoke test (#1365) 2025-12-28 23:18:25 +00:00
README.md add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
sidebars.ts add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
tsconfig.json add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00

Website

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

Installation

$ yarn

Local Development

$ yarn 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

$ yarn build

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

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.