Support #16441

Document user merge by admin

Added by Peter Amstutz 3 months ago. Updated about 1 month ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Start date:
06/23/2020
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
-

Description

The "user merge" feature is not completely documented in the admin section. The page https://doc.arvados.org/v2.0/admin/reassign-ownership.html doesn't describe --redirect-to-new-user.

Also, the "merge" API call is completely missing from the API documentation.


Subtasks

Task #16459: Review 16441-user-merge-docResolvedPeter Amstutz

Associated revisions

Revision f95ac4c1
Added by Peter Amstutz about 1 month ago

Merge branch '16441-user-merge-doc' refs #16441

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <>

Revision 1dd02237 (diff)
Added by Ward Vandewege about 1 month ago

Fix broken link in 'Link user accounts' documentation page.

refs #16441

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <>

History

#1 Updated by Peter Amstutz 3 months ago

  • Description updated (diff)

#2 Updated by Peter Amstutz 3 months ago

  • Assigned To set to Peter Amstutz

#3 Updated by Peter Amstutz 2 months ago

  • Target version changed from 2020-06-03 Sprint to 2020-06-17 Sprint

#4 Updated by Peter Amstutz about 2 months ago

  • Target version changed from 2020-06-17 Sprint to 2020-07-01 Sprint

#5 Updated by Peter Amstutz about 2 months ago

  • Status changed from New to In Progress

#6 Updated by Peter Amstutz about 2 months ago

16441-user-merge-doc @ 3a6559843024bda72c9a7b0baed3578d8698223d

Document how to link user accounts by admin and add the method to the API docs.

#7 Updated by Lucas Di Pentima about 2 months ago

Some comments & questions:

  • File doc/admin/link-accounts.html.textile.liquid
    • Line 22: I think the word ‘by’ is missing on “…records owned the old account"
    • I think we are using zzzzz for cluster id examples on the documentation?
  • To avoid confusions, would it be best to replace “old” and “new” with “from/origin” and “to/target” or something equivalent? That would make the clarification unnecessary at the link-accounts doc page. The downside is that the API params already use “old” & “new”.
  • With that, LGTM.

#8 Updated by Peter Amstutz about 1 month ago

Lucas Di Pentima wrote:

Some comments & questions:

  • File doc/admin/link-accounts.html.textile.liquid
    • Line 22: I think the word ‘by’ is missing on “…records owned the old account"
    • I think we are using zzzzz for cluster id examples on the documentation?

Fixed.

  • To avoid confusions, would it be best to replace “old” and “new” with “from/origin” and “to/target” or something equivalent? That would make the clarification unnecessary at the link-accounts doc page. The downside is that the API params already use “old” & “new”.

The goal is to document how to use the 'arv' command correctly, which uses the terms "old" and "new" from the API. I agree it is confusing, but I don't think using different terms would allow us to avoid the clarification about the use of "old" and "new" because the admin needs to understand it well enough to construct the command line correctly.

  • With that, LGTM.

Will merge, thanks.

#9 Updated by Peter Amstutz about 1 month ago

  • Status changed from In Progress to Resolved

Also available in: Atom PDF