-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Docs: Add figure for navigating help resources #9147
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 9 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
ac7ff02
add getting help diagram to Xarray docs
JessicaS11 11b9edf
add config and switch to directive notation
JessicaS11 db63742
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] b518ff1
add change to whatsnew
JessicaS11 1a40ef8
add direct link to discussion and fix indent
JessicaS11 b1b8957
remove title;add alt text
JessicaS11 adcf69f
update diagram lines for small contribs
JessicaS11 b218804
reorder extensions
JessicaS11 480346f
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] f6d8913
add nbsphinx_requirejs_path config value
JessicaS11 893ea47
move help page up a level in toc
JessicaS11 dc2227a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 55f14ca
move file to correct level
JessicaS11 38c8173
Bump mermaid version
dcherian 0d3f667
[skip-ci]
dcherian 4cfebee
Merge branch 'main' into help-fig
JessicaS11 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
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,75 @@ | ||
Getting Help | ||
============ | ||
|
||
Navigating the wealth of resources available for Xarray can be overwhelming. | ||
We've created this flow chart to help guide you towards the best way to get help, depending on what you're working towards. | ||
The links to each resource are provided below the diagram. | ||
Regardless of how you interact with us, we're always thrilled to hear from you! | ||
|
||
.. mermaid:: | ||
:alt: Flowchart illustrating the different ways to access help using or contributing to Xarray. | ||
|
||
flowchart TD | ||
intro[Welcome to Xarray! How can we help?]:::quesNodefmt | ||
usage(["fa:fa-chalkboard-user Xarray Tutorials | ||
fab:fa-readme Xarray Docs | ||
fab:fa-google Google/fab:fa-stack-overflow Stack Exchange | ||
fa:fa-robot Ask AI/a Language Learning Model (LLM)"]):::ansNodefmt | ||
API([fab:fa-readme Xarray Docs | ||
fab:fa-readme extension's docs]):::ansNodefmt | ||
help([fab:fa-github Xarray Discussions | ||
fab:fa-discord Xarray Discord | ||
fa:fa-users Xarray Office Hours | ||
fa:fa-globe Pangeo Discourse]):::ansNodefmt | ||
bug([Report and Propose here: | ||
fab:fa-github Xarray Issues]):::ansNodefmt | ||
contrib([fa:fa-book-open Xarray Contributor's Guide]):::ansNodefmt | ||
pr(["fab:fa-github Pull Request (PR)"]):::ansNodefmt | ||
dev([fab:fa-github Comment on your PR | ||
fa:fa-users Developer's Meeting]):::ansNodefmt | ||
report[Thanks for letting us know!]:::quesNodefmt | ||
merged[fa:fa-hands-clapping Your PR was merged. | ||
Thanks for contributing to Xarray!]:::quesNodefmt | ||
|
||
|
||
intro -->|How do I use Xarray?| usage | ||
usage -->|"with extensions (like Dask)"| API | ||
|
||
usage -->|I'd like some more help| help | ||
intro -->|I found a bug| bug | ||
intro -->|I'd like to make a small change| contrib | ||
subgraph bugcontrib[Bugs and Contributions] | ||
bug | ||
contrib | ||
bug -->|I just wanted to tell you| report | ||
bug<-->|I'd like to fix the bug!| contrib | ||
pr -->|my PR was approved| merged | ||
end | ||
|
||
|
||
intro -->|I wish Xarray could...| bug | ||
|
||
|
||
pr <-->|my PR is quiet| dev | ||
contrib -->pr | ||
|
||
classDef quesNodefmt fill:#9DEEF4,stroke:#206C89 | ||
|
||
classDef ansNodefmt fill:#FFAA05,stroke:#E37F17 | ||
|
||
classDef boxfmt fill:#FFF5ED,stroke:#E37F17 | ||
class bugcontrib boxfmt | ||
|
||
linkStyle default font-size:20pt,color:#206C89 | ||
|
||
|
||
- `Xarray Tutorials <https://tutorial.xarray.dev/>`__ | ||
- `Xarray Docs <https://docs.xarray.dev/en/stable/>`__ | ||
- `Google/Stack Exchange <https://stackoverflow.com/questions/tagged/python-xarray>`__ | ||
- `Xarray Discussions <https://github.com/pydata/xarray/discussions>`__ | ||
- `Xarray Discord <https://discord.com/invite/wEKPCt4PDu>`__ | ||
- `Xarray Office Hours <https://github.com/pydata/xarray/discussions/categories/office-hours>`__ | ||
- `Pangeo Discourse <https://discourse.pangeo.io/>`__ | ||
- `Xarray Issues <https://github.com/pydata/xarray/issues>`__ | ||
- `Xarray Contributors Guide <https://docs.xarray.dev/en/stable/contributing.html>`__ | ||
- `Developer's Meeting <https://docs.xarray.dev/en/stable/developers-meeting.html>`__ |
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
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
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.