From 5b64db29a4799f2ce83b041f13ef9b0eff78d9e7 Mon Sep 17 00:00:00 2001 From: Mikalai Radchuk <509198+m1kola@users.noreply.github.com> Date: Thu, 30 May 2024 21:52:02 +0200 Subject: [PATCH] Add GitHub forms to the project (#892) Signed-off-by: Mikalai Radchuk --- .github/ISSUE_TEMPLATE/config.yml | 6 ++++ .github/ISSUE_TEMPLATE/docs-issue.md | 29 ----------------- .github/ISSUE_TEMPLATE/docs-issue.yml | 47 +++++++++++++++++++++++++++ 3 files changed, 53 insertions(+), 29 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/docs-issue.md create mode 100644 .github/ISSUE_TEMPLATE/docs-issue.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..cbfb216e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +contact_links: + - name: Kubernetes slack + url: https://slack.k8s.io/ + about: | + Join us on #olm-dev for discussions related to OLM Development or on + #kubernetes-operators for discussions related to the Operator pattern of Kubernetes API extension. diff --git a/.github/ISSUE_TEMPLATE/docs-issue.md b/.github/ISSUE_TEMPLATE/docs-issue.md deleted file mode 100644 index 2f174fc12..000000000 --- a/.github/ISSUE_TEMPLATE/docs-issue.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: Docs issue for epics -about: Use this template for tracking doc impact for an epic. -title: "Docs: [EPIC NAME]" -labels: kind/documentation ---- - -# User story - -Describe the user story or stories for this epic: - -## List the user-facing issues in the epic that require documentation. - -- Issue: - -## Does this epic require new content or updates to existing content? - -- [ ] Net-new content -- [ ] Update existing content - -## What type of documentation is required for this epic? - -- [ ] Release note -- [ ] Concept -- [ ] Procedure -- [ ] Reference - -## Is there prior art or reference materials that would help write the documentation? - diff --git a/.github/ISSUE_TEMPLATE/docs-issue.yml b/.github/ISSUE_TEMPLATE/docs-issue.yml new file mode 100644 index 000000000..8783f540d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs-issue.yml @@ -0,0 +1,47 @@ +name: Docs issue for epics +description: Use this template for tracking doc impact for an epic. +title: "Docs: [EPIC NAME]" +labels: ["kind/documentation"] +body: + - type: textarea + id: user-story + attributes: + label: User story + description: Describe the user story or stories for this epic. + validations: + required: true + - type: textarea + id: issues-list + attributes: + label: List if issues + description: List the user-facing issues in the epic that require documentation. + placeholder: | + - Issue 1 + validations: + required: true + - type: dropdown + id: new-or-update + attributes: + label: New content or update? + description: Does this epic require new content or updates to existing content? + options: + - Net-new content + - Update existing content + validations: + required: true + - type: dropdown + id: types-of-docs + attributes: + label: Types of documentation + description: What type of documentation is required for this epic? + options: + - Release note + - Concept + - Procedure + - Reference + multiple: true + - type: textarea + id: references + attributes: + label: References + description: Is there prior art or reference materials that would help write the documentation?