Skip to content

Commit

Permalink
deploy: 7c3c4e6
Browse files Browse the repository at this point in the history
  • Loading branch information
gregcaporaso committed Apr 16, 2024
1 parent f62f867 commit 1c00784
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 14 deletions.
2 changes: 0 additions & 2 deletions _sources/docs/developer-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

*Developing with QIIME 2* is being authored by [Greg Caporaso](https://github.com/gregcaporaso) and [Evan Bolyen](https://github.com/ebolyen).

This book will migrate to https://dev.qiime2.org shortly - until that time, URLs may not be stable.

Contributions from others are welcomed and acknowledged via the project's [GitHub contributors page](https://github.com/caporaso-lab/developing-with-qiime2/graphs/contributors) in [](acknowledgements).
At the moment, while we're still laying the groundwork, we're accepting only [specific contributions](https://github.com/caporaso-lab/developing-with-qiime2/labels/help%20wanted).

Expand Down
11 changes: 7 additions & 4 deletions _sources/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,16 @@ If you just want to find instructions for creating your QIIME 2 development envi

```{admonition} Development status of this content
:class: note
*Developing with QIIME 2* remains in [very active development](https://github.com/caporaso-lab/developing-with-qiime2/commits/main/) between March and April of 2024.
*Developing with QIIME 2* remains in [very active development](https://github.com/caporaso-lab/developing-with-qiime2/commits/main/), and as a result some URLs may change.
It should be getting more complete by the day. 🚀
As of 13 March 2024, most of the content from the [old QIIME 2 Developer Documentation](https://dev.qiime2.org/2024.2/) has been transitioned to *Developing with QIIME 2*.
This book will migrate to https://dev.qiime2.org shortly - until that time, URLs may not be stable.
The canonical URL for this project is now https://develop.qiime2.org.
The [](plugin-tutorial-intro) chapter is where the focus is at the moment, and it'll stay there for the near future, though all of the [](plugins/intro.md) chapters have useful and up-to-date content in them.
The "old developer documentation", which was previously hosted at `https://dev.qiime2.org` is now deprecated.
All content that is still relevant has been ported from that documentation to *Developing with QIIME 2*.
If you do want to access that archival content, you can find it in the [project's GitHub repository](https://github.com/qiime2/dev-docs).
The [](plugin-tutorial-intro) chapter is where the focus is for the near future, though all of the [](plugins/intro.md) chapters have useful and up-to-date content in them.
You'll also find content in [](framework-explanations) and various other chapters throughout, but those are currently less thorough and generally need some updates.
Please [let us know](https://github.com/caporaso-lab/developing-with-qiime2/issues) if you find anything that is inaccurate or outdated.
```
Expand Down
2 changes: 1 addition & 1 deletion _sources/plugins/tutorials/add-nw-align-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ Usage: qiime dwq2 [OPTIONS] COMMAND [ARGS]...
Description: A prototype of a demonstration plugin for use by readers of
*Developing with QIIME 2* (DWQ2).

Plugin website: https://cap-lab.bio/developing-with-qiime2/
Plugin website: https://develop.qiime2.org/

Getting user support: Please post to the QIIME 2 forum for help with this
plugin: https://forum.qiime2.org
Expand Down
1 change: 0 additions & 1 deletion docs/developer-documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,6 @@ <h1>Developer documentation</h1>
<section class="tex2jax_ignore mathjax_ignore" id="developer-documentation">
<span id="contributing-to-dwq2"></span><h1>Developer documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this heading">#</a></h1>
<p><em>Developing with QIIME 2</em> is being authored by <a class="reference external" href="https://github.com/gregcaporaso">Greg Caporaso</a> and <a class="reference external" href="https://github.com/ebolyen">Evan Bolyen</a>.</p>
<p>This book will migrate to <a class="reference external" href="https://dev.qiime2.org">https://dev.qiime2.org</a> shortly - until that time, URLs may not be stable.</p>
<p>Contributions from others are welcomed and acknowledged via the project’s <a class="reference external" href="https://github.com/caporaso-lab/developing-with-qiime2/graphs/contributors">GitHub contributors page</a> in <a class="reference internal" href="../intro.html#acknowledgements"><span class="std std-ref">Acknowledgements</span></a>.
At the moment, while we’re still laying the groundwork, we’re accepting only <a class="reference external" href="https://github.com/caporaso-lab/developing-with-qiime2/labels/help%20wanted">specific contributions</a>.</p>
<p>If you have suggestions or feedback <a class="reference external" href="https://github.com/caporaso-lab/developing-with-qiime2/issues">we’d love to hear from you</a>.</p>
Expand Down
10 changes: 6 additions & 4 deletions intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -434,11 +434,13 @@ <h1><em>Developing with QIIME 2</em><a class="headerlink" href="#developing-with
</div>
<div class="note admonition">
<p class="admonition-title">Development status of this content</p>
<p><em>Developing with QIIME 2</em> remains in <a class="reference external" href="https://github.com/caporaso-lab/developing-with-qiime2/commits/main/">very active development</a> between March and April of 2024.
<p><em>Developing with QIIME 2</em> remains in <a class="reference external" href="https://github.com/caporaso-lab/developing-with-qiime2/commits/main/">very active development</a>, and as a result some URLs may change.
It should be getting more complete by the day. 🚀</p>
<p>As of 13 March 2024, most of the content from the <a class="reference external" href="https://dev.qiime2.org/2024.2/">old QIIME 2 Developer Documentation</a> has been transitioned to <em>Developing with QIIME 2</em>.
This book will migrate to <a class="reference external" href="https://dev.qiime2.org">https://dev.qiime2.org</a> shortly - until that time, URLs may not be stable.</p>
<p>The <a class="reference internal" href="plugins/tutorials/intro.html#plugin-tutorial-intro"><span class="std std-ref">Tutorial: A step-by-step guide to building your first QIIME 2 plugin</span></a> chapter is where the focus is at the moment, and it’ll stay there for the near future, though all of the <a class="reference internal" href="plugins/intro.html"><span class="doc std std-doc">Plugin Development</span></a> chapters have useful and up-to-date content in them.
<p>The canonical URL for this project is now <a class="reference external" href="https://develop.qiime2.org">https://develop.qiime2.org</a>.</p>
<p>The “old developer documentation”, which was previously hosted at <code class="docutils literal notranslate"><span class="pre">https://dev.qiime2.org</span></code> is now deprecated.
All content that is still relevant has been ported from that documentation to <em>Developing with QIIME 2</em>.
If you do want to access that archival content, you can find it in the <a class="reference external" href="https://github.com/qiime2/dev-docs">project’s GitHub repository</a>.</p>
<p>The <a class="reference internal" href="plugins/tutorials/intro.html#plugin-tutorial-intro"><span class="std std-ref">Tutorial: A step-by-step guide to building your first QIIME 2 plugin</span></a> chapter is where the focus is for the near future, though all of the <a class="reference internal" href="plugins/intro.html"><span class="doc std std-doc">Plugin Development</span></a> chapters have useful and up-to-date content in them.
You’ll also find content in <a class="reference internal" href="framework/explanations/intro.html#framework-explanations"><span class="std std-ref">Framework explanations</span></a> and various other chapters throughout, but those are currently less thorough and generally need some updates.
Please <a class="reference external" href="https://github.com/caporaso-lab/developing-with-qiime2/issues">let us know</a> if you find anything that is inaccurate or outdated.</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion plugins/tutorials/add-nw-align-method.html
Original file line number Diff line number Diff line change
Expand Up @@ -678,7 +678,7 @@ <h3>Calling the action with <a class="reference internal" href="../../back-matte
<span class="w"> </span>Description:<span class="w"> </span>A<span class="w"> </span>prototype<span class="w"> </span>of<span class="w"> </span>a<span class="w"> </span>demonstration<span class="w"> </span>plugin<span class="w"> </span><span class="k">for</span><span class="w"> </span>use<span class="w"> </span>by<span class="w"> </span>readers<span class="w"> </span>of
<span class="w"> </span>*Developing<span class="w"> </span>with<span class="w"> </span>QIIME<span class="w"> </span><span class="m">2</span>*<span class="w"> </span><span class="o">(</span>DWQ2<span class="o">)</span>.

<span class="w"> </span>Plugin<span class="w"> </span>website:<span class="w"> </span>https://cap-lab.bio/developing-with-qiime2/
<span class="w"> </span>Plugin<span class="w"> </span>website:<span class="w"> </span>https://develop.qiime2.org/

<span class="w"> </span>Getting<span class="w"> </span>user<span class="w"> </span>support:<span class="w"> </span>Please<span class="w"> </span>post<span class="w"> </span>to<span class="w"> </span>the<span class="w"> </span>QIIME<span class="w"> </span><span class="m">2</span><span class="w"> </span>forum<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="nb">help</span><span class="w"> </span>with<span class="w"> </span>this
<span class="w"> </span>plugin:<span class="w"> </span>https://forum.qiime2.org
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 1c00784

Please sign in to comment.