Title: Concept: Content Entities
Section: Planning your Site
File name: planning-data-types.txt
Covers: Concept: Types of Data. Explain that there are several "entities" that can store content, and there is some overlap. Explain that they all can have fields and most can have "sub-types" Make a table of the various entities, what they are best used for, and what their subtypes are called. Include: Content items (used for things that should be the main content on a page), Custom blocks, Taxonomy terms, User profiles, Comments (which can be attached to any entity, not just content items).

Attribution

See https://userguide-drupal.redesign.devdrupal.org/guidelines/guidelines.ht...

Written by https://www.drupal.org/u/jhodgdon[Jennifer Hodgdon].

Checklist for this phase

- Does it follow the template?
- Have the comments and placeholder text been removed from the template?
- Is everything the topic was supposed to cover included, and nothing extra?
- If there are @todo notes, are they clear?
- If there are images included, do they include instructions for how to redo them in a comment? (Note: Screenshots do not need to be perfect. Just make a rough cut.)
- Is attribution provided?

CommentFileSizeAuthor
#5 planning-data-types.txt3.39 KBjhodgdon
#3 planning-data-types.txt1.98 KBjhodgdon
#2 planning-data-types.txt1.96 KBjhodgdon
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Assigned: Unassigned » jhodgdon
Issue summary: View changes

As per discussion in #2541714: Write structure-taxonomy.txt, we are changing the title of this topic. Also I will write it.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Issue summary: View changes
Status: Active » Needs review
FileSize
planning-data-types.txt1.96 KB

Here's a first pass at least! Note: I could have put in *lots* of other Related Topics... settled on just a few as at least entry points to the other sections of the Guide that concern specific entity types, as well as the planning content strategy topic (yet to be written).

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
FileSize
planning-data-types.txt1.98 KB

Realized it should have an index entry for Fields also.

eojthebrave’s picture

eojthebrave
he/him
Primary language English
Location Minneapolis, MN
CreditAttribution: eojthebrave at Lullabot, Drupalize.Me commented

Thanks for taking this one on Jennifer. I have a suspicion this is going to end up being one of most complicated bits of this guide to get right.

An _entity_ is an item of either content data or configuration data, although in
common usage, it often just refers to content data items (this topic is only
concerned with content entities). You can create and edit entity items from the
user interface on your site; they are intended to be displayed to site
visitors.

This part seems like it might be un-necessary, or should at least come later on. This doesn't really help me understand what a content entity is. Maybe something like "A _content entity_ is one instance of a particular _entity type_ such as a comment or user profile or an _entity sub-type_ such as a blog post, article or product. Each individual page on your site is a _content entity_ ..."

Or maybe to use something more tangible than "content data items", which is really just as nebulous as the term entities.

I think this text would benefit greatly from a use-case or example that explains why I would want to use a sub-type, perhaps taken from the farmers market scenario. I'm really struggling to relate this back to concepts I already understand, or really to understand the "why" part of content entities.

Should we add files to the table listing various types of content entities? I'm not really sure that it's necessary in order to illustrate what a content entity is. But it might help with the idea that user generated content in any form is almost always an "entity".

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
FileSize
planning-data-types.txt3.39 KB

Thanks! Those are all good comments/suggestions. How's this version?

eojthebrave’s picture

eojthebrave
he/him
Primary language English
Location Minneapolis, MN
CreditAttribution: eojthebrave at Lullabot, Drupalize.Me commented
Assigned: jhodgdon » Unassigned
Status: Needs review » Fixed

YES! This version is much clearer. I was having a bit of trouble figuring out why the earlier one didn't resonate, but you totally nailed it with this one. Thanks.

- Does it follow the template?

Yes.

- Have the comments and placeholder text been removed from the template?

Yes.

- Is everything the topic was supposed to cover included, and nothing extra?

Yes.

- If there are @todo notes, are they clear?

n/a

- If there are images included, do they include instructions for how to redo them in a comment? (Note: Screenshots do not need to be perfect. Just make a rough cut.)

n.a

- Is attribution provided?

Yes.

This passes the review checklist for this phase so I've gone ahead and added it to the guide. Thanks again.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

In writing the "Planning the content structure" topic, I realized I left out Contact forms, which are technically also a content entity type. I'll take care of that on the other issue though.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.