Skip to content

Commit

Permalink
feat(doc): #940 code sections
Browse files Browse the repository at this point in the history
- Add code sections to all builtins
- Use admonitions for notes and warnings

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
  • Loading branch information
dsalaza4 committed Mar 13, 2023
1 parent c159116 commit 64abca7
Show file tree
Hide file tree
Showing 16 changed files with 1,201 additions and 1,025 deletions.
51 changes: 26 additions & 25 deletions docs/src/api/builtins/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,31 +23,32 @@ Types:
[BatchWriteItem](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html#API_BatchWriteItem_RequestSyntax).
This is useful if you want to perform transformations on your data.

Example `makes.nix`:

```nix
{ projectPath
, ...
}:
{
dynamoDb = {
usersdb = {
host = "localhost";
infra = projectPath "/test/database/infra";
data = [
projectPath "/test/database/data"
];
daemonMode = true;
};
};
}
```

Example invocation: `$ m . /dyanmoDb/usersdb`

You can also overwrite the parameters with environment variables.

Example: `$ DAEMON=false m . /dyanmoDb/usersdb`
Example:

=== "makes.nix"

```nix
{ projectPath,
...
}: {
dynamoDb = {
usersdb = {
host = "localhost";
infra = projectPath "/test/database/infra";
data = [
projectPath "/test/database/data"
];
daemonMode = true;
};
};
}
```

=== "Invocation"

``` bash
DAEMON=false m . /dyanmoDb/usersdb
```

The following variables are available:

Expand Down
Loading

0 comments on commit 64abca7

Please sign in to comment.