diff --git a/.doctrees/add.doctree b/.doctrees/add.doctree index 71279165..0225eedd 100644 Binary files a/.doctrees/add.doctree and b/.doctrees/add.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 53fe123b..f607a90c 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/_sources/add.rst.txt b/_sources/add.rst.txt index 0755ef7a..997d8690 100644 --- a/_sources/add.rst.txt +++ b/_sources/add.rst.txt @@ -2,18 +2,18 @@ Adding an MDAKit to the Registry ******************************** -Do you have an MDAKit? Consider adding it to the Registry! +Do you have an MDAKit? Consider adding it to the `MDAKit registry`_! .. note:: - The MDAKit registry is still in its infancy, we expect that the + The `MDAKit registry`_ is still in its infancy, 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. Adding an MDAKit is a simple process, and follows the following steps: - * Create a fork the MDAKit repository + * Create a fork the MDAKit repository https://github.com/MDAnalysis/mdakits * Make a new branch * Add a new folder under ``mdakits`` with the name of your MDAKit * Add a metadata YAML file with your MDAKit's details (a template can be found under ``mdakits/template``) @@ -92,3 +92,5 @@ The following is an example metadata file for propkatraj:: .. _`issue tracker`: https://github.com/MDAnalysis/MDAKits/issues +.. _`MDAKit registry`: https://mdakits.mdanalysis.org/mdakits.html + diff --git a/add.html b/add.html index e648b693..8836fc05 100644 --- a/add.html +++ b/add.html @@ -85,17 +85,17 @@

Adding an MDAKit to the Registry

-

Do you have an MDAKit? Consider adding it to the Registry!

+

Do you have an MDAKit? Consider adding it to the MDAKit registry!

Note

-

The MDAKit registry is still in its infancy, we expect that the +

The MDAKit registry is still in its infancy, 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.

Adding an MDAKit is a simple process, and follows the following steps:
    -

  • Create a fork the MDAKit repository

    • +

  • Create a fork the MDAKit repository https://github.com/MDAnalysis/mdakits

  • Make a new branch

  • Add a new folder under mdakits with the name of your MDAKit

  • Add a metadata YAML file with your MDAKit’s details (a template can be found under mdakits/template)