Skip to content

fix: content errors on the Machine actionability page - #1893

Merged
bianchini88 merged 11 commits into
elixir-europe:masterfrom
toniher:review/machine-actionability
Oct 30, 2026
Merged

bianchini88 merged 11 commits into
elixir-europe:masterfrom
toniher:review/machine-actionability

Conversation

@toniher

@toniher toniher commented Sep 29, 2026

Copy link
Copy Markdown
Contributor

This addresses #1887

  • Reword the formats to avoid: the issue is unstructured text and images without embedded metadata, not the .txt/.tiff extension (ISA-TAB, MAGE-TAB and OME-TIFF are recommended later on the page).
  • Describe XML as nested elements with attributes rather than key-value pairs.
  • Replace "web browsers understand RDF" with search engines, harvesters and linked-data applications.

- Reword the formats to avoid: the issue is unstructured text and
  images without embedded metadata, not the .txt/.tiff extension
  (ISA-TAB, MAGE-TAB and OME-TIFF are recommended later on the page).
- Describe XML as nested elements with attributes rather than
  key-value pairs.
- Replace "web browsers understand RDF" with search engines,
  harvesters and linked-data applications.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Before approving and merging a pull request (PR), the editors must check that

  • The page layout in the preview looks correct.
  • The new page is linked in the appropriate sidebar menu, in the same branch of the PR.
  • The contributors' names are listed in the CONTRIBUTORS file, in the same branch of the PR. Advice to have at least one contributor per page having its contact information in this CONTRIBUTORS file.
  • All relevant metadata fields in a specific page are correctly filled in (see the page metadata and the Editorial board guide). Some critical ones are listed below.
    • unique page_id (List of page IDs)
    • contributors
    • editors
    • related_pages (Related pages)
    • training
    • search_exclude must be deleted
    • description
    • supported_by (only used for Tool assembly pages)
    • coordinators(only used in national pages + they must be listed as contributors as well)
    • resources
  • Make sure that listed tools or resources are tagged in the text with the correct snippet + that its metadata is described in the tool_and_resource_list.yml file.
  • Check if relevant recipes on FAIR Cookbook can be linked to the RDMkit page that is being added/changed (Linking from RDMkit to FAIR Cookbook).
  • The content conforms to RDMkit's scope, style and templates.
  • There are no copyright issues related to the content of the page.
  • The contributors implemented the requested changes.
  • When a new page is added, a news item is added to the news.yml file, in the same branch of the PR.
  • The contributors are acknowledged for their efforts and informed about the publication of their content.
  • The PR is linked to related issues and can be merged into the main branch with no conflicts.

Please refer to the complete editor's checklist for details.

toniher and others added 8 commits September 30, 2026 11:07
This change improves the documentation by refactoring prose for clarity,
standardizing link text and references to the metadata management page,
updating outdated URLs to W3C and other resources, and removing redundant
explanations. The edits maintain technical accuracy while enhancing
readability and reducing verbosity throughout the page.
Reorganize the explanation to emphasize that human readability and
machine-actionability are separate properties. Simplify the initial
definition with a concrete example (scanned documents), then introduce
CSV and PDF as contrasting examples before diving into the detailed
quote from Open Data Handbook.
Replace "element" with "content" in XML tag example for accuracy, change "is" to "can be" for machine-interpretability statement, update taxonomy URL to current identifier format, and fix URL encoding in fairsharing link.
Replace space encoding in query parameter from %20 to %2520 to properly handle the URL-encoded subject filter in the fairsharing search link.
Standardize punctuation, replace modal verbs for consistency, and improve phrasing throughout the document. Changes include: adding missing period after PDF format description, replacing "Could" with "Can", simplifying negation phrasing in metadata checklist definition, removing question mark from query example, adjusting article usage before acronyms, and converting DOI reference to markdown link format.
Update file format examples to include CSV. Remove redundant text from
schema description. Replace bare ENA reference with tool link and
checklist URL. Add direct links to EFO and OBI ontologies.
@toniher
toniher marked this pull request as ready for review October 5, 2026 20:39
@toniher

toniher commented Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

@bianchini88 finished work from last week's F2F meeting

Minor grammar and style
Adding myself as an editor for this page
@bianchini88
bianchini88 merged commit e25aaac into elixir-europe:master Oct 30, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants