diff --git a/CHANGELOG.md b/CHANGELOG.md index f66e4621..1c3187d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -36,7 +36,6 @@ and this project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html) integration tests ([#824](https://github.com/nsidc/earthaccess/issues/824)) ([@chuckwondo](https://github.com/chuckwondo)) - ### Removed - The `scripts/integration-test.sh` script has been removed in favor of the `integration-tests` nox session. diff --git a/docs/contributing/triaging.md b/docs/contributing/triaging.md index b71ae606..9bb3b0e5 100644 --- a/docs/contributing/triaging.md +++ b/docs/contributing/triaging.md @@ -47,7 +47,7 @@ When referencing a label in a GitHub issue or discussion, it will be useful to To link to a label in GitHub Markdown, use the following syntax: -``` +``` [label name](https://github.com/username/repository/labels/label-name) ``` @@ -55,7 +55,7 @@ To link to a label in GitHub Markdown, use the following syntax: For example, to link to the "hackathon" label in the nsidc/earthaccess repository, you would use the following syntax: -``` +``` [hackathon](https://github.com/nsidc/earthaccess/labels/hackathon) ``` @@ -80,7 +80,7 @@ When closing an issue as not planned, keep the following best practices in mind: - Offer alternative solutions or workarounds, if possible. - Link to relevant documentation or resources, if applicable. -## Discussions vs Issues +## Discussions vs Issues This section would cover the guidelines for when to use discussions versus issues, and how to migrate between them. @@ -100,7 +100,7 @@ Issues are used for: - Tracking progress on specific tasks or projects. - Requesting changes or improvements. -### When to Migrate +### When to Migrate Migrate a discussion to an issue when: @@ -121,10 +121,10 @@ Migrate an issue to a discussion when: flowchart TD %%{init: {"flowchart": {"htmlLabels": false}} }%% classDef default font-size:32pt; - start{"`Followed - issue + start{"`Followed + issue template?`"} - start ==NO==> close1[Change + start ==NO==> close1[Change to draft and ask to follow template] start == YES ==> dupe{Is duplicate?} dupe == YES ==> close2[Close and point to duplicate] @@ -147,10 +147,3 @@ flowchart TD linkStyle default stroke:black,stroke-width:2px,font-size:24pt; ``` - - - - - - - diff --git a/mkdocs.yml b/mkdocs.yml index 22fa9337..42fe209a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,7 +57,6 @@ plugins: - "tutorials/dask.ipynb" - "**/.ipynb_checkpoints/*" - nav: - "What is earthaccess?": "index.md" - "Quick start": "quick-start.md" @@ -69,7 +68,7 @@ nav: - "Maintainers Guide": "contributing/maintainers-guide.md" - "Code of Conduct": "contributing/code-of-conduct.md" - "Contributing naming convention": "contributing/naming-convention.md" - - "Triaging Doc" : "contributing/triaging.md" + - "Triaging Doc": "contributing/triaging.md" - "Resources": "resources.md" - USER GUIDE: - "user_guide/index.md" @@ -124,9 +123,9 @@ markdown_extensions: - pymdownx.snippets - pymdownx.superfences: custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:mermaid2.fence_mermaid_custom + - name: mermaid + class: mermaid + format: !!python/name:mermaid2.fence_mermaid_custom - pymdownx.tabbed: alternate_style: true