fleet/docs/Contributing/Automatically-generating-UI-component-boilerplate.md
Jacob Shandling 31f8ecb489
Clean up docs for generate (#11687)
Just some small copy improvements

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2023-05-16 13:40:55 -07:00

18 lines
678 B
Markdown

# Automatically generating UI component boilerplate
Instead of manually creating each file, you can use
the `generate` utility to automatically create the common boilerplate for a new Fleet UI component.
## Basic steps
1. `cd` into `fleet/frontend/components`
2. Run `./generate -n NewComponentName`, replacing `NewComponentName` with the desired name for your
new component.
3. A directory and all boilerplate for the various files of the component will be generated in
`fleet/frontend/components`
You can also run `./generate -h` for information about the other options available, overwrite and
specifying destination.
<meta name="pageOrderInSection" value="450">