Improvements to templates and readme (nebari-dev#893)

* 🔧 Add issue template config

* 📝 Update bug template

* 📝 Update feature template

* 📝 Better readme

* ✏️ Remove old line

.github/ISSUE_TEMPLATE/bug-report---.md

@@ -8,17 +8,55 @@ assignees: ''
 ---
 
 ## Describe the bug
-A clear and concise description of what the problem is.
-
-## How can we help?
-Help us help you.
-* What are you trying to achieve?
-* How can we reproduce the problem?
-* What is the expected behaviour?
-* And what is currently happening?
-* Any error messages?
-> If helpful, please add any screenshots and relevant links to the description.
-
-## Your environment
-Describe the environment in which you are experiencing the bug.
-> Include your conda version (use `conda --version`), k8s and any other relevant details.
+
+<!-- Use this section to clearly and concisely describe the bug. 
+We suggest using bullets (indicated by * or -) or checkboxes [ ] (filled checkbox [x]) here -->
+
+- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
+- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
+
+## Expected behaviour
+
+<!-- Tell us what you thought would happen. 
+We suggest using bullets (indicated by * or -) or checkboxes [ ] (filled checkbox [x]) here -->
+
+- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
+- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
+
+## Actual behaviour
+
+<!-- Tell us what actually happens. 
+We suggest using bullets (indicated by * or -) or checkboxes [ ] (filled checkbox [x]) here -->
+
+- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
+- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
+
+## How to reproduce
+
+<!-- Use this section to describe the steps that a user would take to experience this bug.
+For example:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error -->
+
+## Your personal set up
+<!-- Tell us a little about the system you're using or tested this bug in. -->
+
+### OS
+
+<!-- Such as Linux, Windows or OSX. 
+We suggest using bullets (indicated by * or -) or checkboxes [ ] (filled checkbox [x]) here -->
+
+- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
+
+### Dependencies
+
+<!-- Include your conda version (use `conda --version`), k8s and any other relevant details.YOU MAY SKIP THIS SECTION-->
+
+- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
+- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
+
+## Failure Logs
+
+<!-- Please include any relevant log snippets or files here. You may also include screenshots. -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 📖  QHub Documentation
+    url: https://docs.qhub.dev/en/stable/
+    about: Read QHub docs and development guide.
+  - name: 💬 GitHub discussions
+    url: https://github.com/Quansight/qhub/discussions
+

.github/ISSUE_TEMPLATE/feature-request---.md

@@ -8,15 +8,21 @@ assignees: ''
 ---
 
 ## Description
-Are you having any problems? Briefly describe what your painpoints are. For example: "I'm always frustrated when ..."
 
-## Suggestion
-What are your suggestions on how to solve this problem? What solution(s) would make you happy?
+<!-- Describe what you are proposing. Provide as much context as possible and link to related issues and/or pull requests.
+This section should contain "what" you are proposing. -->
+<!-- Are you having any problems? Briefly describe what your painpoints are. For example: "I'm always frustrated when ..." -->
 
-## Context
-How important is this feature for you? Share your thoughts on how we you think this should be prioritised. Would it be useful for many people? We try and always keep in mind how would requests can benefit the community.
+## Value/benefit
+
+<!-- What is the value in adding this feature, and who will benefit from it? Include any information that could help us prioritize the issue.
+This section should contain "why" this issue should be resolved. -->
+<!-- ✨ If this is for a new feature or enhancement, consider adding [user stories](https://www.atlassian.com/agile/project-management/user-stories). -->
+
+### If the request is related to a specific version of Kubernetes or Cloud provider
+
+Please provide these details:
 
-### If the request is related to a specific version of Kubernetes or Cloud provider, please provide these details:
 Describe your environment:
     - Conda version (use `conda --version`);
     - Kubernetes version (use `0kubectl version`):

README.md

@@ -1,9 +1,33 @@
-# QHub
+<div align="center">
+ <img alt="Qhub logo on white background" src="./docs/source/images/qhub_logo.png" width="300" />
+</div>
+<br>
+
+Information | Links |
+------------|------------|
+Project | [![License](https://img.shields.io/badge/License-BSD%203--Clause-gray.svg?colorA=2D2A56&colorB=5936D9&style=flat.svg)](https://opensource.org/licenses/BSD-3-Clause) [![QHUb documentation](https://img.shields.io/badge/📖%20Read-the%20docs-gray.svg?colorA=2D2A56&colorB=5936D9&style=flat.svg)](https://docs.qhub.dev/en/stable/) [![PyPI version](https://badge.fury.io/py/qhub.svg)](https://badge.fury.io/py/qhub)
+|
+Community | [![GH discussions](https://img.shields.io/badge/💬%20-Participate%20in%20discussions-gray.svg?colorA=2D2A56&colorB=5936D9&style=flat.svg)](https://github.com/Quansight/qhub/discussions) [![Open an issue](https://img.shields.io/badge/📝%20Open-an%20issue-gray.svg?colorA=2D2A56&colorB=5936D9&style=flat.svg)](https://github.com/Quansight/qhub/issues/new/choose) |
+CI | [![Build Docker Images](https://github.com/Quansight/qhub/actions/workflows/image.yaml/badge.svg)](https://github.com/Quansight/qhub/actions/workflows/image.yaml) [![Kubernetes Tests](https://github.com/Quansight/qhub/actions/workflows/kubernetes_test.yaml/badge.svg)](https://github.com/Quansight/qhub/actions/workflows/kubernetes_test.yaml) [![Tests](https://github.com/Quansight/qhub/actions/workflows/test.yaml/badge.svg)](https://github.com/Quansight/qhub/actions/workflows/test.yaml) [![Documentation linter](https://github.com/Quansight/qhub/actions/workflows/docs.yml/badge.svg)](https://github.com/Quansight/qhub/actions/workflows/docs.yml)|
+
+## Table of contents
+
+- [QHub HPC](#qhub-hpc)
+- [QHub](#qhub)
+  - [:cloud: Cloud Providers](#cloud-cloud-providers)
+- [:computer: Installation](#computer-installation)
+  - [Pre-requisites](#pre-requisites)
+  - [Install QHub](#install-qhub)
+- [:label: Usage](#label-usage)
+- [:question: Questions?](#question-questions)
+- [:book: Code of Conduct](#book-code-of-conduct)
+- [:gear: Installing the Development version of QHub](#gear-installing-the-development-version-of-qhub)
+- [:raised_hands: Contributions](#raised_hands-contributions)
+- [License](#license)
+
 Automated data science platform. From [JupyterHub](https://jupyter.org/hub "Multi-user version of the Notebook") to
 Cloud environments with [Dask Gateway](https://docs.dask.org/ "Parallel computing in Python").
 
-[![PyPI version](https://badge.fury.io/py/qhub.svg)](https://badge.fury.io/py/qhub)
-
 QHub is an open source tool that enables users to build and maintain
 cost-effective and scalable compute/data science platforms on [HPC](#qhub-hpc) or on [Kubernetes](#qhub) with minimal DevOps
 experience.
@@ -34,34 +58,44 @@ technologies to have your project successfully deployed.
 > If you know GitHub and feel comfortable generating and using API keys, you should have all it takes to deploy
 > and maintain your system without the need for a dedicated DevOps team. No need to learn Kubernetes, Terraform, or Helm.
 
-### Cloud Providers
+### :cloud: Cloud Providers
 QHub offers out-of-the-box support for [Digital Ocean](https://www.digitalocean.com/), Amazon [AWS](https://aws.amazon.com/), [GCP](https://cloud.google.com/ "Google Cloud Provider"), and Microsoft [Azure](https://azure.microsoft.com/en-us/).
 
 ![High-level illustration of QHub architecture](docs/source/images/qhub-cloud_architecture.png)
 
 For more details, check out the release [blog post](https://www.quansight.com/post/announcing-qhub).
 
-## Installation
+## :computer: Installation
+
 ### Pre-requisites
+
 * QHub is supported by macOS and Linux operating systems (Windows is **NOT** currently supported).
 * Compatible with Python 3.6+. New to Python? We recommend using [Anaconda](https://www.anaconda.com/products/individual).
 * Adoption of virtual environments (`conda`, `pipenv` or `venv`) is also encouraged.
 
-### Install
-To install QHub run:
-* `conda`:
+### Install QHub
+
+To install QHub type the following commands in your command line:
+
+* Install using `conda`:
+
   ```bash
   conda install -c conda-forge qhub
   ```
 
-* or `pip`:
+* Install using  `pip`:
+
     ```bash
     pip install qhub
     ```
-Once finished, you can check QHub's version (and additional CLI args) by typing:
-```
+
+Once finished, you can check QHub's version (and additional CLI
+args) by typing:
+
+```bash
 qhub --help
 ```
+
 If successful, the CLI output will be similar to the following:
 
 ```bash
@@ -78,7 +112,8 @@ optional arguments:
   -v, --version         QHub version
 ```
 
-## Usage
+## :label: Usage
+
 QHub requires the setting of environment variables to automate the deployments fully. For details on how to obtain those
 variables, check the [Step-by-Step](https://docs.qhub.dev/en/latest/source/03_tutorials_and_samples/1_project_setup_tutorial.html) guide in the docs.
 
@@ -89,30 +124,35 @@ qhub init   ... # generates initial config file and optionally automates deploym
 qhub deploy ... # creates and configures the cloud infrastructure
 ```
 
-## Questions?
+## :question: Questions?
+
 Have a look at our [FAQ](docs/source/02_get_started/07_support.md#faq) to see if your query has been answered.
 
 We separate the queries for QHub into:
 * [GitHub Discussions](https://github.com/Quansight/qhub/discussions) used to raise discussions about a subject, such as:
 "What is the recommended way to do X with QHub?"
-* [Issues](https://github.com/Quansight/qhub/issues/new/choose) for queries, bug reporting, feature requests,
-  documentation, etc.
-> We work around the clock to make QHub more excellent, but sometimes your query might take a while to get a reply. We apologise in advance and ask you to please, be patient.
 
+* [Issues](https://github.com/Quansight/qhub/issues/new/choose) for queries, bug reporting, feature requests,documentation, etc.
+
+> We work around the clock to make QHub better, but sometimes your query might take a while to get a reply. We apologise in advance and ask you to please, be patient :pray:.
+
+## :book: Code of Conduct
 
-## Code of Conduct
 To guarantee a welcoming and friendly community, we require contributors to follow our
 [Code of Conduct](https://github.com/Quansight/.github/blob/master/CODE_OF_CONDUCT.md).
 
+## :gear: Installing the Development version of QHub
 
-## Developer
 To install the latest developer version (unstable) use:
+
 ```bash
 pip install git+https://github.com/Quansight/qhub.git@dev
 ```
 
-## Contributions
+## :raised_hands: Contributions
+
 Thinking about contributing? Check out our [Contribution Guidelines](https://github.com/Quansight/qhub/blob/main/CONTRIBUTING.md).
 
 ## License
+
 [QHub is BSD3 licensed](LICENSE).