docs and actions

.github/workflows/build-docs.yml

@@ -34,10 +34,10 @@ jobs:
             - name: Build Extractor docs
               shell: bash
               run: |
-                  gen-doc schemas/extractor.yaml -d docs/source/mme_schema/ --template-directory docs/source/_templates --example-directory examples/ --include-top-level-diagram --diagram-type er_diagram
+                  gen-doc schemas/extractor.yaml -d docs/source/datatractor_schema/ --template-directory docs/source/_templates --example-directory examples/ --include-top-level-diagram --diagram-type er_diagram
 
             - name: Tar gen-doc files
-              run: tar -cvf gen-doc.tar docs/source/mme_schema
+              run: tar -cvf gen-doc.tar docs/source/datatractor_schema
 
             - name: Upload gen-doc artifact
               uses: actions/upload-artifact@v3

docs/source/conf.py

@@ -19,9 +19,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "MaRDA Metadata Extractors"
-copyright = "2022 - 2023, MaRDA Metadata Extractors Team"
-author = "Peter Kraus, Matthew Evans"
+project = "datatractor schema"
+copyright = "2022 - 2024, datatractor team"
+author = "Matthew Evans, Peter Kraus"
 release = version
 
 
@@ -70,8 +70,8 @@
 }
 html_context = {
     "display_github": True,
-    "github_user": "marda-alliance",
-    "github_repo": "metadata_extractors_schema",
+    "github_user": "datatractor",
+    "github_repo": "schema",
     "github_version": version,
     "conf_py_path": "/docs/source/"
 }

docs/source/contributing.rst

@@ -5,23 +5,24 @@ Contributions to this project are welcome. We pledge to follow the `Contributor
 
 .. note::
 
-    If you wish to contribute a new :class:`FileType` or a new :class:`Extractor` to the `Registry <https://marda-registry.fly.dev/>`_, please open a pull request at |MMERegistryRepo|_.
+    If you wish to contribute a new :class:`FileType` or a new :class:`Extractor` to the `Registry <https://marda-registry.fly.dev/>`_, please open a pull request at |yardrepo|_.
 
-If you have any suggestions, technical queries, or a feature request related to the schemas, please do not hesitate to `open an issue <https://github.com/marda-alliance/metadata_extractors_schema/issues>`_ on |MMESchemaRepo|_.
+If you have any suggestions, technical queries, or a feature request related to the schemas, please do not hesitate to `open an issue <https://github.com/datatractor/schema/issues>`_ on |schemarepo|_.
 
-For general questions related to the MaRDA Metadata Extractors WG, please use the `discussion board on GitHub <https://github.com/marda-alliance/metadata_extractors/discussions>`_.
+For general questions related to the datatractor project, please use the `discussion board in the schema repo on GitHub <https://github.com/datatractor/schema/discussions>`_.
 
 Contributors
 ------------
 
 - Matthew Evans `@ml-evs <https://github.com/ml-evs>`_
 - Peter Kraus `@PeterKraus <https://github.com/PeterKraus>`_
+- David Elbert `@davidelbert <https://github.com/davidelbert>`
 
 
-.. |MMERegistryRepo| image:: https://badgen.net/static/marda-alliance/metadata_extractors_registry/?icon=github
+.. |schemarepo| image:: https://badgen.net/static/datatractor/schema/?icon=github
 
-.. _MMERegistryRepo: https://github.com/marda-alliance/metadata_extractors_registry/
+.. _schemarepo: https://github.com/datatractor/schema/
 
-.. |MMESchemaRepo| image:: https://badgen.net/static/marda-alliance/metadata_extractors_schema/?icon=github
+.. |yardrepo| image:: https://badgen.net/static/datatractor/yard/?icon=github
 
-.. _MMESchemaRepo: https://github.com/marda-alliance/metadata_extractors_schema/
+.. _yardrepo: https://github.com/datatractor/yard/

docs/source/index.rst

@@ -1,9 +1,14 @@
-MaRDA Metadata Extractors Schema
-================================
+datatractor schema
+==================
 
-A repository at |MMESchemaRepo|_, containing the |LinkML|_-based schemas backing the |MMERegistryRepo|_.
+A repository at |schemarepo|_, containing the |LinkML|_-based schemas backing the |yardrepo|_.
 
-The schemas implemented here are machine-actionable. They are used by the `Registry <https://marda-registry.fly.dev/>`_ to validate entries; a reference implementation demonstrating their pracical use is shown in the |MMEAPIRepo|_.
+The schemas implemented here are machine-actionable. They are used by the `Registry <https://marda-registry.fly.dev/>`_ to validate entries; a reference implementation demonstrating their pracical use is shown in the |beamrepo|_.
+
+.. note::
+
+   This work is a continuation of the MaRDA WG7 on Automated `Metadata Extractors
+   <https://www.marda-alliance.org/working-group/wg7-automated-metadata-extractors/>`_.
 
 Contents
 ````````
@@ -26,39 +31,39 @@ The repository contains a schema two user-facing classes:
    :caption: Schema Docs
    :hidden:
 
-   mme_schema/FileType
-   mme_schema/Extractor
+   datatractor_schema/FileType
+   datatractor_schema/Extractor
 
 .. toctree::
    :maxdepth: 3
    :caption: Autogenerated Docs
    :hidden:
    :glob:
 
-   mme_schema/index
+   datatractor_schema/index
 
 
 
