Skip to content

Commit

Permalink
Minor text changes to CONTRIBUTING.md and website.
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterKraus committed May 16, 2024
1 parent 1183da8 commit 432c3c8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center" style="padding-bottom: 1em;">
<img width="100px" align="center" src="https://avatars.githubusercontent.com/u/74017645?s=200&v=4">
<img width="100px" align="center" src="https://avatars.githubusercontent.com/u/166528759">
</div>

# <div align="center">Datatractor Yard</div>
Expand All @@ -13,10 +13,10 @@ An example of the process can be seen in this [pull request](https://github.com/


### Opening a pull request
- One pull request (PR) per `Extractor`, please.
- One pull request (PR) per `Extractor` package, please.
- You can include multiple versions of one `Extractor` in separate `.yml` files.
- Do not include multiple unrelated `Extractors` in a single PR.
- Include any missing `FileTypes` supported by the `Extractor` in the same PR.
- Feel free to include any missing `FileTypes` supported by the `Extractor` in the same PR.
- Please add the appropriate labels (`Extractor` and `FileType`).

### Example files
Expand Down
4 changes: 2 additions & 2 deletions yard/templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<div class="header">

<a href="https://marda-alliance.org"><img class="logo" src="https://avatars.githubusercontent.com/u/166528759" alt="datatractor" height="80"></a>
<a href="https://yard.datatractor.org"><img class="logo" src="https://avatars.githubusercontent.com/u/166528759" alt="datatractor" height="80"></a>
<div class="navbar">
<ul>
<li><a href="{{ url_for('get_index_html') }}">About</a></li>
Expand All @@ -27,7 +27,7 @@
<div class="navbar" style="margin-left: auto !important; margin-right: auto !important;">
<ul>
<li><a href="{{ url_for('get_info') }}">{} JSON API</a></li>
<li><a href="https://github.com/marda-alliance/metadata_extractors"><i class="fa fa-github"></i> GitHub</a></li>
<li><a href="https://github.com/datatractor/yard"><i class="fa fa-github"></i> GitHub</a></li>
</ul>
</div>

Expand Down
6 changes: 4 additions & 2 deletions yard/templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,22 @@
{% block title %}About{% endblock %}
{% block content %}

<h2>Welcome to the Datatractor Yard</h2>

<p>The idea of this site is to collect various file formats used in materials science and chemistry, describe them with metadata, and provide links to software projects that can parse them.</p>
<p>By providing this data in a web API, it hoped that users can discover new extractors more easily and metadata standards can be developed for the output of extractors to enable schemas to proliferate throughout the field.</p>

<p>This <a href="https://github.com/datatractor/yard"><i class="fa fa-github"></i> registry</a> uses the Datatractor <a href="https://datatractor.github.io/schema">Schemas</a> (<a href="https://github.com/datatractor/schema"><i class="fa fa-github"></i> repository</a>) and enables programmatic use and discovery of extractors, as shown in our <a href="https://github.com/datatractor/beam"><i class="fa fa-github"></i> reference implementation</a>.</p>

<p>By providing this data in a web API, we hope that users can discover new extractors more easily, and that metadata standards will be developed describing the output of extractors, enabling schemas to proliferate throughout the field.</p>

<p>The proof-of-concept of this project was devised as part of the <a href="https://www.marda-alliance.org/working-groups">MaRDA</a> Metadata Extractors Working Group, and is continued as the Datatractor project. Further discussions and instructions for how to get involved can be found at the <a href="https://github.com/orgs/datatractor/discussions"><i class="fa fa-github"></i> Datatractor discussions page</a>.</p>

<p>The registry and the data within it is available under the terms of the <a href="https://github.com/datatractor/yard/blob/main/LICENSE">MIT license</a>.</p>

<h2>Contributing</h2>

<p>Anyone can contribute file type and extractor entries to this registry by following the instructions in the <a href="https://github.com/datatractor/yard/blob/main/CONTRIBUTING.md">contributing guidelines on <i class="fa fa-github"></i> GitHub</a>.</p>
<p>After submitting a pull request, this data will be validated and added to the deployed database once it is merged.</p>
<p>After submitting a pull request, your contributions will be reviewed and validated. The entries are listed in this registry once your pull request is merged and deployed.</p>


{% endblock %}

0 comments on commit 432c3c8

Please sign in to comment.