details for slugs, user-defined params

attribute descriptions added for user defined params
character set and case-sensitivity added for user defined params and slugs

Author: stefan-wenig

docs/artifact-configuration/syntax.md

@@ -236,10 +236,16 @@ Parameter values can be set when submitting a signing request via the user inter
 
 Parameters are defined in an optional `parameters` block at the beginning of the artifact configuration and can be referenced using the `${parameterName}` syntax in any XML attribute.
 
+| Attribute       | Value
+|-----------------|---------
+| `name`          | Parameter name (required, case-sensitive). Valid characters: ASCII letters, digits, and the characters `.`, `-`, and `_`.
+| `default-value` | Optional default value if parameter is not provided with signing request. No leading or trailing whitespace.
+| `required`      | If `true`, the parameter must be provided and must not be empty (`""`). Default is `false`. 
+
 ~~~xml
 <artifact-configuration xmlns="http://signpath.io/artifact-configuration/v1">
   <parameters>
-    <parameter name="version" default-value="1.0.0" required="true" />
+    <parameter name="version" default-value="1.0.0" />
   </parameters>
   <pe-file path="my-installer-${version}.exe" product-name="myproduct" product-version="${version}">
 </artifact-configuration>

docs/projects.md

@@ -21,15 +21,15 @@ Projects consist of these configuration sections:
 
 ## Project settings {#project-settings}
 
-| Property                   | Value                                                                                                                     | Editions
-|----------------------------|---------------------------------------------------------------------------------------------------------------------------|-----
-| **Name**                   | Display name
-| **Slug**                   | Project name/identfier used for URLs, APIs etc.
-| **Status**                 | _Valid_, _inactive_, or _invalid_
-| **Readers**                | Users or groups who can read all information of this project, including signing request artifacts of all signing policies | {{ site.data.editions | where: "user_management.admin_delegation", "true" | map: "name" | join: ", " }}
-| **Configurators**          | Users or groups who can modify artifact configurations and Webhooks                                                       | {{ site.data.editions | where: "user_management.admin_delegation", "true" | map: "name" | join: ", " }}
-| **Repository URL**         | URL of the source code repository, for information and/or [origin verification](#signing-policy-origin-verification) 
-| **Description**            | Free text description of the project
+| Property           | Value                                                                                                                     | Editions
+|--------------------|---------------------------------------------------------------------------------------------------------------------------|-----
+| **Name**           | Display name
+| **Slug**           | Name/identfier used for APIs access. Valid characters: ASCII letters, digits, and the characters `.`, `-`, and `_`. Case-insensitive.
+| **Status**         | _Valid_, _inactive_, or _invalid_
+| **Readers**        | Users or groups who can read all information of this project, including signing request artifacts of all signing policies | {{ site.data.editions | where: "user_management.admin_delegation", "true" | map: "name" | join: ", " }}
+| **Configurators**  | Users or groups who can modify artifact configurations and Webhooks                                                       | {{ site.data.editions | where: "user_management.admin_delegation", "true" | map: "name" | join: ", " }}
+| **Repository URL** | URL of the source code repository, for information and/or [origin verification](#signing-policy-origin-verification) 
+| **Description**    | Free text description of the project
 
 ## Signing policies {#signing-policies}