hmn
/
hmn
4
Fork 9
Code Issues 55 Pull Requests Releases Activity
Labels Milestones
New Issue

Education tech overview #47

Open
opened 10 months ago by bvisness · 0 comments
bvisness commented 10 months ago
Owner

This is the hub for technical planning / discussion around education initiative tech.

The education content is primarily composed of two things: the main articles, and the glossary.

Short list of features and what they require:

  • Main articles
    • Versioned Markdown content. @AsafGartner and I discussed reusing our post_version data but decided to just duplicate it and build a new thing. (Keeping this separate from posts avoids a lot of complexity bleed from forums / blogs.)
    • Markdown extensions. We need resources to be specially recognized and ultimately rendered with dynamic content based on the user's bookmarks. (The dynamic part could be JS.) We also probably want glossary links to show up in special ways, maybe with inline definition tooltips.
  • Glossary
    • Versioned Markdown content (same as main articles)
    • SEO needs: very good OpenGraph, links to main articles, backlinks from main articles
    • Search (can probably be pretty dumb)
      • Idea: unify the glossary term and search pages presentationally so people who arrive at the glossary can immediately try searching other terms. However, URLs must behave reasonably (JS history API, probably) and the initial page content must be purely static.
  • Supporting infrastructure
    • Permissions: content author (probably global across all educational content), beta tester, none.

Markdown extensions

  • Glossary links (may not require syntax)
  • Editor's notes (only visible to education authors)
  • Fancy links to resources
  • Table of contents?
This is the hub for technical planning / discussion around education initiative tech. The education content is primarily composed of two things: the main articles, and the glossary. Short list of features and what they require: - Main articles - Versioned Markdown content. @AsafGartner and I discussed reusing our `post_version` data but decided to just duplicate it and build a new thing. (Keeping this separate from posts avoids a lot of complexity bleed from forums / blogs.) - Markdown extensions. We need resources to be specially recognized ~~and ultimately rendered with dynamic content based on the user's bookmarks. (The dynamic part could be JS.)~~ We also probably want glossary links to show up in special ways, maybe with inline definition tooltips. - Glossary - Versioned Markdown content (same as main articles) - SEO needs: very good OpenGraph, links to main articles, backlinks from main articles - Search (can probably be pretty dumb) - Idea: unify the glossary term and search pages presentationally so people who arrive at the glossary can immediately try searching other terms. However, URLs must behave reasonably (JS history API, probably) and the initial page content must be purely static. - Supporting infrastructure - Permissions: content author (probably global across all educational content), beta tester, none. ## Markdown extensions - Glossary links (may not require syntax) - Editor's notes (only visible to education authors) - Fancy links to resources - Table of contents?
bvisness added this to the Education Initiative milestone 10 months ago
bvisness added the
reference
 label 10 months ago
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
beta
conferences-page
db-rework
discord-tagging-for-real
education-prettier
feature/2023_frontend_updates
feature/handmade_cities_banner
foundation
jam-2022
live
master
moretwitch
pgx5
snippet_edit
stupid-broken-snippets
Labels
Apply labels
Clear labels
admins only
Exclusively for the HMN admin team bug
Something is not working design
Aesthetics required duplicate
This issue or pull request already exists gimme feedback
We would like more community input on this good first issue hmmmm
The HMN team needs to think on this one invalid
Something is wrong reference
Hub for planning and discussion wontfix
This won't be fixed
No Label admins only bug design duplicate gimme feedback good first issue hmmmm invalid reference wontfix
Milestone
Set milestone
Clear milestone
No items
No Milestone
Education Initiative
Assignees
Assign users
Clear assignees
No Assignees
1 Participants
Notifications
Due Date

No due date set.

Dependencies

No dependencies set.

Reference: hmn/hmn#47
Write Preview
Loading…
Cancel
Save
There is no content yet.
Delete Branch '%!s(<nil>)'

Deleting a branch is permanent. It CANNOT be undone. Continue?

No
Yes