https://github.com/stacklok/docs-website
Stacklok user documentation website
https://github.com/stacklok/docs-website
Last synced: 8 months ago
JSON representation
Stacklok user documentation website
- Host: GitHub
- URL: https://github.com/stacklok/docs-website
- Owner: stacklok
- License: apache-2.0
- Created: 2025-06-05T21:17:48.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-06-06T19:42:59.000Z (8 months ago)
- Last Synced: 2025-06-06T20:25:00.762Z (8 months ago)
- Language: CSS
- Homepage: https://docs.stacklok.com
- Size: 3.43 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stacklok docs
[](https://github.com/stacklok/docs-website/deployments/Production)
This repository contains the public-facing docs for Stacklok's projects, hosted
at [https://docs.stacklok.com](https://docs.stacklok.com).
- [Contributing to docs](#contributing-to-docs)
- [Local development](#local-development)
- [Formatting](#formatting)
- [Building the site](#building-the-site)
- [Deployment](#deployment)
- [About](#about)
## Contributing to docs
We welcome contributions to the Stacklok documentation - if you find something
missing, wrong, or unclear, please let us know via an issue or open a PR!
Please review the [style guide](./STYLE-GUIDE.md) for help with voice, tone, and
formatting.
## Local development
You'll need Node.js available (v22 recommended) or VS Code with the
[Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
extension and Docker.
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/stacklok/docs-website)
```bash
npm install
npm run start
```
This command starts a local development server on port 3000 and opens a browser
window to . Most changes are reflected live without
having to restart the server.
## Formatting
We use a combination of Prettier, markdownlint, and ESLint to normalize
formatting and syntax. Before you submit a PR, please check for issues:
```bash
npm run prettier
npm run markdownlint
npm run eslint
```
To automatically fix issues:
```bash
npm run prettier:fix
npm run markdownlint:fix
npm run eslint:fix
```
The formatting commands also run as a pre-commit hook using
[Husky](https://typicode.github.io/husky/), so commits will fail if there are
formatting issues that can't be fixed automatically. You can skip this by using
`git commit --no-verify`, but it's recommended to fix the issues instead since
the P workflow will fail the checks anyway.
## Building the site
```bash
npm run build
```
This command generates static content into the `build` directory. It also checks
for broken links, so it's recommended to run this before submitting a PR.
## Deployment
The `docs.stacklok.com` site is published using Vercel. Automatic previews for
branches and pull requests are enabled. The production site is published from
the `main` branch.
## About
This site is built with [Docusaurus](https://docusaurus.io/).