Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
majori committed Dec 18, 2023
1 parent 180b673 commit ca045c2
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/site/docs/api.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!-- This file will be generated by running `task docs:gen` -->
**NOTE**: This file will be overridden by running `task docs:gen` before publishing the documentation. Do not manually edit this file.
5 changes: 3 additions & 2 deletions docs/site/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Jalapeno is **a project templating system** which support complex templating whi

## Features

- **Easy to use**: The CLI guides the user as much as possible when using recipes. This is done by prompting the user [interactively](https://github.com/charmbracelet/bubbletea) for required template values, provides validation for the values, giving hints about what to do after executing the recipe etc.
- **Modular**: Project can contain multiple recipes, so you can compose your projects from multiple smaller templates modules.
- **Tool agnostic**: Recipes can define whatever tools to be used in the project, and Jalapeno related files can be ejected from the project at any time.
- **Continous integration**: Recipes are versioned, and new versions of the recipe can be merged to existing projects. Recipes can be shared via OCI compatible (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.
- **Snapshots tests**: Recipes can define snapshot tests, which reduces regression by ensuring that the templates produces expected outputs.
- **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.
- **Snapshots tests**: Recipes can define snapshot tests, which reduces regression when developing the templates by ensuring that the templates produces expected outputs.
15 changes: 15 additions & 0 deletions docs/site/docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ my-recipe
The `templates` directory contains the templates which will be rendered to the project directory. You can add and edit files there or you can already _execute the recipe_ (render the templates) to your project directory by running:

```bash
mkdir my-project && cd my-project
jalapeno execute my-recipe

# OR

mkdir my-project
jalapeno execute my-recipe -d my-project
```
Expand All @@ -54,6 +59,16 @@ jalapeno execute oci://ghcr.io/futurice/jalapeno/examples/variable-types:v0.0.0

:::

:::tip

You can also set the values with `--set` flag when executing the recipe. For example:

```bash
jalapeno execute my-recipe --set MY_VAR=foo
```

:::

After this, the project directory should have the following files:

```
Expand Down

0 comments on commit ca045c2

Please sign in to comment.