Skip to content

Commit

Permalink
fixes #67
Browse files Browse the repository at this point in the history
  • Loading branch information
gregcaporaso committed Apr 30, 2024
1 parent 6b38d0d commit e77a293
Show file tree
Hide file tree
Showing 11 changed files with 29 additions and 12 deletions.
17 changes: 17 additions & 0 deletions book/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,20 @@ 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)"
dwq2_gh_commit_url: "https://github.com/caporaso-lab/q2-dwq2/commit/{}"
dwq2_cookiecutter_build_commit: "3465ea40b18ae15825411a5930cfd24016f5d872"
dwq2_cookiecutter_build_commit_url: "{{dwq2_gh_commit_url.format(dwq2_cookiecutter_build_commit)}}"
dwq2_first_real_method_commit: "e54d7438d409453093cbcb4f2c06c100784afbe8"
dwq2_first_real_method_commit_url: "{{dwq2_gh_commit_url.format(dwq2_first_real_method_commit)}}"
dwq2_first_visualizer_commit: "1e802ea841ef40a40cfcdf53fca124061fcfccad"
dwq2_first_visualizer_commit_url: "{{dwq2_gh_commit_url.format(dwq2_first_visualizer_commit)}}"
dwq2_add_artifact_class_commit_1: "161c8a3a130393d24e5e538e9a622dfef51ead11"
dwq2_add_artifact_class_commit_1_url: "{{dwq2_gh_commit_url.format(dwq2_add_artifact_class_commit_1)}}"
dwq2_add_artifact_class_commit_2: "b625b7f0b8194128c5d1c9a5892ce5bcd85ec81b"
dwq2_add_artifact_class_commit_2_url: "{{dwq2_gh_commit_url.format(dwq2_add_artifact_class_commit_2)}}"
dwq2_add_usage_example_commit: "790c73536a7d0cbf6c4a3f07630c65a79c5d6077"
dwq2_add_usage_example_commit_url: "{{dwq2_gh_commit_url.format(dwq2_add_usage_example_commit)}}"
dwq2_add_2nd_transformer_commit: "93a3098b4e18796e8c33cd35088bf2a3623eed20"
dwq2_add_2nd_transformer_commit_url: "{{dwq2_gh_commit_url.format(dwq2_add_2nd_transformer_commit)}}"
dwq2_add_pipeline_commit: "1e601c41b86d98b22f4e16685e868f1c5710f3bf"
dwq2_add_pipeline_commit_url: "{{dwq2_gh_commit_url.format(dwq2_add_pipeline_commit)}}"
2 changes: 1 addition & 1 deletion book/ci/how-to-guides/maximize-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The former is an easier starting point.
The weekly development builds of the QIIME 2 distributions can help you make sure your code stays current with the distribution(s) you are targeting as you can automate your testing against them.
[](setup-dev-environment) will help you install the most recent successful development metapackage build (again, usually weekly, but sometimes the builds fail and take time to debug).

