Replace Dataset with Entity List #1651
Conversation
lognaturel
force-pushed
the
entity-lists
branch
4 times, most recently
from
adea287
to
8633576
Compare
|
|
||
| Add a new ``entities`` sheet to your XLSForm. This is where you will specify your Dataset’s name, under ``dataset``. | ||
| Add a new ``entities`` sheet to your XLSForm. This is where you will specify your Entity List name, under ``list_name``. |
There was a problem hiding this comment.
@ktuite I'm specifically interested in your thoughts on list_name since you've made educational materials for all this. Do you think it's helpful or harmful that it's the same as the column header to specify the list that a choice is in from the choices sheet?
I thought it was helpful but I'm questioning that a little bit because the usage is different. On the choices tab, we're explicitly stating the list that a concrete item belongs in. Here, we're generally declaring the list that abstract entities will be created in. Maybe that's similar enough?
We could consider list though that might be even more confusing. We could also try something different like destination or target_list. @yanokwa did not like any of those when I ran them by him.
I still like list_name the best but I do want to get at least another sanity check now that I've had these thoughts.
There was a problem hiding this comment.
i think list_name is okay. the entities tab has such a different purpose and shape than the choices tab that i think it's ok for the column header to be the same but have slightly different meanings within the different context. this happens with label, too. having some other word that is slightly different yet also isn't a perfect fit seems like it would be more confusing
Yes and I just reopened the corresponding issue. Realized that as I worked on these docs yesterday. |
There was a problem hiding this comment.
I'm liking this dataset -> "entity list" change more and more because now I can tell that pre-entity-era "datasets", like "form datasets" are different.
In central-intro.rst, should this line be updated or clarified?
* Server-managed datasets for registration/follow-up workflows"
Maybe "server-managed datasets (entity lists)..."?
| @@ -65,67 +75,64 @@ In this Quick Start, you will upload two Forms we have already authored for you: | |||
| First, let's prepare the Forms for use with Central. | |||
|
|
|||
| 1. Create a new Project, if you can. It can be easier to see what's going on without other Forms in the way. | |||
| 2. Upload the `Tree registration Form <https://docs.google.com/spreadsheets/d/1xboXBJhIUlhs0wlblCxcQ3DB5Ubpx2AxLDuaXh_JYyw/edit#gid=2050654322>`_. Notice how it has seen from the Form definition that the Form creates Entities in a Dataset, and populates three Entity Properties. | |||
| 3. Publish the Form. As the dialog says, this action creates the ``trees`` Dataset within the Project you created. | |||
| 2. Upload the `Tree registration Form <https://docs.google.com/spreadsheets/d/1xboXBJhIUlhs0wlblCxcQ3DB5Ubpx2AxLDuaXh_JYyw/edit#gid=2050654322>`_. Notice how Central knows from the Form definition that the Form creates Entities in an Entity List, and populates three Entity Properties. | |||
There was a problem hiding this comment.
We should update "dataset" --> "list_name" in this demo form.
There was a problem hiding this comment.
Yes, yes, thank you! I'll set myself a reminder to do that when we merge.
Good catch! Fixed. |
lognaturel
force-pushed
the
entity-lists
branch
from
d4ae5af
to
7e27c15
Compare
Do not merge until Central v2023.4 and pyxform 12.1.2 are released!
Closes getodk/central#466
I made a few cosmetic changes as I went, I don't think any should be controversial! @matthew-white and @ktuite, I'll let you two decide who most wants to review this. @ktuite at some point we should talk about whether we should consider updating your video. It's still very relevant! But the change in terminology is a bit distracting.