Docs/new blueprints

README.md

@@ -21,9 +21,8 @@ When documenting your APIs, it's possible to perform changes and eval how they l
 
 For that, all you need to do is follow the instructions below:
 
-1. Point your API spec on the file `docusaurus.config.js` to your localhost: `http://localhost:3001/openapi.json`
-2. `npm dev` to run the docs portal locally
-3. `npm run swagger-ui:watch` to serve your api docs locally on your API project
-4. Finally to bypass CORS you will want to get this Chrome [extension](https://chrome.google.com/webstore/detail/moesif-origin-cors-change/digfbfaphojjndkpccljibejjbppifbc)
+1. `DOCS_URL=http://localhost:3001/ npm run dev` to run the docs portal locally
+2. `npm run swagger-ui:watch` to serve your api docs locally on your API project
+3. Finally to bypass CORS you will want to get this Chrome [extension](https://chrome.google.com/webstore/detail/moesif-origin-cors-change/digfbfaphojjndkpccljibejjbppifbc)
 
 When you are done, just deploy your `openapi.yml` as you normally would. And don't forget to update your client sdk [here](https://github.com/epilot-dev/sdk-js).

docs/blueprints/editing-and-synchronizing.md

@@ -0,0 +1,188 @@
+---
+sidebar_position: 3
+title: Editing and synchronizing
+hide_title: true
+---
+
+## Editing Blueprints 
+
+After installation or creation, Blueprints can be adjusted. All changes are applied directly within the Blueprint overview.
+
+---
+
+### Changing Blueprint name
+
+To change a Blueprint’s name, hover over it, click the pen icon, enter the new name, and confirm by clicking the checkmark icon.
+
+![Edit Blueprint name](/img/blueprints/3-edit-blueprint-name.png)
+
+---
+
+### Adding Resources
+
+- Click the **“Ressource hinzufügen”** button on the left.
+
+- Follow the procedure for adding a resource, the same as when creating a Blueprint.
+
+- For detailed instructions, see [Creating a Blueprint](/docs/blueprints/installing-a-blueprint#creation-of-custom-blueprint).
+
+
+![Resources toc](/img/blueprints/3-resources-toc.png)
+
+### Removing Resources
+
+- In the Blueprint overview, select the resources you want to remove.
+
+- Click **“Delete from this Blueprint”** to remove them.
+
+:::info
+
+Note: Resources removed from the Blueprint still exist in your organization. They are simply no longer a part of this Blueprint.
+
+:::
+
+![Remove resource](/img/blueprints/3-remove-resource.png)
+
+---
+
+### Actions
+
+Blueprints offer a set of actions that allow you to manage and share them efficiently. The available actions can be accessed from the **top-right navbar** of the Blueprint overview.
+
+![Actions](/img/blueprints/3-actions.png)
+
+---
+
+### Synchronize with another organization
+
+- Transfer the Blueprint and its resources to other organizations you are associated with.
+
+- For detailed instructions, see [Synchronizing Blueprints](#synchronizing-your-blueprint-with-another-org).
+
+---
+
+### Download
+
+- Download the Blueprint by selecting **Actions → Download** in the top-right navbar and confirming the operation.
+
+:::info
+
+Note: This function is only available for custom Blueprints, not for those installed from the Marketplace.
+
+:::
+
+![Download](/img/blueprints/3-blueprint-download.png)
+
+---
+
+### Delete
+
+- Remove the Blueprint by selecting Actions → Delete in the top-right navbar and confirming.
+
+:::info
+
+Note: Deleting a Blueprint does **not** delete the underlying resources in your organization. It only removes the grouping of those resources as part of the Blueprint.
+
+:::
+
+![Delete](/img/blueprints/3-blueprint-delete.png)
+
+---
+
+## Synchronizing your blueprint with another org
+
+When a Blueprint has been created or installed in your sandbox, you can synchronize it with other organizations you are associated with. Synchronization means transfering configuration elements (resources) —such as journeys, automations, products, workflows, and entity schemas—from one tenant to another.
+
+On the **Blueprints tab** all the Blueprints available in your organisation: both created and installed from a Marketplace, are listed in the “Blueprints” tab. The label in “Source” column will help you understand where each Blueprint is coming from.
+
+![Installed blueprints tab](/img/blueprints/3-installed-blueprints-tab.png)
+
+Clicking a table item opens a detailed view of the resources included in the Blueprint.
+
+This page also allows you to easily manage all the resources involved with your blueprint.
+
+![Installed blueprint page](/img/blueprints/3-installed-blueprint-page.png)
+
+As of now, those resources only exist on the current **sandbox organization**, but after you are happy with the configuration, you can easily “[sync](#synchronizing-your-blueprint-with-another-org)” this blueprint with another org (typically, the associated **production organization**).
+
+This will create a copy of this blueprint, together with the current state of each resource, and apply them on the selected destination org.
+
+---
+
+### The Synchronization Process
+
+The process will look similar to the [blueprint installation process](/docs/blueprints/installing-a-blueprint):
+
+Click on **“Actions → Synchronize”** on the top right corner.
+
+![Actions](/img/blueprints/3-actions.png)
+
+You will be directed to a screen that allows to select the destination org you wish to synchronize to, meaning - where do you wish to transfer your Blueprint to.
+
+![Switch org screen](/img/blueprints/3-switch-org-screen.png)
+
+Select your production org and click on “**Continue**”.
+
+![Switch org screen selector](/img/blueprints/3-switch-org-screen-selector.png)
+
+Now we will prepare the resources of your blueprint for synchronization.
+
+Depending on the amount of resources, this may take from 1~5 min, after which you can click on “**Continue to destination organization**”.
+
+![Continue to destination](/img/blueprints/3-continue-to-destination.png)
+
+---
+
+### Switching to the destination org
+
+You will be prompted to switch the **destination org** to finish the syncing process, just click continue and you will be redirected there.
+
+![Destination modal](/img/blueprints/3-destination-modal.png)
+
+---
+
+### Reviewing the resources impact
+
+
+Now on the destination org, you will be able to review the impact that this blueprint will have on the resources of this org, just like in the [blueprint installation process](/docs/blueprints/installing-a-blueprint).
+
+Just click on “See resources with their impact” to review it.
+
+
+You will see what will be created denoted by **New**, and if some of those resources are already present on the destination org (that will happen if it’s not the first time syncing the blueprint), you will see either **No changes**,  “**Update**" or “**Delete**".
+
+![Resources impact](/img/blueprints/3-resources-impact.png)
+
+If everything is as expect you can now click on “Synchronize Blueprint” to finish the process.
+
+
+---
+
+And that’s it! 
+You will be presented with the success page of the synchronization process, which will give you a link to see the instance of your blueprint in this destination org!
+
+![Sync complete screen](/img/blueprints/3-sync-complete-screen.png)
+
+You successfully synchronized your sandbox blueprint to your production org!
+
+---
+
+### Further editing the blueprint
+
+Now you are able to edit and manage your Blueprint, for more details [click here](#editing-blueprints).
+
+After that, if you need, you can sync those changes back to the sandbox.
+
+For that, just repeat this process, but this time, starting from the blueprint overview page of the destination org.
+
+:::info
+
+We recommend experimenting with changes in the Sandbox and syncing to Production only when you are satisfied with the setup.
+
+:::
+
+
+![Installed blueprint page](/img/blueprints/3-installed-blueprint-page.png)
+
+
+That also counts for the blueprint back in the sandbox: you can go back and continue to make changes and experiment by adding, removing or editing resources. Those changes will only be present on your sandbox until you click on “**Actions → Synchronize**” again.

docs/blueprints/installing-a-blueprint.md

@@ -4,36 +4,137 @@ title: Installing a Blueprint
 hide_title: true
 ---
 
-## Installing a Blueprint
+
+
+## Installation from Marketplace
 
 :::info
 
 Blueprints are currently in closed **BETA** only available to selected customers.
 
 :::
 
-To manage and install Blueprints, navigate to the [Configuration > Blueprints](https://portal.epilot.cloud/app/blueprints) in the epilot portal.
+To install a blueprint from the Marketplace navigate to [Configuration → Blueprints → Marketplace tab](https://portal.epilot.cloud/app/blueprints).
+
+Here you can search and discover blueprints tailored for common use cases, based on our experience in the energy market.
+
+After finding the one that fits your business, click on “Install now”.
+
+:::info
+
+Installation of a Marketplace Blueprint is possible only in a Sandbox testing environment. If you don’t have a sandbox yet, check the [Sandbox documentation](/docs/blueprints/intro#sandbox).
+
+:::
+
+
+![Portal Marketplace Page](/img/blueprints/2-portal-marketplace.png)
+
+
+You have two options of installation:
+
+- [One-click Install](/docs/blueprints/installing-a-blueprint#one-click-install)
+- [Advanced Install](/docs/blueprints/installing-a-blueprint#advanced-install)
+
+![Step 2](/img/blueprints/2-one-click-installation.png)
+
+---
+
+### One-click install
+
+After choosing “One-click install” the installation process will start automatically.
+
+Depending on the number of resources included in the chosen blueprint the installation may take up to 5 min.
+
+![Step 3](/img/blueprints/2-one-click-step-3.png)
+
+And that’s it! You successufuly installed a blueprint from the marketplace. Check out [Post-Installation Configuration](#post-installation-configuration) on how to configure the installed resources.
 
-![Blueprints](/img/blueprints/installed-blueprints.png)
 
-To install a new Blueprint, click on "Install Blueprint" and choose the source for your Blueprint.
+Next, you can [edit it](/docs/blueprints/editing-and-synchronizing#editing-blueprints), or [synchronize with another organization](/docs/blueprints/editing-and-synchronizing#synchronize-with-another-organization)  — click on the relevant sections links for more details.
+
+![Installation Complete](/img/blueprints/2-one-click-complete.png)
+
+---
+
+### Advanced install
 
-1. If you already have a Blueprint zip file, you can choose *Upload File*
-1. Choose "Marketplace" to pick a Blueprint from the [epilot Marketplace](https://marketplace.epilot.cloud).
-1. Or if you wish to copy resources from another epilot organization, you can choose *"Sandbox"*.
+If “Advanced Install” is chosen, you will have a fine control on which resources from a blueprint should be installed.
 
-![Install Blueprint](/img/blueprints/install-blueprint.png)
+To remove a resource, uncheck an item and click on “Update installation”.
+
+
+![Pick resources](/img/blueprints/2-advanced-pick-resources.png)
+
+When done selecting resources, click on “Install resources” to continue, the installation will proceed automatically from here.
+
+And that’s it! You successufuly installed a blueprint from the marketplace. Check out [Post-Installation Configuration](#post-installation-configuration) on how to configure the installed resources.
+
+Next, you can [edit it](/docs/blueprints/editing-and-synchronizing#editing-blueprints), or [synchronize with another organization](/docs/blueprints/editing-and-synchronizing#synchronize-with-another-organization)  — click on the relevant sections links for more details.
+
+![Installation Complete](/img/blueprints/2-advanced-complete.png)
+
+---
 
-After picking a blueprint from your source, epilot will show a preview (plan) of what will get added or changed in your organization as part of the Blueprint. 
+## Post-Installation Configuration
 
-**Note that at this point, no changes will be made to your organization and you can still review the Blueprint before installing it!**
+After a Blueprint is installed, some resources may still require additional setup before they can be fully used. In the list view, these resources appear with the **“Ready to use” toggle switched off**. You can also filter the list to quickly see which items are not yet marked as ready.
 
-After you have reviewed the changes, click on *Import Resources* to start the Blueprint installation.
+- In the list view, click the link next to the toggle to open a resource in a new tab.
 
-![View Plan Step](/img/blueprints/view-plan.png)
+- Define and save any changes needed for the resource.
 
-The installation will take up to a few minutes to complete. 
+- Return to the Blueprint overview and toggle the resource as ready to use.
 
-After the installation is complete, you will see a list of all the resources that were installed, and can click on each one to view the details and edit the configuration.
+- Marking a resource as ready is optional and is meant to help you keep track of configuration progress.
 
-We recommend that you test the Blueprint in a sandbox environment before installing it in your production organization.
+
+![Resource toggle](/img/blueprints/2-resource-toggle.png)
+
+
+---
+
+## Creation of Custom Blueprint
+
+Besides installing a blueprint from marketplace, you are also able to create your own Blueprints.
+
+With **Custom Blueprints** you can combine available resources to create your own Blueprint. With that you are able to:
+
+- Organize use-cases
+
+- Test combination of resoures on a sandbox
+
+- Share your use-case with other orgs
+
+---
+
+To create a **Custom Blueprint**, go to Configuration → Blueprints and select the tab “Blueprints”.
+
+On the bottom you will see “Create Blueprint”, click on it to start the creation process.
+
+You will be presented with a screen that allows you to select Resources to include in your Custom Blueprint.
+
+Click on “Add resources” to continue.
+
+
+![Create blueprint](/img/blueprints/2-create-blueprint.png)
+
+
+You will be presented with a list of categories of resources, select one to continue.
+
+After, select the specific resources on that category you wish to include, here we are adding a single Product.
+
+:::info
+
+Note: A resource will be added together with any other resources linked to it.
+
+:::
+
+
+![Add resources](/img/blueprints/2-add-resource-side-panel.png)
+
+
+That’s it! You successfully created your own Blueprint! 
+
+You will be redirected to the resources view of this blueprint in there you are able to further edit it, [see more](/docs/blueprints/editing-and-synchronizing#editing-blueprints).
+
+---