CorrelAid / CorrelAid/cdl-wp-eins

Retarget the survey2ddi references: conversion is formtransform now

Open
#26 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Part of the survey2ddi retirement. Plan: HANDOVER_SURVEY2DDI.md in the formtransform repo. Do this last, once CorrelAid/survey2ddi#5 and #6 have landed — the site should not announce a change before it is true.

What changed upstream

survey2ddi is no longer the CDL's survey converter. @correlaid/formtransform does every conversion (XLSForm → LimeSurvey TSV / DDI, LimeSurvey TSV → DDI / XLSForm, plus the response-data CSV) and the app is its browser front end. survey2ddi shrinks to the analysis-side DDI reader — reading a codebook back to label a dataframe.

Files naming survey2ddi as the converter

File What it says
src/content/snippets/survey2ddi/en.html "survey2ddi is an Python package for processing survey data and converting it to the DDI Codebook format"
src/content/snippets/survey2ddi/de.html same, German
src/lib/toc.json:66 tool entry, "type": "package", "phases": [3]
src/pages/workflow.astro:86,103 two table rows crediting survey2ddi with the conversion
src/lib/components/EcosystemFlowchart.astro:44,47 "Aus XLSForm + KoboToolbox CSV mit survey2ddi" and the LimeSurvey equivalent
src/content/pages/umfragetool-einladung.mdx mentions survey2ddi
src/content/pages/kobotoolbox.mdx mentions survey2ddi
src/content/pages/nachnutzbarkeit.mdx mentions survey2ddi

Do

  • Point every conversion claim at formtransform or the app.
  • Keep survey2ddi in the ecosystem picture, re-scoped to the analysis/reader role — it is still a published package with a real job, so deleting it from the flowchart would be wrong. Its phase in toc.json may need to move accordingly.
  • Both language snippets stay in sync; the German flowchart labels are user-visible strings, not identifiers.
  • Same pattern as the app's scope notice, #25.

Acceptance criteria

  • No page credits survey2ddi with converting anything
  • survey2ddi still appears, described as the DDI reader
  • de/en snippets consistent
  • Flowchart and workflow table agree with each other and with the tools page
  • Site builds

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with HANDOVER_SURVEY2DDI.md and confirm issues #5 and #6 have landed before editing the listed snippets, toc.json, workflow.astro, EcosystemFlowchart.astro, and content pages. Compare the German and English wording, then run the site build; done means the acceptance criteria pass and survey2ddi remains represented only as the DDI reader.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.