Skip to content

Commit

Permalink
docs: add feature about manual edits
Browse files Browse the repository at this point in the history
  • Loading branch information
majori committed Jun 12, 2024
1 parent fc6a1e1 commit fa58ba4
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/site/docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ To get started, [install](/installation) the tool and follow the [getting starte
- **Easy to use templates**: The CLI guides the user as much as possible when using recipes. This is done by prompting the user interactively for required template values, providing validation for the values, giving hints about what to do after executing the recipe etc.
- **Modular**: A project can use multiple recipes at the same time, so you can compose your projects from multiple smaller template modules. This helps to keep the recipes simple and focused.
- **Continous integration**: Recipes are versioned, and new versions of the recipe can be merged to existing projects. Recipes can be shared via OCI compatible registries (aka container registries) so project CI/CD pipelines which already utilize the registry can easily check and notify the developers if there are new versions available for the recipes.
- **Tweakable templates**: Since every project is a little bit different, manual tweaks are often needed after a recipe has been executed. Jalapeno can still update the recipes used in a project by detecting which files has been manually edited and solve the merge conflicts. This way the project can stay up to date with the recipe, while still keeping the manual tweaks.
- **Snapshots tests**: Recipes can be tested with snapshot tests, which reduces regression when developing the templates by ensuring that the templates produces expected outputs.

0 comments on commit fa58ba4

Please sign in to comment.