Improve section on changing form structure

Open
#1,990 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start with the linked forum conversation to understand the backend consequences of changing ODK Collect forms, then locate the existing documentation section covering form changes. Done means clearly explaining field renames and group/repeat structure changes, potentially in an FAQ format.

Written by the indexing model from the issue text.

Description

Form design

Some good ideas from this conversation: https://forum.getodk.org/t/backend-consequences-of-modifying-odk-collect-forms/56772

  • Explicitly say that renaming a field is like deleting it and adding a new one
  • Be explicit about changing group/repeat structure

Could be structured as a FAQ?

Dominant language
Python
Stars
58
Forks
161
Avg merge
20h 51m
Merged PRs (30d)
2

Getting set up

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.

More from getodk/docs

All issues in getodk/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.