From c5ecf8a66d29e166751515f2ed6b41efb61dc565 Mon Sep 17 00:00:00 2001 From: samdulam Date: Wed, 26 Jul 2023 12:00:41 +0530 Subject: [PATCH] Change Issues so we can move to discussions --- .github/ISSUE_TEMPLATE/Bug_report.md | 175 ++++++++++++++---- .../{Custom.md => Custom.md.old} | 0 ...ture_request.md => Feature_request.md.old} | 0 .github/ISSUE_TEMPLATE/config.yml | 12 +- 4 files changed, 144 insertions(+), 43 deletions(-) rename .github/ISSUE_TEMPLATE/{Custom.md => Custom.md.old} (100%) rename .github/ISSUE_TEMPLATE/{Feature_request.md => Feature_request.md.old} (100%) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 4d481fe44..bc0bc6278 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,54 +1,149 @@ ---- -name: Bug report -about: Create a bug report -title: '' -labels: bug/need-confirmation, kind/bug -assignees: '' ---- +name: Bug Report +description: Create a report to help us improve. +labels: kind/bug,bug/need-confirmation +body: - + - Respect the issue template as much as possible. + - Summarize the issue so that we understand what is going wrong. + - Describe what you would have expected to have happened, and what actually happened instead. + - Provide easy to follow steps to reproduce the issue. + - Remain clear and concise. + - Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown). -**Bug description** -A clear and concise description of what the bug is. + - type: textarea + attributes: + label: Problem Description + description: A clear and concise description of what the bug is. + validations: + required: true -**Expected behavior** -A clear and concise description of what you expected to happen. + - type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true -**Portainer Logs** -Provide the logs of your Portainer container or Service. -You can see how [here](https://documentation.portainer.io/r/portainer-logs) + - type: textarea + attributes: + label: Actual Behavior + description: A clear and concise description of what actually happens. + validations: + required: true -**Steps to reproduce the issue:** + - type: textarea + attributes: + label: Steps to Reproduce + description: Please be as detailed as possible when providing steps to reproduce. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error + - type: textarea + attributes: + label: Portainer logs or screenshots + description: Provide Portainer container logs or any screenshots related to the issue. + validations: + required: false -**Technical details:** + - type: markdown + attributes: + value: | + # About your environment -- Portainer version: -- Docker version (managed by Portainer): -- Kubernetes version (managed by Portainer): -- Platform (windows/linux): -- Command used to start Portainer (`docker run -p 9443:9443 portainer/portainer`): -- Browser: -- Use Case (delete as appropriate): Using Portainer at Home, Using Portainer in a Commercial setup. -- Have you reviewed our technical documentation and knowledge base? Yes/No + Tell us a bit about your Portainer environment. -**Additional context** -Add any other context about the problem here. + - type: input + attributes: + label: Enter your Portainer version + description: | + Enter a valid Portainer version. Example: 2.18.4 + We only provide support for the most recent version of Portainer and the previous 3 versions. If you are on an older version of Portainer we recommend [upgrading first](https://docs.portainer.io/start/upgrade) in case your bug has already been fixed. + validations: + required: false + + - type: dropdown + attributes: + label: Portainer Edition + multiple: false + options: + - 'Business Edition (BE/EE)' + - 'Community Edition (CE)' + validations: + required: true + + - type: input + attributes: + label: Platform and Version + description: | + Enter your container management platform (Docker | Swarm | Kubernetes) along with the version. + Example: Docker 24.0.3 | Docker Swarm 24.0.3 | Kubernetes 1.26 + You can find our supported platforms [in our documentation](https://docs.portainer.io/start/requirements-and-prerequisites). + validations: + required: true + + - type: input + attributes: + label: OS and Architecture + description: | + Enter your Operating System, Version and Architecture. Example: Ubuntu 22.04, AMD64 | Raspbian OS, ARM64 + validations: + required: true + + - type: input + attributes: + label: Browser + description: | + Enter your browser and version. Example: Google Chrome 114.0 + validations: + required: false + + - type: textarea + attributes: + label: What command did you use to deploy Portainer? + description: | + Example: `docker run -d -p 8000:8000 -p 9443:9443 --name portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce:latest` + If you deployed Portainer using a compose file or manifest you can provide this here as well. + validations: + required: false + + - type: textarea + attributes: + label: Additional Information + description: Any additional information about your environment, the bug, or anything else you think might be helpful. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/Custom.md b/.github/ISSUE_TEMPLATE/Custom.md.old similarity index 100% rename from .github/ISSUE_TEMPLATE/Custom.md rename to .github/ISSUE_TEMPLATE/Custom.md.old diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md.old similarity index 100% rename from .github/ISSUE_TEMPLATE/Feature_request.md rename to .github/ISSUE_TEMPLATE/Feature_request.md.old diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 5d125e816..528dc4e54 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,11 @@ blank_issues_enabled: false contact_links: - - name: Portainer Business Edition - Get 3 nodes free - url: https://www.portainer.io/take-3 - about: Portainer Business Edition has more features, more support and you can now get 3 nodes free for as long as you want. + - name: Question + url: https://github.com/samdulam/dashy/discussions/new?category=help + about: Ask us a question about Portainer usage or deployment. + - name: Idea or Feature Request + url: https://github.com/samdulam/dashy/discussions/new?category=ideas + about: Suggest an idea or feature/enhancement that should be added in Portainer. + - name: Portainer Business Edition - Get 3 Nodes Free + url: https://www.portainer.io/take-3 + about: Portainer Business Edition has more features, more support and you can now get 3 nodes free for as long as you want. \ No newline at end of file