Language improvements#520
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refines wording and formatting across several documentation pages related to metadata, data publication, and data organization/storage.
Changes:
- Rephrases and streamlines explanatory text across multiple docs pages.
- Normalizes list formatting and improves clarity of several passages.
- Updates/introduces internal cross-links (some currently point to non-existent pages).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 18 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/60_topics/63_data_description_annotation/10_metadata.mdx | Wording improvements and list formatting for metadata/MI sections; introduces new internal link(s). |
| docs/50_data_publication/10_repositories.mdx | Wording refinements for repository concepts and sources list; introduces a provenance link. |
| docs/50_data_publication/00_data_publishing.mdx | Restructures the motivation paragraph and terminology; adds provenance/data-format links. |
| docs/30_data/50_data_storage.mdx | Minor wording and punctuation improvements for storage guidance. |
| docs/30_data/40_data_documentation.mdx | Rephrases key guidance bullets; adds data-format link. |
| docs/30_data/30_data_organisation.mdx | List formatting updates, adds a rename tool, adds code fences around an example, and adjusts data-format link wording. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| More specific examples could be the title, keywords, acquisition method with a certain analytical technique, and the list continues. Metadata should be supported by controlled vocabularies (ideally [ontologies](/docs/ontology)), and/or [data formats](/docs/data_formats). | ||
|
|
||
| Metadata gets more specialized as the domain it describes does, where the hierarchy of domains can correspond to a hierarchical metadata structure, enabling layers of multiple standards from more generic metadata, where it is completely domain-independent, moving to more specific ones. | ||
| Metadata gets more specialized as the domain it describes does, where the hierarchy of domains can correspond to a hierarchical metadata structure: from more generic, completely domain-independent metadata layer, to the most method- and application-specific ones. |
| - [Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH)](http://www.openarchives.org/OAI/openarchivesprotocol.html) is a framework for harvesting metadata and can be applied to a wide variety of metadata formats. These should always include Dublin Core metadata. | ||
| * [Dublin Core](https://www.dublincore.org/specifications/dublin-core/dces/) is a more general set of fifteen elements describing networked resources. This set has been adapted and extended by other standards since its first publication in 1995. | ||
| * [DataCite](https://datacite.org/) is a DOI provider that provides a [schema](https://schema.datacite.org/) of core metadata for research data. The standard is community driven and tries to integrate with other standards such as Dublin Core and [ORCID Record Schema](https://info.orcid.org/documentation/integration-guide/orcid-record/). | ||
| * The [OpenAIRE Guidelines for Data Archive Managers](https://guidelines.openaire.eu/en/latest/) provide an infrastructure which facilitates interoperability between repositories adhering to those guidelines, which enhance data exposure and visibility. OpenAIRE has already adopted the DataCite [schema](https://schema.datacite.org/) but with some minor adjustments, such as accepting other persistent identifier schemes rather than the DOI, and some changes in the obligations of properties. |
| * The [Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH)](http://www.openarchives.org/OAI/openarchivesprotocol.html) is a framework for harvesting metadata and can be applied to a wide variety of metadata formats. These should always include Dublin Core metadata. | ||
|
|
||
| ### Domain-Specific Metadata: | ||
| Metadata can be domain-specific, i.e. related to a specific acquisition method with a certain analytical technique (such as a pH measurement in the context of a certain reaction), which doesn’t apply to most other domains rather than chemistry. |
| Minimum information standards (MI) are guidelines regarding which metadata is required when reporting data. Furthermore, these guidelines outline which format should be used for both this information as well as for the data itself. The set of MI depends on the type of data and is established to ensure that data are deposited following the FAIR principles. Therefore, minimum information is a subset of rich metadata which can accompany data. | ||
|
|
||
| ### Minimum Information for Chemical Investigations (MIChI) | ||
| Due to the increasing amount of data produced by biology and related disciplines, such as omics, bioinformatics and biochemistry, a large set of [minimum information guidelines](https://fairsharing.org/search/?q=minimum+information) for different methods has been developed. These were promoted by the [Minimum Information for Biological and Biomedical Investigations (MIBBI)](https://doi.org/10.1038/nbt.1411) project. |
| - Establish supporting technology: Evaluate and test software like [ELN](/docs/eln/) and [Repositories](/docs/repositories/), train staff. | ||
| - Obtain legal advice, include local and higher-level policies and procedures: Contact legal department at your institution or [NFDI Querschnittssektion “Ethik und Recht”](https://www.nfdi.de/einrichtung-von-ersten-sektionen/) | ||
| - Define internal rules and processes: What are the targets of RDM, and how can they be achieved? | ||
| - Apply and evaluate iteratively rules: Learn, set, follow, repeat. Keep it simple and smart (KISS). |
| - Apply and evaluate iteratively rules: Learn, set, follow, repeat. Keep it simple and smart (KISS). | ||
| - Develop suitable technology: Determine specific requirements in the first project phase and adapt them continuously to changing conditions. | ||
| - Establish supporting technology: Evaluate and test software like [ELN](/docs/eln/) and [Repositories](/docs/repositories/); train your staff. | ||
| - Obtain legal advice, considering local and higher-level policies and procedures: Contact legal department at your institution or [NFDI Querschnittssektion “Ethik und Recht”](https://www.nfdi.de/einrichtung-von-ersten-sektionen/) |
| - **type of data:** RAW = raw data from measuring device | ||
| - **number of file:** containing data for that measurement series | ||
|
|
||
| If you need to rename a multiple files, take a look at: |
| - [command line: mv, mmv, rename](https://linuxconfig.org/how-to-rename-multiple-files-on-linux) (Linux, CLI) | ||
| - [Bulk Rename Utility](https://www.bulkrenameutility.co.uk/) (Windows, free) | ||
| - [A.F.5 Rename your files](http://fauland.com/download.htm) (Windows, free) | ||
| - [TotalCommander](https://www.ghisler.com/advanced.htm#tutorial_rename) (windows, Shareware) |
Comment on lines
+88
to
+92
| An FDO encapsulates data and metadata in one file and can be saved as an [HDF5](https://www.hdfgroup.org/solutions/hdf5/), for example. See [Data Format Standards](/docs/format_standards/) for more information. | ||
|
|
||
| ## Files: formats | ||
|
|
||
| Different disciplines use established standards, see [Data Format Standard](/docs/data_formats/). Also consider beyond the duration of the project: | ||
| Different disciplines use established standards, see [Data Format Standards](/docs/format_standards/). Also consider beyond the duration of the project: |
jliermann
added a commit
that referenced
this pull request
Jun 19, 2026
…mmatical-issues fix: misc. typos and grammatical issues (PR #520 review)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.