Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render github actions configurations as yaml #1528

Merged
merged 9 commits into from
Nov 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/RFD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
name: "Request for Discussion (RFD) 💬"
about: Open discussion about a feature or design project in Nebari.
labels:
- "type: RFD"
title: "RFD - Title"
---

<!-- Example of when and how to create a RFD or RFC (request for comments) -->
<!-- https://gitpod.notion.site/Decision-Making-RFCs-eb4a57f3a34f40f1afbd95e05322af70 -->

<!-- Use this guide to set the status: Draft 🚧 / Open for comments 💬/ Accepted ✅ /Implemented 🚀/ Obsolete 🗃 -->

| Status | Draft 🚧 / Open for comments 💬/ Accepted ✅ /Implemented 🚀/ Obsolete 🗃 |
| ----------------- | ------------------------------------------------------------------------ |
| Author(s) | GitHub handle |
| Date Created | dd-MM-YYY |
| Date Last updated | dd-MM-YYY |
| Decision deadline | dd-MM-YYY |

# Title

## Summary

<!-- What are we trying to solve here? Try and make this concise-->

## User benefit

<!-- How will users (or other contributors) benefit from this work? What would be the headline in the release notes or blog post? -->

## Design Proposal

<!--This is the meat of the document, where you explain your proposal.

Explain the design in enough detail for somebody familiar with the project to understand. Include examples of how the feature/implementation will work. Feel free to add schematics, drawings or other supporting visual material. -->

### Alternatives or approaches considered (if any)

<!-- Make sure to discuss the relative merits of alternatives to your proposal. -->

### Best practices

<!-- Does this proposal change best practices for some aspect of using/developing JupyterLab or other project? How will these changes be communicated/enforced?
-->

### User impact

<!-- What are the user-facing changes? How will this feature be rolled out? -->

## Unresolved questions

<!-- Seed this with open questions you require feedback on from the RFD process. -->
56 changes: 37 additions & 19 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,33 @@
name: "Bug report \U0001F41B"
description: "Create a report to help us improve"
name: "Bug report 🐛"
description: "Create a report to help us reproduce and correct the bug"
title: "[BUG] - <title>"
labels: ["type: bug 🐛"]
labels: ["type: bug 🐛", "needs: triage 🚦"]

body:
- type: markdown
attributes:
value: |
Hi! Thanks for using Nebari and taking some time to contribute to this project.
# Welcome 👋

Please answer the following sections to help us troubleshoot the problem.
Thanks for using Nebari and taking some time to contribute to this project.

