InnerSourceCommons / InnerSourceCommons/InnerSourceLearningPath

Inline workbook in each article

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

Nobody has claimed this yet.

Website Workbook
Dominant language
JavaScript
Stars
77
Forks
47
Avg merge
11h 11m
Merged PRs (30d)
5

Description

In Should we use hugo-quiz to host workbook? we investigated how to get the workbook questions on innersourcecommons.org. As detailed in that issue, we were able to use quizdown-js to get it working. Here is the relevant commit showing how to wire it up.

Now we need to adjust the script that generates the site pages to include the correct markup for having the workbook questions on the site (in addition to the articles and videos). We were thinking that we could accomplish this by moving the workbook questions from their current location (separate document) to embedded along with each article. Then the autogeneration script could parse them out of there when producing the pages for innersourcecommons.org.

Contributor guide

Open the contributing guide

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

Review the linked hugo-quiz investigation and the referenced innersourcecommons.org commit to understand the existing quizdown-js markup. Then locate the separate workbook source, article content, and script that generates site pages. Done means workbook questions are embedded with each article and the generated pages include the required quiz markup alongside the articles and videos.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
content, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.