submariner-io/submariner-website

Submariner-website is a Hugo-based static site generator for the Submariner project documentation.

The project solves the problem of maintaining and publishing technical documentation for Submariner by using Hugo with the Learn theme to generate a static website from Markdown source files. Content contributors can edit pages directly through GitHub's web interface or fork the repository to test changes locally before submission. The build system uses a Makefile to run a local development server that automatically reloads changes in the browser, with configurable binding options to allow remote access during development.

Anyone contributing to Submariner's documentation should use this repository. It suits teams that want a straightforward documentation workflow where contributors can work with plain Markdown files and see changes reflected immediately in a local preview. The setup is designed to be accessible to non-technical contributors through the GitHub edit interface while supporting more involved contributors who want to test changes locally before proposing them.

The project maintains an active contribution workflow with continuous integration verification of submitted changes. Development follows a standard GitHub pull request model where contributors fork the repository, make local changes, and submit their work for automated testing before merging.