Add a notes field to ImageWithDescription

[TheConcierge]

@daseinkapital original comment

Notes distinct from description because description might be like "This utility pole has large holes in it that stop 2/3rds of the way up" but the note might be like "This is only found in the south of argentina"

so like the description tells you what you're specifically looking for (so you're not just like look at this utility pole and guess what makes it different) but then the note (which is highly optional) might actually tell you how common they are

[TheConcierge]

@daseinkapital original comment

Notes distinct from description because description might be like "This utility pole has large holes in it that stop 2/3rds of the way up" but the note might be like "This is only found in the south of argentina"

so like the description tells you what you're specifically looking for (so you're not just like look at this utility pole and guess what makes it different) but then the note (which is highly optional) might actually tell you how common they are

I think this makes sense. I'd be almost tempted to make the notes field something like "Significance" where you can list out reasons why it's significant? Notes feels a little too broad if it's specifically going to be used in this context. And, while we are at it, do you think a single string field is enough for description? or should we make that a list of strings as well?

[TheConcierge]

@daseinkapital original comment Notes distinct from description because description might be like "This utility pole has large holes in it that stop 2/3rds of the way up" but the note might be like "This is only found in the south of argentina" so like the description tells you what you're specifically looking for (so you're not just like look at this utility pole and guess what makes it different) but then the note (which is highly optional) might actually tell you how common they are

I think this makes sense. I'd be almost tempted to make the notes field something like "Significance" where you can list out reasons why it's significant? Notes feels a little too broad if it's specifically going to be used in this context. And, while we are at it, do you think a single string field is enough for description? or should we make that a list of strings as well?

Writing other comments, I'm also realizing that we are using description in the place of a notes field in a lot of other places. If we are changing the expectation here, we need to make sure we do it uniformly across the board.

[daseinkapital]

@daseinkapital original comment Notes distinct from description because description might be like "This utility pole has large holes in it that stop 2/3rds of the way up" but the note might be like "This is only found in the south of argentina" so like the description tells you what you're specifically looking for (so you're not just like look at this utility pole and guess what makes it different) but then the note (which is highly optional) might actually tell you how common they are

I think this makes sense. I'd be almost tempted to make the notes field something like "Significance" where you can list out reasons why it's significant? Notes feels a little too broad if it's specifically going to be used in this context. And, while we are at it, do you think a single string field is enough for description? or should we make that a list of strings as well?

Writing other comments, I'm also realizing that we are using description in the place of a notes field in a lot of other places. If we are changing the expectation here, we need to make sure we do it uniformly across the board.

I'm down with making it more explicit with "Significance" or "Meta", but I would agree notes vs description are very similar. Maybe we remove the term "notes" across the board because it is very broad.

[TheConcierge]

I had Notes at the top level just so there's a place to put extraneous information that doesn't really fit neatly into any category. We can remove it if you want

[TheConcierge]

I had Notes at the top level just so there's a place to put extraneous information that doesn't really fit neatly into any category. We can remove it if you want

If we want to keep this type of information, i could rename is "extra info" or something like that? I agree that Notes in general is probably too broad

[TheConcierge]

In regards to the ImageWithDescription (thinking about renaming this Tip on the backend, won't impact front end):

we could keep description as a "what does this thing look like"

and then significance could be "where is this thing, why do you care, etc"?

Or do you think we can merge all of that into one list of strings? probably depends whether or not you plan on representing description and significance separately in the UI.

[daseinkapital]

I'm fine with that specific notes staying because it is more of a textual catch all (although I do feel that some of the current notes we have for Argentina could be turned into ImageWithDescription and classified somewhere)

[daseinkapital]

Hmmm uncertain. I'd say leave them separate so there's an option to separate them because it really shouldn't be more than a short sentence for each of them and I think it's a little deceptive in nature to say it's a list when you know the list should only be one or two lines long.

[TheConcierge]

I'm fine with that specific notes staying because it is more of a textual catch all (although I do feel that some of the current notes we have for Argentina could be turned into ImageWithDescription and classified somewhere) … On Wed, Sep 28, 2022, 10:04 PM Ryan Grant @.> wrote: I had Notes at the top level just so there's a place to put extraneous information that doesn't really fit neatly into any category. We can remove it if you want — Reply to this email directly, view it on GitHub <#3 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADXGV33KSMI2K5VYXXZMYZTWAT2LLANCNFSM6AAAAAAQXGXKVA . You are receiving this because you were mentioned.Message ID: @.>

possibly. I was just pulling off how the reference reddit post was organized. Ok i'll leave it for now and if we decide later we don't need it we just yeet it

[TheConcierge]

Hmmm uncertain. I'd say leave them separate so there's an option to separate them because it really shouldn't be more than a short sentence for each of them and I think it's a little deceptive in nature to say it's a list when you know the list should only be one or two lines long. -- Andrew Samuelson Virginia Tech Class of 2018 | Industrial & Systems Engineering - Statistics Minor Institute of Industrial and Systems Engineers Virginia Tech Student Chapter (VT IISE) | Treasurer Cell: 571-214-7755 | Email: @. … On Wed, Sep 28, 2022 at 10:10 PM Ryan Grant @.> wrote: In regards to the ImageWithDescription (thinking about renaming this Tip on the backend, won't impact front end): we could keep description as a "what does this thing look like" and then significance could be "where is this thing, why do you care, etc"? Or do you think we can merge all of that into one list of strings? probably depends whether or not you plan on representing description and significance separately in the UI. — Reply to this email directly, view it on GitHub <#3 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADXGV3474JMHT4JZXXIE4TDWAT3ADANCNFSM6AAAAAAQXGXKVA . You are receiving this because you were mentioned.Message ID: @.***>

Actually, thinking about it, i do still think we need some sort of identifier, almost like a dedicated title field. In the maps one, I realized we probably want to title each city map (or whatever map) so we can specifically display that as a title. I was kind of overloading description as a thing that could be a title and could also be a description.

Hm, let me whip something up and I'll have you look at it.

[daseinkapital]

As per meeting discussion:

Changed ImageWithDescription to Hint with optional ImageUrl Added RegionSpecificity to Hint Added CountrySpecificity to Hint Added Frequency to Hint Added Identifier to Hint Nixed notes idea Added Significance