edobusy
fd4edb7227
The translated READMEs in docs/translations/ link to the Kubernetes installation guide with a path copied from the root README (./charts/helm/checkmate/INSTALLATION.md). Because these files live two levels below the repo root, that path resolves to docs/translations/charts/..., which does not exist, so the link is broken in all 17 translations. Fix the path to ../../charts/helm/checkmate/INSTALLATION.md so it resolves to the repo-root charts/ directory. The root README.md is correct as-is and is left unchanged.
Checkmate Documentation
Welcome to the Checkmate documentation. This directory contains guides and references for various aspects of Checkmate deployment and configuration.
Available Documentation
Deployment & Configuration
- Custom CA Trust Guide - Configure Checkmate to trust custom Certificate Authorities
- Custom CA Quick Reference - Quick setup guide for custom CA trust
Docker Configuration
Custom CA Trust
If you need to monitor internal HTTPS endpoints with certificates from private Certificate Authorities (like Smallstep), see our custom CA trust documentation:
- Full Guide: Custom CA Trust Guide
- Quick Reference: Custom CA Quick Reference
Example Configurations
The docker/dev/ directory contains example configurations:
docker-compose.custom-ca-example.yaml- Example Docker Compose with custom CA
Contributing to Documentation
If you find issues or want to improve the documentation:
- Check existing issues and discussions
- Submit a pull request with your changes
- Follow the same markdown formatting style
- Include practical examples and code snippets