Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Usage of blog description metadata #214

Open
jdrueckert opened this issue Apr 30, 2023 · 2 comments
Open

Usage of blog description metadata #214

jdrueckert opened this issue Apr 30, 2023 · 2 comments
Labels
Good First Issue Good for newcomers help wanted Extra attention is needed question Further information is requested

Comments

@jdrueckert
Copy link
Member

jdrueckert commented Apr 30, 2023

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)

@jdrueckert jdrueckert added help wanted Extra attention is needed Good First Issue Good for newcomers question Further information is requested labels Apr 30, 2023
@Rukki13
Copy link
Contributor

Rukki13 commented Apr 30, 2024

the description field is still being used in blog cards as shown below:
image
So do we want to keep it or should we replace it with an excerpt from the blog's content?

@jdrueckert
Copy link
Member Author

@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 description variable in ModuleCard.jsx that you referenced in your VS Code screenshot actually is provided as a parameter when "calling" the ModuleCard function in ModuleListing.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 PostListing which calls the Cards function. The preview text you see in your website screenshot is actually the excerpt. The excerpt is fetched by the graphql query as the first 120 characters of a blog post in BlogList.jsx.

This issue is about figuring out, whether the description field of the blog metadata is still used anywhere in the code base exactly because we don't use it anymore for the preview cards.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue Good for newcomers help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants