Skip to main content

Style Guide

Introduction​

This document is the ultimate authority for the styles and conventions used in Superna's documentation.

Diagrams​

Diagrams in the documentation must be created with draw.io. The source of the draw.io diagram must be saved as a drawio.svg image in the same folder as the Markdown that references the diagram.

In this example, the draw.io diagram below is created in the docs/contributor_guide/style_guide folder, and included in this document.

Sample draw.io diagram

Multiple Platforms​

Whenever a section of documentation applies to multiple platforms or targets, use tabs to separate the content. For example, if we have a common operation that we want to perform, but there's differences for Powerscale, VAST, and Qumulo, we would structure the content like this:

In this current line, we have information or instructions which apply to all platforms. It is not included in the separated tabs.

Powerscale Text Goes Here

Syntax for Tabs​

<Tabs>
  <TabItem value="powerscale" label="Powerscale" default>
Powerscale Text Goes Here
   </TabItem>
  <TabItem value="VAST" label="VAST">
VAST Text Goes Here
   </TabItem>
  <TabItem value="qumulo" label="Qumulo">
Qumulo Text Goes Here
   </TabItem>
  <TabItem value="other" label="Other">
Other Text Goes Here
   </TabItem>
</Tabs>