-
Notifications
You must be signed in to change notification settings - Fork 45
Issue template for notebook updates #428
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
Merged
Merged
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
e1d5117
Add update-notebook issue template
ateucher ad583c0
Merged origin/main into issue-template-update-notebook
ateucher b953be9
Link to removal template
ateucher 29bfa25
text changes
ateucher 6396d55
Update .github/ISSUE_TEMPLATE/update-notebook.yml
ateucher 8a2f8c3
fix bug emoji and labels
itcarroll 2e3820c
migrate to yaml template
itcarroll a0ab71e
unify text, replace decision section
itcarroll c86dd86
typos, grammar
itcarroll a073450
remove link to outdated g-doc
itcarroll f79df15
typo, text about co-working
itcarroll File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| name: 🌱 Add notebook | ||
| description: Propose a new notebook for the Cookbook | ||
| title: "[Add] " | ||
| labels: | ||
| - "content: add" | ||
| - maintenance | ||
| assignees: | ||
| - | ||
| body: | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Rationale | ||
| description: > | ||
| Why should a new notebook be created? What hurdle that Earthdata users encounter with | ||
| cloud computing will the content help them clear? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Related notebooks | ||
| description: > | ||
| List any existing notebooks that cover related material, and consider | ||
| whether one of those should be updated instead. Include the path(s) and | ||
| a brief note on how each is related to the proposed notebook. | ||
| placeholder: | | ||
| - how-tos/find-data/find-data-earthaccess-v2.qmd: provides a Haskell alternative | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Migration plan | ||
| description: > | ||
| Do we need to do anything for redirects, update links in other notebooks, | ||
| or otherwise help users discover this notebook? | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Contributing | ||
|
|
||
| We would be thrilled if you are also interested in starting to write the proposed | ||
| notebook! We can provide the best support if you share updates to GitHub as you write | ||
| it. If there is someone who you think would be a better fit for this issue or from whom you'd like feedback, | ||
| please reply below and `@mention` their GitHub username. | ||
|
|
||
| Our [contributing workflow](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/contributing/workflow.html) | ||
| describes how to work with GitHub branches and Quarto. Totally happy to talk | ||
| through more and screenshare at a co-working session (or Slack us to set another time)! | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Final resolution | ||
|
|
||
| After discussion, how this feedback is addressed will show up in how the | ||
| issue is resolved. | ||
|
|
||
| 1. Closed as completed: Merging a PR to add the proposed notebook automatically | ||
| closed this issue. | ||
| 2. Closed as duplicate: The author or maintainer closed this issue after | ||
| linking a [new issue](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/issues/new?template=update-notebook.yml) | ||
| created from the " Update notebook" template. | ||
| 3. Closed as won't fix: The author or maintainer closed this issue | ||
| if no changes are necessary. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| name: Update notebook | ||
| description: Propose updating a notebook in the Cookbook | ||
| title: "[UPDATE] " | ||
| labels: | ||
| - "content: update" | ||
| - maintenance | ||
| assignees: | ||
| - | ||
| body: | ||
| - type: input | ||
| attributes: | ||
| label: Notebook to update | ||
| description: > | ||
| What specific page or notebook needs to be updated? Provide a full URL or path. | ||
| placeholder: "https://nasa-openscapes.github.io/earthdata-cloud-cookbook/how-tos/read_data.html" | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Problmeatic or missing content | ||
|
itcarroll marked this conversation as resolved.
Outdated
|
||
| description: > | ||
| Describe what is out of date, incorrect, or missing. Be as specific as | ||
| possible so it is easy to identify the section(s) that need attention. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Recommended updates | ||
| description: > | ||
| What changes would bring this notebook up to date? Include suggested | ||
| code snippets, links to relevant documentation, or other resources. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Additional context | ||
| description: > | ||
| Any other information that might be helpful, such as related issues, | ||
| PRs, or external references. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Final resolution | ||
|
|
||
| After discussion, how this feedback is addressed will show up in how | ||
| this issue is resolved. | ||
|
|
||
| 1. Closed as completed: merging a PR to update this notebook automatically | ||
| closed this issue. | ||
| 2. Closed as duplicate: the author or a maintainer closed this issue | ||
| after linking an existing issue with the " Update notebook" template | ||
| or a [new issue](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/issues/new?template=remove-notebook.yml) | ||
| with the "🥀 Remove notebook" template. | ||
| 3. Closed as won't fix: the author or a maintainer closed this issue | ||
| manually if no changes are necessary. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.