Skip to content
This repository has been archived by the owner on Oct 31, 2023. It is now read-only.

JupiterOne-Archives/docs-old

Repository files navigation

JupiterOne Documentation

Guides, docs, and release notes for JupiterOne platform and apps.

The docs are published to Zendesk at https://support.jupiterone.io/hc/en-us.

Tips for doc authors

Admonitions

The !!! syntax is supported to render admonition styling.

For example:

!!! warning
     Text for the warning message

image

Supported admonitions include warning, note, and reference.

Code Styling

Use three back ticks followed by the code language for a code block/snippet.

For example:

```j1ql
FIND User as u that IS Person as p
RETURN u.username, p.firstName, p.lastName, p.email
```

This ensures a code lang chip is added to the code block styling.

image

Line Breaks

Use an empty line between every body of text (e.g. between bullet lists, paragraphs, sections, etc.).

Use hard line breaks (at 80 chars per line) instead of relying on soft text wrapping to make the text earlier to read for PR reviews. Rewrap extension in VSCode makes this easy. Not so easy via the Github online editor, unfortunately.