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

Frontmatter for deep dive pages - including editor instructions #114

Closed
10 tasks done
rufuspollock opened this issue Apr 6, 2022 · 3 comments
Closed
10 tasks done
Assignees

Comments

@rufuspollock
Copy link
Member

rufuspollock commented Apr 6, 2022

Let’s store “structured” content for page in frontmatter e.g. image, description etc so that …

  • can do SEO tags for the page – these are pages where we have a specific description, image etc
  • can pull this info into the front page “Latest Releases”
  • can showcase this on a “deep dives” page

Acceptance

Tasks

  • Refactor one page to use frontmatter
    • Identify key frontmatter fields
      • key fields: title, date (published), description, (youtube, podcasts although can be left out)
      • other fields: image (thumbnail) and featured (defaulted to false), created, aliases
    • Update MDX component page template to display those fields if present
    • Add SEO based on the frontmatter fields
      • title, description and Image
  • Create a template for creating / editing deep dive pages
    • 'templates/' folder in root web3 for Obsidian
  • Update contentlayer to support these fields

Editor guide

  • create a template for these pages - BONUS: obsidian templates

Notes

Key front matter fields

Required for deep dive

  • title
  • date: publication date
  • description
  • image
  • featured: true - this will be used to determine whether featured on Latest Releases on front page

Optional ... (to be decided if we use these - if we have them all the time we could have a standard layout for these pages)

  • youtube
  • podcast

Note standard fields:

  • created: date this page in wiki was created (so more internal housekeeping)
  • aliases: obsidian field for aliasing pages
@rufuspollock rufuspollock changed the title Deep dives: Template and editor guide for creating including frontmatter Template and editor guide for creating deep dive pages including frontmatter Apr 13, 2022
@rufuspollock rufuspollock self-assigned this Apr 13, 2022
@rufuspollock rufuspollock changed the title Template and editor guide for creating deep dive pages including frontmatter Frontmatter for deep dive pages - including editor instructions Apr 13, 2022
rufuspollock added a commit that referenced this issue Apr 13, 2022
@EilidhRoss1
Copy link
Contributor

@catherinet1 I've assigned you to this task as it's relevant to the editors' guide.

@rufuspollock
Copy link
Member Author

@khalilcodes pretty much all done on tech side. What i suggest is you and @EilidhRoss1 go through late next week and update the deep dive pages and add info to editing guide (reassigning to you @EilidhRoss1 as relates to the deep dive pages which you are maintaining)

@khalilcodes
Copy link
Contributor

Moving 'Document fields in editing guide' to #103 and closing issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

4 participants