- type: input
Please fill out each section below. This info allows Nebari maintainers to diagnose (and fix!) your issue as
quickly as possible.
Before submitting a bug, please make sure the issue hasn't been already addressed by searching through
[the past issues](https://github.com/nebari-dev/nebari/issues).

Useful links:

- Documentation: https://www.nebari.dev
- Contributing: https://www.nebari.dev/community/

- type: textarea
attributes:
label: OS system and architecture in which you are running Nebari
label: Describe the bug
description: |
A clear and concise description of what the bug is.
We suggest using bullets (indicated by * or -).
placeholder: Be as precise as you can.
validations:
required: true

Expand All @@ -22,25 +36,23 @@ body:
label: Expected behavior
description: |
A clear and concise description of what you expected to happen.
We suggest using bullets (indicated by * or -) here.
We suggest using bullets (indicated by * or -).
validations:
required: true

- type: textarea
- type: input
attributes:
label: Actual behavior
description: |
A clear and concise description of what the bug is.
We suggest using bullets (indicated by * or -) here.
label: OS and architecture in which you are running Nebari
validations:
required: true

- type: textarea
attributes:
label: How to Reproduce the problem?
description: |
Please provide steps to reproduce this bug.
Please use numbered list items.
Please provide a minimal code example to reproduce the error.
Be as succinct as possible, and provide detailed step by step guidelines to reproduce the bug (using numbered items).
If you have created a GitHub gist, you can paste the link in this box instead.
validations:
required: true

Expand All @@ -56,7 +68,7 @@ body:

If you want to present output from multiple commands, please present
that as a shell session (commands you run get prefixed with `$ `).
Please also ensure that the "How to reproduce" section contains matching
Please also ensure that the "How to reproduce the problem?" section contains matching
instructions for reproducing this.
validations:
required: false
Expand All @@ -82,22 +94,23 @@ body:
- "GCP"
- "AWS"
- "Digital Ocean"
- "minikube"
- "kind"
validations:
required: false

- type: dropdown
attributes:
label: Integrations
description: Is this issue related to onay of the Nebari integrations?
description: Is this issue related to any of the Nebari integrations?
multiple: true
options:
- "Prefect"
- "Keycloak"
- "conda-store"
- "Dask"
- "dashboards"
- "CDS dashboards"
- "Grafana"
- "Argo"

- type: textarea
attributes:
Expand All @@ -108,3 +121,8 @@ body:
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false

- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
19 changes: 11 additions & 8 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: Nebari Documentation 📖
url: https://docs.nebari.dev/en/stable/
about: Read Nebari docs and development guide.
- name: GitHub discussions 💬
url: https://github.com/Quansight/nebari/discussions
about: Keep up to date with the community discussions
- name: "(maintainers only) Blank issue"
url: https://github.com/Quansight/nebari/issues/new
- name: Nebari Documentation
url: https://www.nebari.dev/docs/
about: Check out the Nebari documentation
- name: Nebari Discussions - our user forum
url: https://github.com/orgs/nebari-dev/discussions
about: Ask questions, discuss RFDs and help other Nebari's users
- name: Documentation issues 📖
about: Did you find an error in our documentation? Report your findings here.
url: https://github.com/nebari-dev/nebari-docs/issues/new/choose
- name: (maintainers only) - Blank issue
url: https://github.com/nebari-dev/nebari/issues/new
about: For maintainers only - should be used sparingly
15 changes: 0 additions & 15 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.

56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: "Documentation 📖"
description: Did you find an error in our documentation? Report your findings here.
title: "[DOC] - <title>"
labels: ["area: documentation 📖"]

body:
- type: markdown
attributes:
value: |
# Welcome 👋

Thanks for using Nebari and taking some time to contribute to this project.

Please fill out each section below. This info allows Nebari maintainers to diagnose (and fix!) your issue as
quickly as possible.
Before submitting a bug, please make sure the issue hasn't been already addressed by searching through
[the past issues](https://github.com/nebari-dev/nebari-docs/issues).

Useful links:

- Documentation: https://www.nebari.dev
- Contribution guidelines: https://www.nebari.dev/community/

- type: checkboxes
attributes:
label: Preliminary Checks
description: Please make sure that you verify each checkbox and follow the instructions for them.
options:
- label: "This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions"
required: true
- type: textarea
validations:
required: true
attributes:
label: Summary
description: |
What problem(s) did you run into that caused you to request a fix to the documentation or additional
documentation? What questions do you think we should answer?

- type: textarea
validations:
required: true
attributes:
label: Steps to Resolve this Issue
description: |
How can the problem be solved? Are there any additional steps required? Do any other pages need to be updated?
value: |
1.
2.
3.
...

- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ body:
- type: markdown
attributes:
value: |
Hi! Thanks for using Nebari and taking some time to contribute to this project.

Hi! Thanks for using Nebari and taking some time to contribute to Nebari.
- type: textarea
attributes:
label: Feature description
Expand All @@ -34,7 +33,6 @@ body:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/general-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: "General issue 💡"
description: "A general template for many kinds of issues."
title: "<title>"
labels: ["needs: triage 🚦"]

body:
- type: markdown
attributes:
value: |
# Welcome 👋

Thanks for using Nebari and taking some time to contribute to this project.

Please fill out each section below. This info allows Nebari maintainers to diagnose (and fix!) your issue as
quickly as possible.
Before submitting a bug, please make sure the issue hasn't been already addressed by searching through
the past issues in this repository.

Useful links:

- Documentation: https://www.nebari.dev
- Contributing: https://www.nebari.dev/community/

- type: textarea
attributes:
label: Context
description: |
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 pain points are.
validations:
required: true

- type: textarea
attributes:
label: Value and/or benefit
description: |
What is the value of 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).
validations:
required: true

- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
Loading