address review comments

Signed-off-by: Stephanie <[email protected]>

Author: yangcao77

libs/docs/src/docs/no-version/devfile-validation-rules.md

@@ -3,7 +3,7 @@ title: Devfile validation rules
 description: Devfile validation rules
 ---
 
-## Id and Name:
+## Id and name:
 `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`
 
 The restriction is added to allow easy translation to K8s resource names, and also to have consistent rules for both `name` and `id` fields.
@@ -19,17 +19,17 @@ The validation will be done as part of schema validation, the rule will be intro
 
 ## Endpoints:
 - All the endpoint names are unique across components
-- Endpoint ports must be unique across container components -- two container components cannot have the same target port, but one container component may have two endpoints with the same target port. This restriction does not apply to container components with `dedicatedPod` set to `true`.
+- Endpoint ports must be unique across `container` components -- two `container` components cannot have the same `targetPort`, but one `container` component may have two endpoints with the same `targetPort`. This restriction does not apply to `container` components with `dedicatedPod` set to `true`.
 
 
 ## Commands:
 1. `id` must be unique
-2. composite command:
+2. `composite` command:
     - Should not reference itself via a subcommand
-    - Should not indirectly reference itself via a subcommand which is a composite command
+    - Should not indirectly reference itself via a subcommand which is a `composite` command
     - Should reference a valid devfile command
-3. `exec` command should: map to a valid container component
-4. `apply` command should: map to a valid container/kubernetes/openshift/image component
+3. `exec` command should: map to a valid `container` component
+4. `apply` command should: map to a valid `container`/`kubernetes`/`openshift`/`image` component
 5. `{build, run, test, debug, deploy}`, each kind of group can only have one default command associated with it. If there are multiple commands of the same kind without a default, a warning will be displayed.
 
 ## Components:
@@ -42,11 +42,11 @@ Common rules for all components types:
 3. The annotations should not have conflict values for same key, except deployment annotations and service annotations set for a container with `dedicatedPod=true`
 4. Resource requirements, e.g. `cpuLimit`, `cpuRequest`, `memoryLimit`, `memoryRequest`, must be in valid quantity format; and the resource requested must be less than the resource limit (if specified).
 
-### Plugin Component
+### Plugin component
 - Commands in plugins components share the same commands validation rules as listed above. Validation occurs after overriding and merging, in flattened devfile
 - Registry URL needs to be in valid format
 
-### Kubernetes & Openshift component 
+### Kubernetes & OpenShift component 
 - `uri` needs to be a valid URI format
 
 ### Image component 
@@ -56,18 +56,18 @@ Common rules for all components types:
 ## Events:
 1. `preStart` and `postStop` events can only be `apply` commands
 2. `postStart` and `preStop` events can only be `exec` commands
-3. If `preStart` and `postStop` events refer to a composite command, then all containing commands need to be `apply` commands.
-4. If `postStart` and `preStop` events refer to a composite command, then all containing commands need to be `exec` commands.
+3. If `preStart` and `postStop` events refer to a `composite` command, then all containing commands need to be `apply` commands.
+4. If `postStart` and `preStop` events refer to a `composite` command, then all containing commands need to be `exec` commands.
 
 
 ## Parent:
 - Share the same validation rules as listed above. Validation occurs after overriding and merging, in flattened devfile
 
 
-## starterProjects:
+## Starter projects:
 - Starter project entries cannot have more than one remote defined
 - If `checkoutFrom.remote` is mentioned, validate it against the starter project remote configured map
 
-## projects
+## Projects
 - If more than one remote is configured, a checkout remote is mandatory
 - If checkout remote is mentioned, validate it against the starter project remote configured map