From 730e8f73d4f86f65ebb9e1478cb56513155f4164 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Wed, 23 May 2018 11:12:25 -0400 Subject: [PATCH] docs: Cleanup Issue Template - reorder things to make it clearer to the user what they are filing - use headers for various sections - separate the `dokku report` section to increase its importance [ci skip] --- ISSUE_TEMPLATE.md | 49 +++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 25 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 5de39d2a5..803469af1 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,13 +1,32 @@ > If you need help figuring out how to use a specific buildpack, or are having issues using multiple buildpacks, please see our [irc or slack channels](http://dokku.viewdocs.io/dokku/getting-started/where-to-get-help/#the-irc-and-slack-channels). Issues pertaining to buildpacks may be closed and locked. -Description of problem: +## Description of problem +### How reproducible -Output of the following commands +### Steps to Reproduce + +1. +2. +3. + +#### Actual Results + +#### Expected Results + +## Environment Information + +### `dokku report APP_NAME` output + +> This is required! Issues missing this information _may_ be closed +> +> For problems affecting all applications, the report output for a broken application is useful for our debugging. +> You may also run `dokku report` without any arguments to display the top-level reporting information. + +### How (deb/make/rpm) and where (AWS, VirtualBox, physical, etc.) was Dokku installed?: + +### Additional information -- `dokku report APP_NAME` - - For problems affecting all applications, the report output for a broken application is useful for our debugging. - - You may also run `dokku report` without any arguments to display the top-level reporting information. - `docker inspect CONTAINER_ID` (if applicable): (BEWARE: `docker inspect` will print environment variables for some commands, be sure you're not exposing any sensitive information when posting issues. You may replace these values with XXXXXXX): - `cat /home/dokku//nginx.conf` (if applicable): @@ -20,23 +39,3 @@ Output of the following commands - If it exists, the contents of your `Procfile`. - Output of failing Dokku commands after running `dokku trace on` (BEWARE: `trace on` will print environment variables for some commands, be sure you're not exposing any sensitive information when posting issues. You may replace these values with XXXXXXX): - -Environment details (AWS, VirtualBox, physical, etc.): - -How was Dokku installed?: - -How reproducible: - - -Steps to Reproduce: -1. -2. -3. - -Actual Results: - - -Expected Results: - - -Additional info: