Usage of blog description metadata

Open
#214 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale

Research direction

Search the repository for the blog post metadata description field and inspect every reported usage, including blog cards, social links, excerpts, and blog post author documentation. The work is done when all usages are identified and the issue has a supported decision to remove, document, replace, or reintroduce the field.

Written by the indexing model from the issue text.

Description

Good First Issue help wanted question

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)

Dominant language
JavaScript
Stars
7
Forks
17
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MovingBlocks/movingblocks.github.com

All issues in MovingBlocks/movingblocks.github.com

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.