From 7420ce2a939e77e45a42daae421eaf5a9cbbd0ad Mon Sep 17 00:00:00 2001
From: tsutterley <tsutterl@uw.edu>
Date: Thu, 5 Sep 2024 13:33:05 -0700
Subject: [PATCH] docs: add model providers section to contributions

---
 doc/source/getting_started/Contributing.rst | 9 +++++++--
 providers/README.rst                        | 5 ++++-
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/doc/source/getting_started/Contributing.rst b/doc/source/getting_started/Contributing.rst
index b1a87df1..36399ee9 100644
--- a/doc/source/getting_started/Contributing.rst
+++ b/doc/source/getting_started/Contributing.rst
@@ -15,6 +15,7 @@ Ways to Contribute
 3) Improving documentation and testing
 4) Sharing use cases and examples (such as `Jupyter Notebooks <../user_guide/Examples.html>`_)
 5) Providing code for everyone to use
+6) Adding model providers to the database
 
 Requesting a Feature
 --------------------
@@ -61,15 +62,19 @@ Adding Examples
 Examples may be in the form of executable scripts or interactive `Jupyter Notebooks <../user_guide/Examples.html>`_.
 Fully working (but unrendered) examples should be submitted with the same steps as above.
 
+Adding Model Providers
+^^^^^^^^^^^^^^^^^^^^^^
+Model providers can be added to their respective `JSON files <https://github.com/tsutterley/pyTMD/tree/main/providers>`_.
+The main database can then be updated by running the `merge providers <https://github.com/tsutterley/pyTMD/blob/main/providers/_providers_to_database.py>`_ script.
+
 Continuous Integration
 ^^^^^^^^^^^^^^^^^^^^^^
 We use `GitHub Actions <https://github.com/tsutterley/pyTMD/actions>`_ continuous integration (CI) services to build and test the project on Linux (Ubuntu) and Mac Operating Systems.
-The configuration files for this service are in `.github/workflows <https://github.com/tsutterley/pyTMD/blob/main/.github/workflows>`_.
+The configuration files for this service are in the `GitHub workflows <https://github.com/tsutterley/pyTMD/tree/main/.github/workflows>`_ directory.
 The workflows rely on the `environment.yml <https://github.com/tsutterley/pyTMD/blob/main/environment.yml>`_ and `requirements-dev.txt <https://github.com/tsutterley/pyTMD/blob/main/requirements-dev.txt>`_ files to install the required dependencies.
 
 The GitHub Actions jobs include:
 
-* Updating `leap second <https://github.com/tsutterley/pyTMD/blob/main/pyTMD/data/leap-seconds.list>`_ and `delta time  <https://github.com/tsutterley/pyTMD/blob/main/pyTMD/data/merged_deltat.list>`_ files
 * Running `flake8 <https://flake8.pycqa.org/en/latest/>`_ to check the code for style and compilation errors
 * Running the test suite on multiple combinations of OS and Python version
 * Uploading test coverage statistics to `Codecov <https://app.codecov.io/gh/tsutterley/pyTMD>`_
diff --git a/providers/README.rst b/providers/README.rst
index 93c170f2..5f7ba786 100644
--- a/providers/README.rst
+++ b/providers/README.rst
@@ -2,7 +2,10 @@
 pyTMD Providers
 ===============
 
+The main database is created by merging the model provider JSON files
+
 - ``AVISO``: `AVISO Global Ocean Tide Models <https://www.aviso.altimetry.fr/en/data/products/auxiliary-products/global-tide-fes.html>`_
-- ``ESR``: `Earth and Space Research Polar Tide Models <https://www.esr.org/research/polar-tide-models/>``
+- ``ESR``: `Earth and Space Research Polar Tide Models <https://www.esr.org/research/polar-tide-models/>`_
 - ``GSFC``: `NASA Goddard Space Flight Center Global Tide Models <https://earth.gsfc.nasa.gov/geo/data/ocean-tide-models>`_
 - ``TPXO``: `Oregon State University TPXO Tide Models <https://www.tpxo.net/home>`_
+-  ``providers``: Additional or stand-alone model providers