Update builder docs + remove legacy docs

This commit is contained in:
Mike Solomon
2024-10-11 09:08:56 -07:00
parent 8cbbe39b4f
commit 568b601763
8 changed files with 16 additions and 86 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

View File

@@ -27,7 +27,6 @@
* [How to upgrade transitive dependencies](user-documentation/moderne-platform/how-to-guides/transitive-dependencies.md) * [How to upgrade transitive dependencies](user-documentation/moderne-platform/how-to-guides/transitive-dependencies.md)
* [How to find method invocations based on a pattern using AI](user-documentation/moderne-platform/how-to-guides/how-to-find-method-invocations-based-on-a-pattern.md) * [How to find method invocations based on a pattern using AI](user-documentation/moderne-platform/how-to-guides/how-to-find-method-invocations-based-on-a-pattern.md)
* [How to gain a high-level overview of your codebase using AI clustering](user-documentation/moderne-platform/how-to-guides/how-to-gain-a-high-level-overview-of-your-codebase-using-clustering.md) * [How to gain a high-level overview of your codebase using AI clustering](user-documentation/moderne-platform/how-to-guides/how-to-gain-a-high-level-overview-of-your-codebase-using-clustering.md)
* [(Legacy) Create custom recipes with the old recipe builder](user-documentation/moderne-platform/how-to-guides/recipe-builder.md)
* [References](user-documentation/moderne-platform/references/README.md) * [References](user-documentation/moderne-platform/references/README.md)
* [Moderne tokens](user-documentation/moderne-platform/references/moderne-tokens.md) * [Moderne tokens](user-documentation/moderne-platform/references/moderne-tokens.md)
* [Creating SCM access tokens](user-documentation/moderne-platform/references/create-scm-access-tokens.md) * [Creating SCM access tokens](user-documentation/moderne-platform/references/create-scm-access-tokens.md)

View File

@@ -13,4 +13,3 @@
* [How to upgrade transitive dependencies](transitive-dependencies.md) * [How to upgrade transitive dependencies](transitive-dependencies.md)
* [How to find method invocations based on a pattern](how-to-find-method-invocations-based-on-a-pattern.md) * [How to find method invocations based on a pattern](how-to-find-method-invocations-based-on-a-pattern.md)
* [How to gain a high-level overview of your code using clustering](how-to-gain-a-high-level-overview-of-your-codebase-using-clustering.md) * [How to gain a high-level overview of your code using clustering](how-to-gain-a-high-level-overview-of-your-codebase-using-clustering.md)
* [(Legacy) Create custom recipes with the old recipe builder](recipe-builder.md)

View File

@@ -4,13 +4,13 @@ Have you found a recipe in Moderne where you only want to run certain parts of i
All of these problems can be solved by utilizing the new Recipe Builder, which provides a way for you to create custom recipes from our existing recipe catalog. All of these problems can be solved by utilizing the new Recipe Builder, which provides a way for you to create custom recipes from our existing recipe catalog.
## How to create a custom recipe ## How to create a custom recipe in the builder
To create a custom recipe you will need to: To create a custom recipe you will need to:
1. Click on the `Builder v2` link: 1. Click on the `Builder` link to be taken to the recipe builder.
![Builder v2 link](/.gitbook/assets/builder-v2-link.png) ![Builder link](/.gitbook/assets/builder-link.png)
2. Create a recipe by either clicking on the `New recipe...` link in the welcome modal or by clicking on the `Recipe` button in the top-left corner and then pressing `New`: 2. Create a recipe by either clicking on the `New recipe...` link in the welcome modal or by clicking on the `Recipe` button in the top-left corner and then pressing `New`:
@@ -36,12 +36,24 @@ To create a custom recipe you will need to:
7. After you select a recipe, the 3D recipe viewer and recipe list side panel will be updated to include that recipe and all of its sub-recipes. Feel free to add more recipes or edit the ones you've included. For more detailed instructions in how to use the 3D recipe viewer or the recipe list panel, [jump down in this doc](#how-to-use-the-3d-viewer). 7. After you select a recipe, the 3D recipe viewer and recipe list side panel will be updated to include that recipe and all of its sub-recipes. Feel free to add more recipes or edit the ones you've included. For more detailed instructions in how to use the 3D recipe viewer or the recipe list panel, [jump down in this doc](#how-to-use-the-3d-viewer).
8. Once you've got your recipe into the place you want it, you can run it by pressing the `Dry Run` button at the top of your screen: 8. Once you've got your recipe into the place you want it, you can run it by pressing the `Dry Run` button at the top of your screen:
![Dry run button](/.gitbook/assets/recipe-dry-run.png) ![Dry run button](/.gitbook/assets/recipe-dry-run.png)
9. Victory! 9. Victory!
## How to create or add recipes from the marketplace
From any recipe in the marketplace, you can click on the `Add to builder` button:
![Add to builder button](/.gitbook/assets/add-to-builder-button.png)
A modal will then pop up that either allows you to create a new recipe or add this recipe to one you've already created.
![Add to builder modal](/.gitbook/assets/add-to-builder-modal.png)
Click on the `Add to new recipe` or `Add to selected recipe` button to continue.
## How to save and share custom recipes ## How to save and share custom recipes
When you're ready to save or share your custom recipe with others, you can do so by clicking on the `Recipe` button in the top-left corner and selecting either `Download YAML` or `Copy as YAML to clipboard`: When you're ready to save or share your custom recipe with others, you can do so by clicking on the `Recipe` button in the top-left corner and selecting either `Download YAML` or `Copy as YAML to clipboard`:

View File

@@ -1,80 +0,0 @@
# (Legacy) Create custom recipes with the old recipe builder
Have you found a recipe in Moderne where you only want to run certain parts of it? Or have you found a few recipes that you want to combine into one larger recipe? Or maybe you want to run a bunch of recipes in a specific order?
All of these problems can be solved by utilizing the Recipe Builder, which provides a way for you to create custom recipes from our existing recipe catalog.
To help you get acquainted with the Recipe Builder, in this guide, you will learn:
* [How to create a custom recipe](recipe-builder.md#how-to-create-a-custom-recipe)
* [How to save and share custom recipes](recipe-builder.md#how-to-save-and-share-custom-recipes)
* [How to import and run custom recipes](recipe-builder.md#how-to-import-and-run-custom-recipes)
{% embed url="https://www.youtube.com/watch?v=RM4Ar0UnvNw" %}
## How to create a custom recipe
To create a custom recipe you will need to:
1. [Find the recipes you want to utilize in your custom recipe](/user-documentation/moderne-platform/how-to-guides/moderne-platform-search.md)
2. [Add the recipes to the builder](recipe-builder.md#adding-recipes-to-the-builder)
3. [Order the recipes to match your needs](recipe-builder.md#ordering-the-recipes)
### Adding recipes to the builder
There are two possible ways of adding a recipe to the builder:
1. By pressing the `Add to Builder` button in the recipe catalog or in the recipe itself:
![](../../../.gitbook/assets/recipe-catalog-builder.png)
2. By pressing the `Add Selected to Builder` button that's available on all composite recipes (recipes that have multiple recipes that run as part of them):
![](../../../.gitbook/assets/add-selected-recipe.png)
If you press the `Add to Builder` button, the default version of the recipe and all sub-recipes (if they exist) will be added to the Recipe Builder as one high-level entry. You won't be able to individually configure or see the sub-recipes:
![](../../../.gitbook/assets/single-recipe.png)
If you want more configurability for composite recipes, such as the ability to change option values, re-order, or remove the sub-recipes, you'll need to press the `Add Selected to Builder` button. This will add an entry for each of the sub-recipes themselves rather than the high-level recipe:
![](../../../.gitbook/assets/multi-recipe.png)
If any of these recipes have options that you can configure, an upside down chevron will appear on the left side. You can click on it to expand the list of options for said recipe:
![](../../../.gitbook/assets/expand-recipe.gif)
### Ordering the recipes
Recipes added to the recipe list are run in the order they're listed. This means that if you had a recipe that changed the name of a package from `foo` to `bar` and another recipe, listed after the first one, that changed `bar` to `baz`, you would end up with both `foo` and `bar` changing to `baz`.
You can re-order the recipes in the recipe list by dragging them up and down:
![](../../../.gitbook/assets/recipe-reorder.gif)
## How to save and share custom recipes
Once you've defined and configured all of the recipes you want as part of your custom recipe, you can copy the YAML by pressing the `Copy` button or you can download it by pressing the `Download` button:
![](../../../.gitbook/assets/recipe-download.png)
This will create and download a YAML file that contains all of the information needed to re-create this recipe. You can either use that file to [re-create this recipe](recipe-builder.md#how-to-import-and-run-custom-recipes) when needed or you can send that file to anyone and they'll be able to [import it](recipe-builder.md#how-to-import-and-run-custom-recipes) and run the recipe themselves.
## How to import and run custom recipes
If you or someone on your team has previously created a recipe via the Recipe Builder, you can import it by following these instructions:
* Navigate to the [Recipe Builder page](https://app.moderne.io/recipes/builder).
* Press the `Import YAML` button in the top right corner:
![](../../../.gitbook/assets/import-yaml.png)
* A modal will appear that you can paste a declarative YAML recipe into:
![](../../../.gitbook/assets/declarative-yaml.png)
* When you're done entering the YAML, press the `Import` button in the bottom right corner of the modal. If the YAML is properly formatted, you'll see your recipe populated into the recipe builder with everything set up exactly as specified.
* You can then run the recipe as normal by pressing `Dry Run`:
![](../../../.gitbook/assets/imported-recipe-run.png)