SSWConsulting / SSWConsulting/SSW.Rules

🥅Netlify CMS | The intro field should be a separate frontmatter field

Open
#698 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
26
Forks
17
Avg merge
14h 39m
Merged PRs (30d)
2

Description

@JackLeerson @tiagov8 @jaydenalchin @jakebayliss @adamcogan @bradystroud @christianmorfordwaitessw
Hi team,

Netlify CMS currently has the intro as part of the body text. The intro should be put into a separate field to make the process more intuitive and also introduce better quality control.

  • Please add a new “intro” frontmatter field on Rules + textbox in Netlify CMS
    • Set the title of the Netlify CMS editing field as “Intro - Short and Sweet (add a short sentence summarizing what the rule is about)”
    • Only plain text - Do not allow images, videos, code, boxes, lists, etc
      • Ideally can do new lines but if we can’t disable lists and videos etc then don’t allow
    • Character limit as long as a tweet (280)
  • Change front-end button from “Show Blurb” to be “Short and Sweet”
  • Please add a new “featured media” frontmatter field on Rules + textbox in Netlify CMS
    • This could be an image or YouTube video
    • This should be shown in the “Short and Sweet” view in a smaller size floating next to the text
  • Investigate the best way to do the migration
    • The new field should replace the current but may hang around as a fallback after the intro field is introduced.
  • Add all the new information to https://github.com/SSWConsulting/SSW.Rules.Content/wiki/How-to-Create-Rules
    • Include workaround to have more than 280 characters – go to GitHub
  • Review https://my.sugarlearning.com/SSW/items/9369/how-we-write-rules-at-ssw

AB#64369

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.

Research direction

Start by locating the Netlify CMS Rules + textbox configuration and the frontend code that renders “Show Blurb”; review the existing handling. Define the intro and featured media fields, their migration or fallback behavior, the renamed view, and the required updates to the How-to-Create-Rules wiki.

Written by the indexing model from the issue text.

Assessment

Tech stack
nextjs, typescript
Domain
content, documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.