Brick

How to share a Brick in Community?

To share a Brick in Constellab Community, follow these steps:

1. Ensure that you have downloaded the settings.json file of the Brick you want to share.
2. Open Community.
3. If you are not logged in, log in first.
4. Go to the Bricks List page.
5. Click on the ➕ create brick button. This will redirect you to the Brick creation page.
6. On the Brick creation page, click on the button to import the settings.json and import the Brick settings.json file.
7. If the Brick is not already shared in the Community, a form will appear.
8. Set the description of the Brick.
9. Set the Brick's visibility by choosing between Public or Private. (If Private, select a space to set the private visibility of the Brick.)
10. Provide the pip or git repository of your Brick. (If your Brick is not public, set the repository username and repository password.)
11. Click on the Save button.

Your Brick will be shared in the Community, and you will be redirected to your Brick page in Community.

How to share a new version of a Brick?

To share a new version of a Brick in Community, follow these steps:

1. Ensure that you have downloaded the settings.json file of the Brick you want to share, and that the Brick is already published in Community.
2. Open Community.
3. Go to the desired Brick page.
4. Click on the Version button to navigate to the versions list page of the Brick.
5. At the top of the list, click on the ➕ Add version button.
6. Import the settings.json file of the new version of the Brick.
7. Verify the information provided for the new version.
8. Click on the Save button to publish the new version of the Brick in Community.

How to write the documentation of a Brick?

To write the documentation of a Brick in Community, follow these steps:

1. Open Community.
2. Go to the desired Brick page.
3. To create the documentation tree, click on the ➕ button in the left panel to open the Create dialog.
4. To add a new documentation:Select Documentation.Enter the title of the documentation.You will be redirected to the created documentation page, where you can write the documentation using the Constellab text editor.
5. To add a folder in the documentation tree:Select Folder.Enter the title of the folder.You can add documentations and folders inside by:Using the ⋮ menu button of the folder in the documentation tree, then clicking on the Add button, orDragging and dropping documentations and folders inside the folder.

How to share the technical documentation of a Brick?

To share the technical documentation of a Brick in Community, follow these steps:

1. Open Community.
2. Go to the desired Brick page.
3. In the left panel, click on the ➕ button to add an element to the left panel.
4. In the Create dialog, select Technical Documentation.
5. Import the technical documentation file of the Brick.

The technical documentation will then be generated, and users will be able to consult it on your Brick page in Community.

How to change the icon of a Brick?

To change the icon of a Brick shared in Community, follow these steps:

1. Open Community.
2. Go to the desired Brick page of the Brick whose icon you want to change.
3. Ensure you are an author of the Brick, as only authors can see the edit button.
4. Click on the ✏️ edit button to open the edit panel of the Brick.
5. In the edit panel, click on the Brick logo.
6. Click on the upload brick picture button to open the file explorer.
7. Select the desired image for the Brick.
8. Confirm your selection by clicking on the Save button.

Your Brick icon is now changed.