How to Use the “How To” Guide#

Overview#

If you are new to the “How To” guides, start here first.

This page is an introduction to the “How To” guides. Read it to make sure you know how to read and interpret the How To guide pages.

The “How To” pages primarily deal with procedures within the Desktop App, not the CLI.

The CLI has comprehensive documentation that you can read in a terminal with the following command:

nvwb --help

The Desktop App does not contain documentation or have a “wizard” to help you go from step to step.

The “How To” pages are procedural and typically lack any conceptual explanation.

There are exceptions to this rule, the main ones being the high-level overview pages for each topic.

The specific reference how to pages are supposed to provide unambiguous steps to achieve an outcome or resolve an issue.

You can find more detailed explanation or motivation in the relevant reference pages.

We avoid using screenshots or GIFs unless absolutely necessary.

Screenshots and GIFS are not sufficient to explain procedures, so we use them sparingly.

Option dots: Vertical ellipses in the Desktop App that indicate options. Click to view options.
Breadcrumb notation: Compact way to denote sequence of actions. Example: `A > B` means “select A then select B”. Used in the How To guides.

We use breadcrumb notation to communicate UI steps compactly without being ambiguous.

We don’t distinguish verbs like “click” or “select” because things should be clear from context.

We use a fixed vocabulary of features and UI elements in the breadcrumbs.

Each term in that table (e.g. “Project Tab” and “Project Container”) is one you’ll see in breadcrumb notation.

From time to time, we may use top/middle/bottom and LHS/RHS to indicate where you can find a feature in a screen or window.

Top/middle/bottom mean the obvious things, and LHS/RHS mean left-hand-side and right-hand-side.

Examples of breadcrumb notation using the vocabulary and spacial directions:

`Project Tab > JupyterLab means “Go to the Project Tab then start JupyterLab”
`Project Container > Packages (RHS)` means “Go to the Project Container section then click Packages on the right-hand-side”
`Branch Short Cut (top LHS) > Create Branch` means “Go to the Branch Short Cut at the top left-hand-side of the Project Tab and then click the Create Branch button”

Working with Projects

Managing Environments and Containers

Working with Locations

Collaboration and Sharing

Connecting Integrations