-
Notifications
You must be signed in to change notification settings - Fork 22
Developer Glossary Terminology
Over the history of the project, we've been iterating on the internal and external terminology. Therefore, when working on the code, you may see certain concepts referred to in different ways
External documentation of key concepts: https://docs.pixiebrix.com/developer-guide/key-concepts
For formal definitions of the types, see the code:
- http://github.com/pixiebrix/pixiebrix-extension/blob/a19089dec7d2d49886c6d6a24a30f12c21c33340/src/core.ts#L25-L25
- http://github.com/pixiebrix/pixiebrix-extension/blob/a19089dec7d2d49886c6d6a24a30f12c21c33340/src/types.ts#L41-L41
- Avoid mixing terminology within the same module
- In some places, we'll need to update the backend API to use the new terminology
A place where one or more things can be attached on a page. Current kinds of extension points: 1) panels, 2) menu items/buttons, 3) triggers, 4) context menus, 5) sidebar action panel
- UI: Foundation
- Code: Extension Point
The thing (e.g., button, panel) attached to the foundation/extension point
- UI: Brick
- Code: Extension
A unit of computation — has an inputSchema
and a run
method
- Code: Block
- UI: Brick
Also may be called a reader, transform, effect, or renderer depending on what the interface and the context of how its used
A definition of service, including what configuration properties to expose, and how to authenticate calls to the service using those properties.
- UI: Integration
- Code: Service
A configuration of a Service/Integration
- UI: Blueprint/Template
- Code: Old: recipe → New: blueprint
A "Deployment" is a pre-configured blueprint to deliver to users. Consists of: 1) a blueprint version, and 2) the service configuration to use for each service