Stacklok docs

This repository contains the public-facing docs for Stacklok's projects, hosted at https://docs.stacklok.com.

• Contributing to docs
  • Reporting issues
• Local development
• Formatting
• Building the site
• Deployment
• License
• 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 for help with voice, tone, and formatting.

Reporting issues

Found a problem with the documentation? We have issue templates to help you report it:

• Documentation error - Report incorrect, outdated, or unclear content
• Documentation gap - Request documentation for features that aren't covered
• Documentation enhancement - Suggest improvements to existing content

For general questions, please visit Stacklok's community Discord.

Local development

You'll need Node.js available (v24 recommended) or VS Code with the Dev Containers extension and Docker.

npm install
npm run start

This command starts a local development server on port 3000 and opens a browser window to http://localhost:3000. Most changes are reflected live without having to restart the server.

Formatting

We use Prettier and ESLint to normalize formatting and syntax. Before you submit a PR, please check for issues:

npm run prettier
npm run eslint

To automatically fix issues:

npm run prettier:fix
npm run eslint:fix

The formatting commands also run as a pre-commit hook using 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

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.

License

This repository is primarily documentation, so the default license is for content. Code is licensed separately:

• Documentation content (Markdown and MDX files under /docs and /blog, plus accompanying images and diagrams) is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
• Code (anything that compiles, runs, or configures the site - including .ts, .tsx, .js, .mjs, .css, and config files) is licensed under the Apache License 2.0. Most source files carry SPDX headers identifying this; a small number of top-level config files do not, and inherit the code license by virtue of being code.

This split follows the convention used by the Kubernetes website repository.

Stacklok trademarks, logos, and brand marks (including the contents of /static/img/logos/ and the Stacklok wordmark and icon used throughout the site) are excluded from both licenses and remain the property of Stacklok, Inc.

A small number of source files carry their own upstream license headers (for example, components adapted from the Docusaurus community knowledge base under CC BY-SA 4.0, theme components ejected from Docusaurus under MIT, and Font Awesome assets). In those files the file-level header is authoritative for that file.

About

This site is built with Docusaurus.