🛠ī¸

Workshop Basics

Accessing the Workshop

ℹī¸

To use the workshop, your account needs a "Developer" of "Admin" role within your organization

To access the workshop, click Workshop from the sidebar in the extension:

image

The Workshop Page list all the bricks you have edit access to:

image

Creating a new Local Extension

To create a new extension for you to use locally, select the extension point from the "Install a brick" drop down.

image

To create an extension that your team members can install from your organization's marketplace, instead click "Create new brick" and use the editor to define a brick of kind: recipe

Defining a new Brick or Blueprint

To define a new brick, click the "Create New Brick" button:

image

To start with an example, select an example from the "Load a template" dropdown at the bottom of the YAML editor on the Create New Brick page

image

To learn the basics of configuration files, see the following resources:

Brick Metadata Directive

The Metadata directive uniquely identifies your brick:

metadata:
  # unique id for the brick, will be used in other bricks to reference this brick
  id: "@alias/collection/brick-id"
  
  # semantic version: https://semver.org
  version: 0.0.1
  
  # friendly name and description
  name: LinkedIn Profile Menu Item
  description: Add a menu item to the More... dropdown

Sharing a brick with your organization

To share a brick with your organization, you have two options:

  • Use your organization's alias in the brick id, e.g., @pixiebrix/rest-of-id
  • Use your personal account alias and toggle your organization from the sharing tab when editing the brick in the Workshop, e.g., @todd/rest-of-id