archesproject / arches-docs

official repo for Arches documentation
https://arches.readthedocs.io
9 stars 21 forks source link

Document upload format for concepts, collections #10

Open mradamcox opened 6 years ago

mradamcox commented 6 years ago

From @mradamcox on June 15, 2017 17:3

User Story

As a user, I should be able to find a description of how these files are structured. This is the first step toward allowing people to programmatically create v4 reference data upload files from existing csv or other spreadsheet files.

Copied from original issue: archesproject/arches#2151

mradamcox commented 6 years ago

Content from @apeters that relates to this issue:

Let's say I have this ConceptScheme

   MyConceptScheme
    /           \
Concept1        Concept2

I send this to you and you add it to your system (it didn't exist before) and you add a concept

   MyConceptScheme
    /           \
Concept1        Concept2
   /
Concept3

Then you send it back to me and I import the updated Schema into my system

I can then do several things:

1. I can overwrite/ignore and stage: Concept1 and Concept2 from the file overwrites Concept1 and Concept2 in my system (or if ignore then Concept1 and Concept2 from my system remain unchanged) and Concept3 is put in the Candidate Schema (making it a child of that Schema)

   MyConceptScheme          
    /           \
Concept1        Concept2

     Candiates
         |
      Concept3

In this scenario we lose the fact that Concept3 was a child of Concept1 (unless we want to maintain both relationships, as in below)

   MyConceptScheme          
    /           \
Concept1        Concept2
 |
 |
 |  Candiates
 |   |
Concept

2. I can overwrite/ignore and NOT stage: Concept1 and Concept2 from the file overwrites Concept1 and Concept2 in my system (or if ignore then Concept1 and Concept2 from my system remain unchanged) and Concept3 gets added into my system as a child of Concept1

   MyConceptScheme
    /           \
Concept1        Concept2
   /
Concept3
mradamcox commented 6 years ago

@beatboxchad To close out this ticket, and not lose the information from @apeters above, I think we should add a "Sharing Concept Schemes" (or something along those lines) which would sit at the same level as the "Getting Started" header under the RDM > Concept Schemes header. The content would come from the comments above, and the steps described would be tested, at least in a cursory fashion. Let me know if you have other ideas... I just want to make sure that the information above doesn't get lost in a closed ticket.