Skip to content

Commit

Permalink
docs: Update new project docs, noting riff-raff.yaml generation
Browse files Browse the repository at this point in the history
  • Loading branch information
akash1810 committed Oct 10, 2023
1 parent 6412fff commit 2622feb
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/setting-up-a-gucdk-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Requirements:
## Creating a new project
GuCDK provides a CLI tool to create a new project.
It will place files within a `cdk` directory at the root of the repository.
It will also generate a `riff-raff.yaml` file.

To initialise a new project run the following within your repository:

Expand Down Expand Up @@ -78,7 +79,7 @@ This ensures you have a short feedback loop.
We recommend performing the following steps in CI:
- `lint` to ensure a common code format
- `test` to run the snapshot tests to make sure there are no unexpected changes to the generated CFN (see [here](best-practices.md) for more detail)
- `synth` to generate your template as JSON to `cdk/cdk.out`
- `synth` to generate your template as JSON, and a `riff-raff.yaml` file to `cdk/cdk.out`

These steps are described in the `package.json` file.

Expand Down

0 comments on commit 2622feb

Please sign in to comment.