Skip to content

Commit a1e6c08

Browse files
itcarrollitcarroll
authored
Merge pull request #428 from NASA-Openscapes/issue-template-update-notebook
Issue template for notebook updates
2 parents 353d92c + f79df15 commit a1e6c08

5 files changed

Lines changed: 154 additions & 29 deletions

File tree

‎.github/ISSUE_TEMPLATE/add-notebook.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: 🌱 Add notebook
2+
description: Propose a new notebook for the Cookbook
3+
title: "[Add] "
4+
labels:
5+
- "content: add"
6+
- maintenance
7+
assignees:
8+
-
9+
body:
10+
11+
- type: textarea
12+
attributes:
13+
label: Rationale
14+
description: >
15+
Why should a new notebook be created? What hurdle that Earthdata users encounter with
16+
cloud computing will the content help them clear?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
attributes:
22+
label: Related notebooks
23+
description: >
24+
List any existing notebooks that cover related material, and consider
25+
whether one of those should be updated instead. Include the path(s) and
26+
a brief note on how each is related to the proposed notebook.
27+
placeholder: |
28+
- how-tos/find-data/find-data-earthaccess-v2.qmd: provides a Haskell alternative
29+
validations:
30+
required: false
31+
32+
- type: textarea
33+
attributes:
34+
label: Navigation plan
35+
description: >
36+
Where does this notebook fit in the Cookbook? For instance, is it a how-to
37+
or a tutorial? Do we need to add links from other notebooks, or otherwise
38+
help users discover this notebook?
39+
validations:
40+
required: false
41+
42+
- type: markdown
43+
attributes:
44+
value: |
45+
## Contributing
46+
47+
We would be thrilled if you are also interested in starting to write the proposed
48+
notebook! We can provide the best support if you share updates to GitHub as you write
49+
it. If there is someone who you think would be a better fit for this issue or from whom you'd like feedback,
50+
please reply below and `@mention` their GitHub username.
51+
52+
Our [contributing workflow](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/contributing/workflow.html)
53+
describes how to work with GitHub branches and Quarto. We hold bi-weekly co-working sessions
54+
you are welcome to join, or ask on Slack for support anytime!
55+
56+
- type: markdown
57+
attributes:
58+
value: |
59+
## Final resolution
60+
61+
After discussion, how this feedback is addressed will show up in how the
62+
issue is resolved.
63+
64+
1. Closed as completed: Merging a PR to add the proposed notebook automatically
65+
closed this issue.
66+
2. Closed as duplicate: The author or maintainer closed this issue after
67+
linking a [new issue](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/issues/new?template=update-notebook.yml)
68+
created from the "🪏 Update notebook" template.
69+
3. Closed as won't fix: The author or maintainer closed this issue
70+
if no changes are necessary.

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
name: 🐞 Bug
1+
name: 🪳 Bug
22
description: >
33
A bug is an issue that differs from documentation or has unexpected behavior.
44
title: "[BUG] {{ title }}"
55
labels:
6-
- Bug
7-
- Needs Triage
6+
- bug
7+
- "needs: triage"
88
body:
99
- type: checkboxes
1010
attributes:

‎.github/ISSUE_TEMPLATE/cookbook-content-template.md‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/remove-notebook.yml‎

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Remove notebook
1+
name: 🥀 Remove notebook
22
description: Propose removing a notebook from the Cookbook
33
title: "[Remove] "
44
labels:
@@ -9,9 +9,10 @@ assignees:
99
body:
1010
- type: input
1111
attributes:
12-
label: Notebook to remove
13-
description: Path to the notebook file.
14-
placeholder: "how-tos/find-data/find-data-earthaccess.qmd"
12+
label: Content to remove
13+
description: >
14+
What specific page or notebook should be removed? Provide a full URL or path.
15+
placeholder: "https://nasa-openscapes.github.io/earthdata-cloud-cookbook/how-tos/read_data.html"
1516
validations:
1617
required: true
1718

@@ -34,7 +35,7 @@ body:
3435
covers the same ground. If you want to link to or import an external
3536
notebook, please open an issue or PR to add it.
3637
placeholder: |
37-
- how-tos/find-data/find-data-earthaccess-v2.qmd - covers the same search workflow with the current API
38+
- how-tos/find-data/find-data-earthaccess-v2.qmd: covers the same search workflow with the current API
3839
validations:
3940
required: false
4041

@@ -49,11 +50,18 @@ body:
4950
validations:
5051
required: false
5152

52-
- type: checkboxes
53+
- type: markdown
5354
attributes:
54-
label: Final decision
55-
description: >
56-
After discussion, record the outcome here before opening a PR or closing the issue.
57-
options:
58-
- label: Remove this notebook (open a PR to remove it)
59-
- label: Keep this notebook (close issue, open an issue to update it instead using the "Update notebook" issue template)
55+
value: |
56+
## Final resolution
57+
58+
After discussion, how this feedback is addressed will show up in how the
59+
issue is resolved.
60+
61+
1. Closed as completed: Merging a PR to remove this notebook automatically
62+
closed this issue.
63+
2. Closed as duplicate: The author or maintainer closed this issue after
64+
linking a [new issue](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/issues/new?template=update-notebook.yml)
65+
created from the "🪏 Update notebook" template.
66+
3. Closed as won't fix: The author or maintainer closed this issue
67+
if no changes are necessary.

‎.github/ISSUE_TEMPLATE/update-notebook.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: 🪏 Update notebook
2+
description: Propose updating a notebook in the Cookbook
3+
title: "[UPDATE] "
4+
labels:
5+
- "content: update"
6+
- maintenance
7+
assignees:
8+
-
9+
body:
10+
- type: input
11+
attributes:
12+
label: Notebook to update
13+
description: >
14+
What specific page or notebook needs to be updated? Provide a full URL or path.
15+
placeholder: "https://nasa-openscapes.github.io/earthdata-cloud-cookbook/how-tos/read_data.html"
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
attributes:
21+
label: Problematic or missing content
22+
description: >
23+
Describe what is out of date, incorrect, or missing. Be as specific as
24+
possible so it is easy to identify the section(s) that need attention.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
attributes:
30+
label: Recommended updates
31+
description: >
32+
What changes would bring this notebook up to date? Include suggested
33+
code snippets, links to relevant documentation, or other resources.
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
attributes:
39+
label: Additional context
40+
description: >
41+
Any other information that might be helpful, such as related issues,
42+
PRs, or external references.
43+
validations:
44+
required: false
45+
46+
- type: markdown
47+
attributes:
48+
value: |
49+
## Final resolution
50+
51+
After discussion, how this feedback is addressed will show up in how
52+
this issue is resolved.
53+
54+
1. Closed as completed: merging a PR to update this notebook automatically
55+
closed this issue.
56+
2. Closed as duplicate: the author or a maintainer closed this issue
57+
after linking an existing issue with the "🪏 Update notebook" template
58+
or a [new issue](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/issues/new?template=remove-notebook.yml)
59+
with the "🥀 Remove notebook" template.
60+
3. Closed as won't fix: the author or a maintainer closed this issue
61+
manually if no changes are necessary.

0 commit comments

Comments
 (0)