Skip to content

Commit ea9622a

Browse files
committed
Improve Crosswalk page introduction and contribution instructions
1 parent 83ebdcf commit ea9622a

File tree

2 files changed

+253
-4
lines changed

2 files changed

+253
-4
lines changed

content/crosswalk/_index.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,35 @@
11
---
22
title: "Crosswalks"
3-
#layout: single
3+
layout: list
44
---
55

6-
The CodeMeta crosswalk provides an explicit map between the metadata fields used by a broad range of software repositories, registries and archives. Here are the currently available mappings from existing standards into CodeMeta properties. Mapping onto a common set of properties should facilitate translation between any two crosswalked standards. The full crosswalk table is [available as a `.csv`](https://github.com/codemeta/codemeta/tree/master/crosswalk.csv) file on the CodeMeta repository.
6+
CodeMeta Crosswalks provide an explicit map between the fields of existing
7+
metadata standards, as used by a broad range of software repositories,
8+
registries, and archives. When mapped by a Crosswalk, CodeMeta's terms act as
9+
a common set of properties, providing a pathway for metadata to be translated
10+
between standards.
711

8-
## Contribute!
12+
Crosswalks are not required to have a one-to-one mapping for every field.
13+
Because Crosswalks only map fields common between a standard and CodeMeta, the
14+
subset of common fields may differ a lot between Crosswalks. The diagram below
15+
demonstrates how CodeMeta maps between standards when there are differences.
916

10-
CodeMeta encourages submissions of additional vocabularies by making Pull Requests against the [full crosswalk table](https://github.com/codemeta/codemeta/tree/master/crosswalk.csv). Feel free to propose corrections or extensions in the [CodeMeta issues tracker](https://github.com/codemeta/codemeta/issues).
17+
![Diagram of CodeMeta mapping between two metadata standards. It shows a common term, terms unique to each standard, and terms common to only CodeMeta and each standard.](/img/crosswalkdiagram.svg)
18+
19+
### Contribute!
20+
21+
CodeMeta encourages submissions of additional vocabularies. Refer to the
22+
[CodeMeta repository contribution guide](https://github.com/codemeta/codemeta?tab=contributing-ov-file#contributing-a-new-mapping)
23+
to submit a new Crosswalks.
24+
25+
Crosswalks are not automatically listed on this website.
26+
[The guide for contributing to this website](https://github.com/codemeta/codemeta.github.io?tab=contributing-ov-file#adding-new-crosswalks)
27+
explains how to set that up.
28+
29+
Please feel welcome to propose corrections or extensions in the [CodeMeta issues tracker](https://github.com/codemeta/codemeta/issues).
30+
31+
## Crosswalk directory
32+
33+
This directory contains many of the available Crosswalks. The full Crosswalk table is
34+
[available as a `.csv`](https://github.com/codemeta/codemeta/tree/master/crosswalk.csv)
35+
file in the CodeMeta repository.

static/img/crosswalkdiagram.svg

Lines changed: 224 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)