Docs Style Guide

Documentation Style Guide

This guide is meant to help keep our documentation consistent and ease the contribution and review process.

Submariner follows the Kubernetes Documentation Style Guide wherever relevant. This is a Submariner-specific extension of those practices.

Submariner.io word list

A list of Submariner-specific terms and words to be used consistently across the site.

Term Usage
Submariner The project name Submariner should always be capitalized.
Admiral The project name Admiral should always be capitalized.
Lighthouse The project name Lighthouse should always be capitalized.
Coastguard The project name Coastguard should always be capitalized.
Shipyard The project name Shipyard should always be capitalized.
subctl The artifact subctl should not be capitalized and should be formatted in code style.