full edit Initializr topics

Author: anita-flegg

api/v4/initializr/index.md

@@ -2,12 +2,15 @@
 
 An Initializr jumpstarts .NET development by generating projects based on project metadata.
 Metadata may include, among other properties, a project name, a namespace, and a list of dependencies.
-At the core of an Initializr is the _[InitializrService](https://github.com/SteeltoeOSS/InitializrService)_.
-_InitializrService_ provides several REST/HTTP endpoints, which includes an endpoint to generate projects, and an endpoint to provide smart clients the metadata needed to construct user interfaces.
+At the core of an Initializr is the [Steeltoe InitializrService](https://github.com/SteeltoeOSS/InitializrService).
+InitializrService provides several REST/HTTP endpoints, and includes:
 
-It is possible to have a fully functioning Initializr deployment by simply deploying the _InitializrService_.
-A more user-friendly deployment may include a user interface, such as a web frontend or an IDE plugin.
-A deployment may also leverage a _[Spring Cloud Config Server](https://cloud.spring.io/spring-cloud-config/multi/multi__spring_cloud_config_server.html)_ to access a configuration store.
-As an example, the [Steeltoe Initializr deployment](https://start.steeltoe.io) includes _[InitializrWeb](https://github.com/SteeltoeOSS/InitializrWeb)_ for a friendly user experience and a _Spring Cloud Config Server_ using a GitHub-maintained configuration.
+* an endpoint to generate projects, and
+* an endpoint to provide smart clients the metadata needed to construct user interfaces
 
-_InitializrWeb_ is the reference UI for the Steeltoe Initializr and is an example of a smart client.  It uses project metadata from the _InitializrService_ to populate its web controls with, for example, supported .NET target frameworks and Steeltoe versions.
+It is possible to have a fully functioning Initializr deployment by simply deploying the InitializrService.
+A more user-friendly deployment might include a user interface, such as a web frontend or an IDE plug-in.
+A deployment may also use a [Spring Cloud Config Server](https://cloud.spring.io/spring-cloud-config/multi/multi__spring_cloud_config_server.html) to access a configuration store.
+As an example, the [Steeltoe Initializr deployment](https://start.steeltoe.io) includes [InitializrWeb](https://github.com/SteeltoeOSS/InitializrWeb) for a friendly user experience and a Spring Cloud Config Server using a GitHub-maintained configuration.
+
+InitializrWeb is the reference UI for the Steeltoe Initializr and is an example of a smart client.  It uses project metadata from the InitializrService to populate its web controls with, for example, supported .NET target frameworks and Steeltoe versions.

api/v4/initializr/initializr-service.md

@@ -1,6 +1,6 @@
 # InitializrService
 
-The _InitializrService_ provides 4 REST/HTTP endpoints:
+The InitializrService provides four REST/HTTP endpoints:
 
 * `api/`
 * `api/about`
@@ -10,7 +10,7 @@ The _InitializrService_ provides 4 REST/HTTP endpoints:
 ## `api/`
 
 `api/` accepts `GET` requests and returns a help document.
-The document includes available parameters (and their defaults) and dependencies, as well as CLI samples.
+The document includes available parameters (and their defaults) and dependencies, plus CLI samples.
 
 ```bash
 # sample: view help doc
@@ -30,7 +30,7 @@ The URI templates take a set of parameters to customize the result of a request.
 
 ## `api/about`
 
-`api/about` accepts `GET` requests and returns the _InitialzrService_ "About" information.
+`api/about` accepts `GET` requests and returns the InitializrService "About" information.
 
 ```bash
 # sample: view "About" document
@@ -46,11 +46,11 @@ $ http -p b https://start.steeltoe.io/api/about
 
 ## `api/config`
 
-`api/config` accepts `GET` requests and returns _InitializrService_ configuration.
-The returned document includes *all* configuration which can include superfluous details.
-Sub-endpoints are available allowing more targeted responses.
+`api/config` accepts `GET` requests and returns InitializrService configuration.
+The returned document includes *all* configuration, which can include superfluous details.
+Sub-endpoints are available, allowing more targeted responses.
 
-`api/config/projectMetadata` can be used by smart clients, such as the _InitializrWeb_, to assist in creating user interfaces.
+`api/config/projectMetadata` can be used by smart clients, such as the InitializrWeb, to assist in creating user interfaces.
 
 The following endpoints can be used by CLI users to browse project configuration options:
 
@@ -105,10 +105,11 @@ $ http https://start.steeltoe.io/api/config/dependencies | jq '.[] .values[] .id
 
 `api/project` accepts `GET` and `POST` requests and returns a project as an archive.
 
-Projects are configured by using HTTP parameters, such as `name` for the project name and `steeltoeVersion` for the Steeltoe version.
-The parameter `dependencies` is a little different than other parameters in that it is set to a comma-separated list of dependency IDs.
+Projects are configured using HTTP parameters, such as `name` for the project name and `steeltoeVersion` for the Steeltoe version.
+The parameter `dependencies` is different than other parameters in that it is set to a comma-separated list of dependency IDs.
 
-_Note: to get a list of parameters and dependencies, send a `GET` request to `api/`._
+> [!NOTE]
+> To get a list of parameters and dependencies, send a `GET` request to `api/`.
 
 ```bash
 # sample: generate a .NET Core App 3.1 project with actuator endpoints and a Redis backend:

api/v4/initializr/initializr-web.md

@@ -1,14 +1,14 @@
 # InitializrWeb
 
-_InitializrWeb_ is a web frontend for an Initializr deployment.
-It uses _InitializrApi_-provided project metadata to populate its interface for easy perusal and selection by an end user.
-After selecting desired project parameters, an end user uses _InitializrWeb_ to submit project generation requests to the _InitializrApi_.
+InitializrWeb is a web frontend for an Initializr deployment.
+It uses InitializrApi-provided project metadata to populate its interface for easy perusal and selection by an end user.
+After selecting desired project parameters, an end user uses InitializrWeb to submit project generation requests to the InitializrApi.
 
 ## Overview
 
 ![Steeltoe Initializr](./images/default.png)
 
-The interface is made up of 4 areas:
+The interface is made up of four areas:
 
 * project configuration area
 * project action area (bottom)
@@ -17,45 +17,45 @@ The interface is made up of 4 areas:
 
 The remainder of this document focuses on the project configuration and action areas.
 
-## Configuration
+## Project configuration
 
-The configuration area exposes 5 project properties to the end user:
+The configuration area exposes five project properties to the end user:
 
-* name
-* C# namespace
-* application name
-* description
-* Steeltoe version
-* .NET target framework
-* .NET template
-* dependencies
+* **Name**
+* **Namespace**: C# namespace
+* **Application**: application name
+* **Description**
+* **Steeltoe**: Steeltoe version
+* **.NET Framework**: .NET target framework
+* **.NET template**
+* **Dependencies**
 
-## Actions
+## Project actions
 
-The actions area provides 3 project actions to the end user:
+The actions area provides three project actions to the end user:
 
-* generate
-* explore
-* share
+* **Generate**
+* **Explore**
+* **Share**
 
 ### Generate
 
-Clicking "Generate" submits the current configuration to the _InitializrApi_ to generate a project archive.
-The resultant project archive is a Zip file named based on the project name.
+Clicking **Generate** submits the current configuration to the InitializrApi to generate a project archive.
+The resultant project archive is a Zip file with a name based on the project name.
 
 ![Steeltoe Initializr generate](images/generate.png)
 
 ### Explore
 
-Clicking "Explore" submits the current configuration to the _InitializrApi_ to generate a project archive.
+Clicking **Explore** submits the current configuration to the InitializrApi to generate a project archive.
 The resultant project archive is expanded in the UI so that the end user can explore the project.
 
 ![Steeltoe Initializr explore](images/explore.png)
 
 ### Share
 
-Clicking "Share" displays a URL that represents the current project configuration.
+Clicking **Share** displays a URL that represents the current project configuration.
 It can be shared with other developers or saved in a bookmark.
-Note that the URL is specific to _InitializrWeb_ and cannot be used directly with the _InitializrApi_.
+Note that the URL is specific to InitializrWeb and cannot be used directly with the InitializrApi.
 
 ![Steeltoe Initializr share](images/share.png)