Repository navigation
Usage of blog description metadata #214
Description
Task
We need to assess, whether we still use the description field provided in the blog post metadata for anything. We believe it was originally intended to be used for preview on the blog cards or social media links, but that probably was replaced by simply using an excerpt from the blog post content.
Once we know whether or not it is still being used, we can decide to
(A) remove the field from the blog post metadata )provided it's not used anymore anywhere and we don't want to re-introduce it)
(B) document what the field is used for in the blog post author documentation (provided we want to keep that usage)
(C) replace any usages and remove the field (provided it's still used and we don't want to keep it)
(D) reintroduce using the field for some purpose (provided it's not used anymore anywhere but we want to make use of it again)
Activity
Rukki13 commentedon Apr 30, 2024
the description field is still being used in blog cards as shown below:
So do we want to keep it or should we replace it with an excerpt from the blog's content?
jdrueckert commentedon May 2, 2024
@Rukki13 I think there's a misconception between modules and blog posts and the underlying components used as well as where the information is coming from.
The
descriptionvariable inModuleCard.jsxthat you referenced in your VS Code screenshot actually is provided as a parameter when "calling" theModuleCardfunction inModuleListing.jsx. Module listings and cards are not used for blog posts, but only for modules, e.g. see https://terasology.org/modules/a/.The website and blog metadata screenshots you used are independent of modules. For blog posts, we use
PostListingwhich calls theCardsfunction. The preview text you see in your website screenshot is actually theexcerpt. Theexcerptis fetched by the graphql query as the first 120 characters of a blog post inBlogList.jsx.This issue is about figuring out, whether the
descriptionfield of the blog metadata is still used anywhere in the code base exactly because we don't use it anymore for the preview cards.