Skip to content

Commit 1899d7f

Browse files
committed
docs(user-sync): document prune and opt-in extras
1 parent 4e38b29 commit 1899d7f

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

‎docs/tools/user-sync.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ only core identity plus email.
3939
| `--with-websites` | Also store ORCID researcher URLs (opt-in). |
4040
| `--with-organizations` | Also create and link Organization items from ORCID affiliations (opt-in). |
4141
| `--with-extras` | Enable both websites and organizations. |
42+
| `--prune` | Remove disabled optional fields and `employment_contract_status` from existing items (default off; a normal run only adds). |
4243

4344
## What it does
4445

@@ -50,8 +51,9 @@ only core identity plus email.
5051
3. Map each account to a proposed `User` item with a deterministic id
5152
(uuid5 on the ORCID iD, else the username), so re-runs are idempotent.
5253
4. Reconcile against existing items by `username` into NEW, GAP_FILL, CONFLICT,
53-
REMOVE or UNCHANGED, then preview; gap-fills and removals apply
54-
automatically, conflicts are resolved interactively.
54+
REMOVE or UNCHANGED, then preview; gap-fills apply automatically and conflicts
55+
are resolved interactively. Removals only appear with `--prune`; a normal run
56+
never removes anything.
5557
5. Store items, create `User:<username>` redirects to each item, ensure any
5658
linked Organization items, verify by reloading, and warn about users with no
5759
email.
@@ -62,9 +64,9 @@ only core identity plus email.
6264
| --- | --- |
6365
| `username`, `first_name`, `surname`, `label`, `orcid` | Always (core identity). |
6466
| `email` | Standard: always attempted; missing email is warned, not fatal; never removed. |
65-
| `website` | Opt-in (`--with-websites`); removed from existing items when disabled. |
66-
| `organization` | Opt-in (`--with-organizations`); removed from existing items when disabled. |
67-
| `employment_contract_status` | Never written; removed from existing items (data protection). |
67+
| `website` | Opt-in (`--with-websites`); removed from existing only with `--prune`. |
68+
| `organization` | Opt-in (`--with-organizations`); removed from existing only with `--prune`. |
69+
| `employment_contract_status` | Never written; removed from existing only with `--prune`. |
6870

6971
## Notes
7072

0 commit comments

Comments
 (0)