-
Notifications
You must be signed in to change notification settings - Fork 167
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New issue templates and automation (#3321)
* new issue templates and automation * update labels * Update elastic-request.yaml
- Loading branch information
1 parent
266af96
commit a849af7
Showing
8 changed files
with
176 additions
and
139 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
7 changes: 4 additions & 3 deletions
7
...b/ISSUE_TEMPLATE/0-community-request.yaml → ...hub/ISSUE_TEMPLATE/community-request.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
name: "Internal documentation request (Elastic employees)" | ||
description: Request a documentation change or enhancement. | ||
title: "[REQUEST]: " | ||
labels: ["Team:Docs"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Hi 👋. This form will create an issue that the [@elastic/obs-docs](https://github.com/orgs/elastic/teams/obs-docs) team will triage and prioritize. Please do not add any labels to your issue—that will happen automagically. | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: Describe what needs to be documented. What details do users need to know about? | ||
placeholder: | | ||
What: We're introducing new feature A. | ||
When: This feature will launch at the completion of project B. | ||
Why: This feature will make X, Y, and Z easier for the user. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: related | ||
attributes: | ||
label: Resources | ||
description: Where can the documentation team learn more about this feature? | ||
placeholder: | | ||
This feature was implemented in {link_to_PR}. | ||
This feature was scoped and researched in {link_to_issue}. | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: doc-set | ||
attributes: | ||
label: Which documentation set does this change impact? | ||
description: Stateful, Serverless, or both? | ||
options: | ||
- Stateful and Serverless | ||
- Stateful only | ||
- Serverless only | ||
- Integrations | ||
- Unknown | ||
default: 0 | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: doc-set-differences | ||
attributes: | ||
label: Feature differences | ||
description: If you selected both Stateful and Serverless above, please describe how, if at all, the feature differs in each deployment method. | ||
placeholder: The feature is identical in Stateful and Serverless. | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: version | ||
attributes: | ||
label: What release is this request related to? | ||
description: Some requests may be tied to the Elastic Stack release schedule. Some, like Serverless requests, may not. Please select an option. | ||
options: | ||
- 'N/A' | ||
- '8.11' | ||
- '8.12' | ||
- '8.13' | ||
- '8.14' | ||
- '8.15' | ||
- '8.16' | ||
default: 0 | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: collaboration | ||
attributes: | ||
label: Collaboration model | ||
description: Which team do you expect to create the initial content? | ||
options: | ||
- "The documentation team" | ||
- "The product team" | ||
- "The engineering team" | ||
- "Unknown" | ||
- "Other (please describe below)" | ||
default: 0 | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: contact | ||
attributes: | ||
label: Point of contact. | ||
description: Please assign at least one point of contact using the GitHub `@` mention. Add as many stakeholders as you'd like. | ||
value: "**Main contact:** @\n\n**Stakeholders:**\n" | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for filling out this form. Note that this form does not guarantee that your issue will be prioritized for the selected iteration. _But_, completing this issue as early and as comprehensively as possible will help us understand and plan the work better! |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
policy: | ||
- template: ['elastic-request.yaml'] | ||
section: | ||
- id: ['version'] | ||
block-list: [] | ||
label: | ||
- name: 'Request' | ||
keys: ['N/A'] | ||
- name: 'Request:8.11' | ||
keys: ['8.11'] | ||
- name: 'Request:8.12' | ||
keys: ['8.12'] | ||
- name: 'Request:8.13' | ||
keys: ['8.13'] | ||
- name: 'Request:8.14' | ||
keys: ['8.14'] | ||
- name: 'Request:8.15' | ||
keys: ['8.15'] | ||
- name: 'Request:8.16' | ||
keys: ['8.16'] | ||
- id: [doc-set] | ||
block-list: [] | ||
label: | ||
- name: 'Docset:All' | ||
keys: ['Stateful and Serverless'] | ||
- name: 'Docset:Serverless' | ||
keys: ['Serverless only'] | ||
- name: 'Docset:Stateful' | ||
keys: ['Stateful only'] | ||
- name: 'Docset:Integrations' | ||
keys: ['Integrations'] | ||
- name: 'Docset:Unknown' | ||
keys: ['Unknown'] | ||
- id: [collaboration] | ||
block-list: [] | ||
label: | ||
- name: 'Lead:Writer' | ||
keys: ['The documentation team'] | ||
- name: 'Lead:Product' | ||
keys: ['The product team'] | ||
- name: 'Lead:Eng' | ||
keys: ['The engineering team'] | ||
- name: 'Lead:Unknown' | ||
keys: ['Unknown', 'Other (please describe below)'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: Issue labeler | ||
on: | ||
issues: | ||
types: [ opened ] | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
label-component: | ||
runs-on: ubuntu-latest | ||
|
||
permissions: | ||
issues: write | ||
actions: read | ||
contents: read | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Parse issue form | ||
uses: stefanbuck/github-issue-parser@v3 | ||
id: issue-parser | ||
with: | ||
template-path: .github/ISSUE_TEMPLATE/elastic-request.yaml | ||
|
||
- name: Set labels based on issue field | ||
uses: redhat-plumbers-in-action/advanced-issue-labeler@v2 | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
issue-form: ${{ steps.issue-parser.outputs.jsonString }} | ||
template: elastic-request.yaml |