Skip to content

Commit

Permalink
add info on getting help
Browse files Browse the repository at this point in the history
  • Loading branch information
gregcaporaso committed Jan 11, 2024
1 parent 164c498 commit 7a21af8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
5 changes: 5 additions & 0 deletions book/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,8 @@ html:
use_issues_button: true
use_repository_button: true
favicon: _static/favicon.ico

parse:
myst_substitutions:
miniconda_url: "[Miniconda](https://conda.io/miniconda.html)"
developer_discussion: "[QIIME 2 Forum Developer Discussion](https://forum.qiime2.org/c/dev-discussion)"
7 changes: 7 additions & 0 deletions book/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
👋 Welcome to our book on QIIME 2 {cite}`qiime2-2019` development!
*Developing with QIIME 2* is designed to help you write plugins, interfaces, and contribute to the QIIME 2 framework.

```{note}
If you need help developing with QIIME 2, please feel free to reach out through the {{ developer_discussion }}.
This is preferred over contacting developers directly as there are many developers monitoring the forum (so you get help quicker!), and others can learn from our answers to your questions (so we can spend more time developing cool new functionality for QIIME 2!).
**We commit to responding to requests for help on the QIIME 2 Forum, but direct emails, posts on issues trackers, etc may be closed without reply.**
```

## About
The content in this book is organized under the [Diátaxis](https://diataxis.fr/) framework {cite}`diataxis`.
This means that you can expect Tutorials, How-To-Guides, Explainers, and References which each serve a different goal for the reader.
Expand Down

0 comments on commit 7a21af8

Please sign in to comment.