Equinor AppSec public site

This repo contains the documentation and setup for hosting https://equinor.github.io/appsec/

Development

Prerequisites

This project uses uv for dependency management. If you don't have uv installed, follow the official installation guides.

This project uses the Python version as specified in the .python-version file. When you run uv sync, it will automatically detect and use the correct Python version. The same yields for the workflows and Codespace setup.

Setup

Install the dependencies using

uv sync

To start the project, simply run:

uv run mkdocs serve

and the server will start on localhost:8000.

Alternatively, you can activate the virtual environment and run mkdocs directly:

source .venv/bin/activate  # On Windows: .venv\Scripts\activate
mkdocs serve

Adding content

To add content add markdown inside the docs folder, and link it from the rest of the site.

Runbook

A runbook of how the site is deployed and maintained can be found in Runbook.

How to contribute

Read our contribute.md