-.. |MMESchemaRepo| image:: https://badgen.net/static/marda-alliance/metadata_extractors_schema/?icon=github
+.. |schemarepo| image:: https://badgen.net/static/datatractor/schema/?icon=github
 
-.. _MMESchemaRepo: https://github.com/marda-alliance/metadata_extractors_schema/
+.. _schemarepo: https://github.com/datatractor/schema/
 
-.. |MMERegistryRepo| image:: https://badgen.net/static/marda-alliance/metadata_extractors_registry/?icon=github
+.. |yardrepo| image:: https://badgen.net/static/datatractor/yard/?icon=github
 
-.. _MMERegistryRepo: https://github.com/marda-alliance/metadata_extractors_registry/
+.. _yardrepo: https://github.com/datatractor/yard/
 
-.. |MMEAPIRepo| image:: https://badgen.net/static/marda-alliance/metadata_extractors_api/?icon=github
+.. |beamrepo| image:: https://badgen.net/static/datatractor/beam/?icon=github
 
-.. _MMEAPIRepo: https://github.com/marda-alliance/metadata_extractors_api/
+.. _MMEAPIRepo: https://github.com/datatractor/beam/
 
 .. |LinkML| replace:: :mod:`LinkML`
 
 .. _LinkML: https://linkml.io/linkml/
 
 .. |FileType| replace:: :class:`FileType`
 
-.. _FileType: mme_schema/FileType.html#class-filetype
+.. _FileType: datatractor_schema/FileType.html#class-filetype
 
 .. |Extractor| replace:: :class:`Extractor`
 
-.. _Extractor: mme_schema/Extractor.html#class-extractor
+.. _Extractor: datatractor_schema/Extractor.html#class-extractor

docs/source/usage.rst

@@ -1,16 +1,16 @@
-Usage of MaRDA Metadata Extractors Schema
-=========================================
+Usage of datatractor schema
+===========================
 
 Usage example
 -------------
 
-This repository is intended to be used as a |git submodule|_ to be cloned and used by your downstream code. As an example, we may look at the |MME Registry|_:
+This repository is intended to be used as a |git submodule|_ to be cloned and used by your downstream code. As an example, we may look at the |yard|_:
 
 .. figure:: images/registry.screenshot.PNG
-   :target: https://github.com/marda-alliance/metadata_extractors_registry
-   :alt: A screenshot of the MaRDA Metadata Extractors Registry showing "schemas" as a link to another repository.
+   :target: https://github.com/datatractor/yard
+   :alt: A screenshot of the datatractor yard showing "schemas" as a link to another repository.
 
-   A screenshot of |MME Registry|. Note that ``schemas`` is a ``git submodule``, pointing to the Schema repository at a certain commit (here: |c03a732|_, corresponding to the 0.2 release).
+   A screenshot of |yard|. Note that ``schemas`` is a ``git submodule``, pointing to the Schema repository at a certain commit (here: |c03a732|_, corresponding to the 1.0 release).
 
 After initializing and updating the submodule, the yaml files defining the |FileType|_ and |Extractor|_ schemas are available in the ``<submodule>/schemas/`` directory.
 
@@ -45,36 +45,36 @@ The |LinkML|_ schemas provided here can be automatically translated to other for
     gen-python <submodule>/schemas/filetype.yml >> filetype.py
     gen-pydantic <submodule>/schemas/filetype.yml >> filetype.py
 
-The generated files are intended to be used in downstream codes such as in the `validation function <https://github.com/marda-alliance/metadata_extractors_registry/blob/main/tasks.py#L33>`_ of the |MME Registry|_.
+The generated files are intended to be used in downstream codes such as in the `validation function <https://github.com/datatractor/yard/blob/main/tasks.py#L33>`_ of the |yard|_.
 
 
 .. |git submodule| replace:: ``git submodule``
 
 .. _git submodule: https://git-scm.com/book/en/v2/Git-Tools-Submodules
 
-.. |MME Registry| replace:: MaRDA Metadata Extractors Registry
+.. |yard| replace:: datatractor yard
 
-.. _MME Registry: https://github.com/marda-alliance/metadata_extractors_registry
+.. _yard: https://github.com/datatractor/yard
 
 .. |c03a732| replace:: ``c03a732``
 
-.. _c03a732: https://github.com/marda-alliance/metadata_extractors_schema/commit/c03a732a217312398fd470f491271670c9cecb66
+.. _c03a732: https://github.com/datatractor/yard/commit/c03a732a217312398fd470f491271670c9cecb66
 
 .. |LinkML| replace:: :mod:`LinkML`
 
 .. _LinkML: https://linkml.io/linkml/
 
 .. |FileType| replace:: :class:`FileType`
 
-.. _FileType: mme_schema/FileType.html#class-filetype
+.. _FileType: datatractor_schema/FileType.html#class-filetype
 
 .. |Extractor| replace:: :class:`Extractor`
 
-.. _Extractor: mme_schema/Extractor.html#class-extractor
+.. _Extractor: datatractor_schema/Extractor.html#class-extractor
 
 .. |examples| replace:: ``examples``
 
-.. _examples: https://github.com/marda-alliance/metadata_extractors_schema/tree/main/examples
+.. _examples: https://github.com/datatractor/schema/tree/main/examples
 
 .. |netcdf| replace:: :mod:`netcdf.yml`