You can request feedback on your plugin as a whole from more experienced QIIME 2 developers by reaching out on the [Developer Discussion on the QIIME 2 Forum](https://forum.qiime2.org/c/dev-discussion).
You can request feedback on your plugin as a whole from more experienced QIIME 2 developers by reaching out through the {{ developer_discussion }}.
However, be cognizant of the fact that doing code review takes a long time to do well: you should only request this when you feel like you have a final draft of the plugin that you'd like to release, and expect that the reviewer may point out that there is a bunch more work that should be done before you release.
Please have others who you work closely with -- ideally experienced software developers, and even more ideally experienced QIIME 2 plugin developers -- review it first.
If you have questions along the way, you can ask those whenever - just be sure to review *[Developing with QIIME 2](https://develop.qiime2.org/)* and search the forum in case your question has already been answered previously.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The development environment you create will be suitable for creating new or cont
QIIME 2 support for Windows is restricted to Windows Subsystem for Linux (WSL).
The QIIME 2 development team doesn't have much experience developing QIIME 2 in the context of Windows.
If you're comfortable with creating development environments with WSL, we expect that it should work just fine.
If you expect that you might need help setting up your development environment, we'll be able to provide better assitance if you're developing on a Linux or macOS system.
If you expect that you might need help setting up your development environment, we'll be able to provide better assistance if you're developing on a Linux or macOS system.
```

## Install Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion book/plugins/tutorials/add-2nd-transformer.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Transformers in QIIME 2 are designed to handle converstions between objects behi
In this section, we'll do a small refactor of the code we wrote in the previous section.

```{admonition} tl;dr
The code that I wrote for this section can be found [here](https://github.com/caporaso-lab/q2-dwq2/commit/93a3098b4e18796e8c33cd35088bf2a3623eed20).
The code that I wrote for this section can be found here: {{ dwq2_add_2nd_transformer_commit_url }}.
```

## Define a transformer from `skbio.DNA` to `q2_dwq2.SingleRecordDNAFASTAFormat`
Expand Down
2 changes: 1 addition & 1 deletion book/plugins/tutorials/add-alignment-visualizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ In this lesson we'll address that by adding a simple {term}`Visualizer` to our p
(add-alignment-visualizer-commit)=
```{admonition} tl;dr
:class: tip
The complete code that I developed to add this visualizer to my plugin can be found [here](https://github.com/caporaso-lab/q2-dwq2/commit/1e802ea841ef40a40cfcdf53fca124061fcfccad).
The complete code that I developed to add this visualizer to my plugin can be found here: {{ dwq2_first_visualizer_commit_url }}.
```

## Write the visualizer function
Expand Down
6 changes: 3 additions & 3 deletions book/plugins/tutorials/add-artifact-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ And finally, the majority of this section of the tutorial will focus on creating
(add-artifact-class-commit)=
```{admonition} tl;dr
:class: tip
The complete code that I developed to define my new artifact class, including the corresponding semantic type, formats, and transformer, can be found [here](https://github.com/caporaso-lab/q2-dwq2/commit/161c8a3a130393d24e5e538e9a622dfef51ead11).
The code that I developed to transition my `nw-align` action to use my new artifact class can be found [here](https://github.com/caporaso-lab/q2-dwq2/commit/b625b7f0b8194128c5d1c9a5892ce5bcd85ec81b).
The complete code that I developed to define my new artifact class, including the corresponding semantic type, formats, and transformer, can be found here: {{ dwq2_add_artifact_class_commit_1_url }}.
The code that I developed to transition my `nw-align` action to use my new artifact class can be found here: {{ dwq2_add_artifact_class_commit_2_url }}.
```

## Artifact classes
Expand Down Expand Up @@ -88,7 +88,7 @@ Take a minute to review this list to identify artifact classes that you've used

```{note}
A how-to article is [planned](https://github.com/caporaso-lab/developing-with-qiime2/issues/58) that will provide additional detail on identifying an existing artifact class for use in your plugin.
In the meantime, please feel free to [reach out on the forum](https://forum.qiime2.org/c/dev-discussion/7) if you're strugging to identify a relevant semantic type - we know this can be challenging, and we don't mind helping.
In the meantime, please feel free to reach out through the {{ developer_discussion }} if you're struggling to identify a relevant semantic type - we know this can be challenging, and we don't mind helping.
```

## Developing a new artifact class
Expand Down
2 changes: 1 addition & 1 deletion book/plugins/tutorials/add-nw-align-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The type of action that we'll create is a {term}`method`, meaning that it will t
(add-nw-align-method-commit)=
```{admonition} tl;dr
:class: tip
The complete code that I developed to add this action to my plugin can be found [here](https://github.com/caporaso-lab/q2-dwq2/commit/e54d7438d409453093cbcb4f2c06c100784afbe8).
The complete code that I developed to add this action to my plugin can be found here: {{ dwq2_first_real_method_commit_url }}.
({term}`What does "tl;dr" mean? <tl;dr>`)
```
Expand Down
2 changes: 1 addition & 1 deletion book/plugins/tutorials/add-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ In subsequent sections of the tutorial, we'll explore developing Pipelines that
```{admonition} tl;dr
:class: tip
The complete code that I developed for this section is available [here](https://github.com/caporaso-lab/q2-dwq2/commit/1e601c41b86d98b22f4e16685e868f1c5710f3bf).
The complete code that I developed for this section is available here: {{ dwq2_add_pipeline_commit_url }}.
```

```{note}
Expand Down
2 changes: 1 addition & 1 deletion book/plugins/tutorials/add-usage-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ In this section of the tutorial, we'll define a usage example for our `nw-align`
(add-usage-example-commit)=
```{admonition} tl;dr
:class: tip
The full code that I developed for this section can be viewed [here](https://github.com/caporaso-lab/q2-dwq2/commit/790c73536a7d0cbf6c4a3f07630c65a79c5d6077).
The full code that I developed for this section can be viewed here: {{ dwq2_add_usage_example_commit_url }}.
```

## Defining a usage example for `nw-align`
Expand Down
2 changes: 1 addition & 1 deletion book/plugins/tutorials/conclusion.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can see a list of content planned for the plugin tutorial on our issue track
A good next step is to create your own plugin.
The easiest way to do that is to go back to the first section of the tutorial, [](plugin-from-template), and create your new plugin from the cookiecutter template.
Start working on adding your methods and visualizers, and don't forget your unit tests and usage examples!
Come join the [Developer Discussion](https://forum.qiime2.org/c/dev-discussion) on the QIIME 2 Forum if you need help, have feedback on this tutorial, or have more general feedback on developing QIIME 2 plugins.
Come join the {{ developer_discussion }} if you need help, have feedback on this tutorial, or have more general feedback on developing QIIME 2 plugins.

Thanks for reading and for your interest in QIIME 2!
Happy coding!
2 changes: 1 addition & 1 deletion book/plugins/tutorials/create-from-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,5 +115,5 @@ Load your duplicated table with [QIIME 2 View](https://view.qiime2.org), and pok
Next, we'll [](add-nw-align-method).
```{tip}
You can see my code after following these steps by looking at [the specific commit in my plugin repository on GitHub](https://github.com/caporaso-lab/q2-dwq2/commit/3465ea40b18ae15825411a5930cfd24016f5d872).
You can see my code after following these steps by looking at the specific commit in my plugin repository on GitHub: {{ dwq2_cookiecutter_build_commit_url }}.
```

0 comments on commit e77a293

Please sign in to comment.