[MGNLCT-169] DOC: Document that contenttype names should be singular Created: 06/Jan/21  Updated: 28/May/21  Resolved: 28/May/21

Status: Closed
Project: Content Types
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Problem/Incident
causes MGNLCT-171 CT-based apps' names way too related ... Open
causes NPMCLI-260 mgnl create-app command must create f... Selected
Relates
relates to MGNLGQL-70 DOC: Finalize GraphQL doc set for mod... Closed
relation
is related to MGNLGQL-68 Good query names for plural contentty... Open
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Documentation update required:
Yes
Epic Link: GraphQL Phase 1
Sprint: HL & LD 29
Story Points: 1

 Description   

We should recommend this as a best practice in the contenttype documentation and use it in the demos. It should be explicitly stated in the content types documentation.

It has implications for GraphQL and could have other implications in the future.

Example - content type should be called "book" not "books", or ct should be called "auhor" not "authors".

This tutorial and demonsgtration project should be updated to reflect this: https://docs.magnolia-cms.com/product-docs/Apps/My-first-content-app.html

 

 

Full best practice:

Name contenttyupe singular. Name app plural with "-app" suffix. Name workspace plural.

Example:

contentType name: book

app name: books-app

workspace name: books

 


Generated at Mon Feb 12 00:37:49 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.