deploy: 81ff09b

MDANCE.html

@@ -115,12 +115,19 @@
 </ul>
 </li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Resources</span></p>
+<p class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="about.html">About MDAKits</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Resources for MDAKit Authors</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="makingakit.html">Making an MDAKit</a></li>
-<li class="toctree-l1"><a class="reference internal" href="add.html">Adding an MDAKit to the Registry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="addingakit.html">Adding an MDAKit to the Registry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="maintainingakit.html">Maintaining an MDAKit</a></li>
 <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Other Resources</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="reviewersguide.html">Guide for reviewers</a></li>
 </ul>
 

MDonatello.html

@@ -115,12 +115,19 @@
 </ul>
 </li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Resources</span></p>
+<p class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="about.html">About MDAKits</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Resources for MDAKit Authors</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="makingakit.html">Making an MDAKit</a></li>
-<li class="toctree-l1"><a class="reference internal" href="add.html">Adding an MDAKit to the Registry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="addingakit.html">Adding an MDAKit to the Registry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="maintainingakit.html">Maintaining an MDAKit</a></li>
 <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Other Resources</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="reviewersguide.html">Guide for reviewers</a></li>
 </ul>
 

OpenMMDL.html

@@ -115,12 +115,19 @@
 </ul>
 </li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Resources</span></p>
+<p class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="about.html">About MDAKits</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Resources for MDAKit Authors</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="makingakit.html">Making an MDAKit</a></li>
-<li class="toctree-l1"><a class="reference internal" href="add.html">Adding an MDAKit to the Registry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="addingakit.html">Adding an MDAKit to the Registry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="maintainingakit.html">Maintaining an MDAKit</a></li>
 <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Other Resources</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="reviewersguide.html">Guide for reviewers</a></li>
 </ul>
 

PathSimAnalysis.html

@@ -115,12 +115,19 @@
 </ul>
 </li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Resources</span></p>
+<p class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="about.html">About MDAKits</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Resources for MDAKit Authors</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="makingakit.html">Making an MDAKit</a></li>
-<li class="toctree-l1"><a class="reference internal" href="add.html">Adding an MDAKit to the Registry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="addingakit.html">Adding an MDAKit to the Registry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="maintainingakit.html">Maintaining an MDAKit</a></li>
 <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Other Resources</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="reviewersguide.html">Guide for reviewers</a></li>
 </ul>
 

ProLIF.html

@@ -115,12 +115,19 @@
 </ul>
 </li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Resources</span></p>
+<p class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="about.html">About MDAKits</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Resources for MDAKit Authors</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="makingakit.html">Making an MDAKit</a></li>
-<li class="toctree-l1"><a class="reference internal" href="add.html">Adding an MDAKit to the Registry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="addingakit.html">Adding an MDAKit to the Registry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="maintainingakit.html">Maintaining an MDAKit</a></li>
 <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Other Resources</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="reviewersguide.html">Guide for reviewers</a></li>
 </ul>
 

_sources/about.rst.txt

@@ -1,5 +1,7 @@
 .. -*- coding: utf-8 -*-
 
+.. _about-mdakits:
+
 *************
 About MDAKits
 *************
@@ -27,7 +29,7 @@ requirements**:
 #. Minimal documentation is provided (what your code does, how to install it,
    and how to use it)
 #. At least minimal regression tests are present; continuous integration is encouraged
-#. The code is installable as a standard package
+#. The source code is installable as a standard package
 
 It is also highly encouraged that the MDAKit also satisfies:
 

_sources/addingakit.rst.txt

@@ -0,0 +1,34 @@
+.. _add-mdakit:
+
+********************************
+Adding an MDAKit to the Registry
+********************************
+
+Do you have an MDAKit? Consider adding it to the 
+:ref:`MDAKits Registry! <mdakits>`.
+
+.. note::   
+   The `MDAKit registry`_ is still in its initial stages. We expect that the way 
+   in which MDAKits are added, and the type of information required, may change
+   over time. Please reach out via the `issue tracker`_ if you have any
+   questions.
+
+Registering an MDAKit requires you to create a single file with meta information
+(called ``metadata.yaml``) describing the Kit, and add this to the 
+`MDAnalysis/mdakits repository`_ on GitHub. The links below provide information
+about this process and more detail about the ``metadata.yaml`` file.
+
+.. toctree::
+   :maxdepth: 2
+
+   registering-a-kit/step-by-step
+   registering-a-kit/metadata-yaml
+
+
+.. _`MDAKit registry`: https://mdakits.mdanalysis.org/mdakits.html
+
+.. _`issue tracker`:
+   https://github.com/MDAnalysis/MDAKits/issues
+
+.. _`MDAnalysis/mdakits repository`:
+   https://github.com/MDAnalysis/mdakits

_sources/index.rst.txt

@@ -11,8 +11,11 @@ Welcome to the MDAKit registry!
 Showcased here are a list of community generated packages which extend the
 functionality of the `MDAnalysis library`_.
 
-Follow the links below to begin exploring the available MDAKits, or view
-additional resources about MDAKits and how to write and/or add your own.
+For more information about MDAKits and the motivation behind them, please see 
+the :ref:`about-mdakits` page. 
+
+To begin exploring the :ref:`available MDAKits <mdakits>`, or view additional 
+resources on MDAKits and how to write and/or add your own, follow the links below!
 
 
 .. toctree::
@@ -24,12 +27,25 @@ additional resources about MDAKits and how to write and/or add your own.
 
 .. toctree::
    :maxdepth: 1
-   :caption: Resources
+   :caption: About
 
    about
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Resources for MDAKit Authors
+
    makingakit
-   add
+   addingakit
+   maintainingakit
    troubleshooting
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Other Resources
+
    reviewersguide
 
 

_sources/maintainingakit.rst.txt

@@ -0,0 +1,27 @@
+.. _maintaining:
+
+*********************
+Maintaining an MDAKit
+*********************
+
+.. note::   
+   This section is still under construction. If you have topics you would
+   like to see covered here, please get in touch via 
+   `MDAnalysis Github Discussion`_.
+
+There are a variety of reasons a kit may behave unexpectedly after being 
+submitted to the registry. Apart from actively developing the kit, changes in 
+kit dependencies, or even Python itself, can introduce/deprecate new/old functionality.
+For this reason, the kits' continuous integration is rerun weekly to 
+confirm the kits expected behavior.
+
+In the event that a kit no longer passes its tests, an issue in 
+MDAnalysis/MDAKits is automatically raised while notifying the maintainers 
+indicated in the `metadata.yaml` file.
+While the registry developers will be happy to help where possible, ultimately,
+the maintainers of the MDAKit are responsible for resolving such issues and 
+ensuring that the tests pass.
+The issue will automatically close after the next CI run if the tests pass again.
+
+.. _`MDAnalysis GitHub Discussions`:
+   https://github.com/MDAnalysis/mdanalysis/discussions