From 2f0196b3523d6597e0ffd280405f29859a389806 Mon Sep 17 00:00:00 2001 From: PSJ <51746608+thispsj@users.noreply.github.com> Date: Sun, 15 Aug 2021 15:54:13 +0530 Subject: [PATCH 1/3] Fixes position of the `id` key in the yaml config. Fixes github#9004 The `id` key is the top level key and has been misplaced in the `attributes` key. Luckily the examples do not have any such error, --- .../syntax-for-githubs-form-schema.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md index 5190ea83c309..ccbc1654f7fe 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md @@ -61,6 +61,7 @@ For each form element, you can set the following keys. | Key | Description | Required | Type | Default | Valid values | | --- | ----------- | -------- | ---- | ------- | ------- | | `type` | The type of element that you want to define. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | | +| `id` | The identifier for the element (except when the `type` key is set to `markdown`) . {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `attributes` | A set of key-value pairs that define the properties of the element. | Required | Hash | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `validations` | A set of key-value pairs that set constraints on the element. | Optional | Hash | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | @@ -118,7 +119,6 @@ You can use a `textarea` element to add a multi-line text field to your form. Co | --- | ----------- | -------- | ---- | ------- | ------- | | `label` | A brief description of the expected user input, which is also displayed in the form. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `description` | A description of the text area to provide context or guidance, which is displayed in the form. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | -| `id` | The identifier for the text area. {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `placeholder` | A semi-opaque placeholder that renders in the text area when empty. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | | `value` | Text that is pre-filled in the text area. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `render` | If a value is provided, submitted text will be formatted into a codeblock. When this key is provided, the text area will not expand for file attachments or Markdown editing. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | Languages known to {% data variables.product.prodname_dotcom %}. For more information, see [the languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). | @@ -161,7 +161,6 @@ You can use an `input` element to add a single-line text field to your form. | Key | Description | Required | Type | Default | Valid values | | --- | ----------- | -------- | ---- | ------- | ------- | | `label` | A brief description of the expected user input, which is also displayed in the form. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | -| `id` | The identifier for the input. {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `description` | A description of the field to provide context or guidance, which is displayed in the form. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | | `placeholder` | A semi-transparent placeholder that renders in the field when empty. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | | `value` | Text that is pre-filled in the field. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | @@ -199,7 +198,6 @@ You can use a `dropdown` element to add a dropdown menu in your form. | Key | Description | Required | Type | Default | Valid values | | --- | ----------- | -------- | ---- | ------- | ------- | | `label` | A brief description of the expected user input, which is displayed in the form. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | -| `id` | The identifier for the dropdown. {% data reusables.form-schema.id-must-be-unique %} | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `description` | A description of the dropdown to provide extra context or guidance, which is displayed in the form. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | | `multiple` | Determines if the user can select more than one option. | Optional | Boolean | false | {% octicon "dash" aria-label="The dash icon" %} | | `options` | An array of options the user can choose from. Cannot be empty and all choices must be distinct. | Required | String array | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | @@ -240,7 +238,6 @@ You can use the `checkboxes` element to add a set of checkboxes to your form. | Key | Description | Required | Type | Default | Valid values | | --- | ----------- | -------- | ---- | ------- | ------- | | `label` | A brief description of the expected user input, which is displayed in the form. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | -| `id` | The identifier for the set of checkboxes. {% data reusables.form-schema.id-must-be-unique %}| Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `description` | A description of the set of checkboxes, which is displayed in the form. Supports Markdown formatting. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | | `options` | An array of checkboxes that the user can select. For syntax, see below. | Required | Array | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | From ece3a8f635a02698b039ef75b61c3be97b5ed034 Mon Sep 17 00:00:00 2001 From: PSJ <51746608+thispsj@users.noreply.github.com> Date: Tue, 24 Aug 2021 19:27:42 +0530 Subject: [PATCH 2/3] Fix Grammar --- .../syntax-for-githubs-form-schema.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md index ccbc1654f7fe..aafde0c26bc2 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md @@ -61,7 +61,7 @@ For each form element, you can set the following keys. | Key | Description | Required | Type | Default | Valid values | | --- | ----------- | -------- | ---- | ------- | ------- | | `type` | The type of element that you want to define. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | | -| `id` | The identifier for the element (except when the `type` key is set to `markdown`) . {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | +| `id` | The identifier for the element, except when `type` is set to `markdown` . {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `attributes` | A set of key-value pairs that define the properties of the element. | Required | Hash | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `validations` | A set of key-value pairs that set constraints on the element. | Optional | Hash | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | From 8a3b421b6f0052d307c87489f38ed63387bf1f9a Mon Sep 17 00:00:00 2001 From: PSJ <51746608+thispsj@users.noreply.github.com> Date: Tue, 24 Aug 2021 19:33:20 +0530 Subject: [PATCH 3/3] Fix spacing Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com> --- .../syntax-for-githubs-form-schema.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md index aafde0c26bc2..097b7c7903c2 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md @@ -61,7 +61,7 @@ For each form element, you can set the following keys. | Key | Description | Required | Type | Default | Valid values | | --- | ----------- | -------- | ---- | ------- | ------- | | `type` | The type of element that you want to define. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | | -| `id` | The identifier for the element, except when `type` is set to `markdown` . {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | +| `id` | The identifier for the element, except when `type` is set to `markdown`. {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `attributes` | A set of key-value pairs that define the properties of the element. | Required | Hash | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | | `validations` | A set of key-value pairs that set constraints on the element. | Optional | Hash | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |