From 31f8ecb489630b424ebae1ec0151d3629192931a Mon Sep 17 00:00:00 2001 From: Jacob Shandling <61553566+jacobshandling@users.noreply.github.com> Date: Tue, 16 May 2023 13:40:55 -0700 Subject: [PATCH] Clean up docs for generate (#11687) Just some small copy improvements Co-authored-by: Jacob Shandling --- ...tically-generating-UI-component-boilerplate.md} | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) rename docs/Contributing/{adding-new-UI-components.md => Automatically-generating-UI-component-boilerplate.md} (52%) diff --git a/docs/Contributing/adding-new-UI-components.md b/docs/Contributing/Automatically-generating-UI-component-boilerplate.md similarity index 52% rename from docs/Contributing/adding-new-UI-components.md rename to docs/Contributing/Automatically-generating-UI-component-boilerplate.md index 27afb46246..80ad32d3b8 100644 --- a/docs/Contributing/adding-new-UI-components.md +++ b/docs/Contributing/Automatically-generating-UI-component-boilerplate.md @@ -1,6 +1,9 @@ -# Using `generate` to create boilerplate for a new Fleet UI component +# Automatically generating UI component boilerplate -## Basic steps to create a new UI component +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 @@ -8,7 +11,8 @@ 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) - \ No newline at end of file +You can also run `./generate -h` for information about the other options available, overwrite and +specifying destination. + +