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

Should we use hugo-quiz to host workbook? #388

Closed
rrrutledge opened this issue Mar 30, 2021 · 9 comments
Closed

Should we use hugo-quiz to host workbook? #388

rrrutledge opened this issue Mar 30, 2021 · 9 comments
Labels

Comments

@rrrutledge
Copy link
Contributor

rrrutledge commented Mar 30, 2021

We have learning path videos and articles on the website, but not the review questions of the workbook. hugo-quiz may be a good choice for putting workbook questions along with each article on the website.

We should do a quick investigation to determine if hugo-quiz will work for us. If things looks good then we can plan to do the work to actually get the review questions on the website.

@lenucksi
Copy link
Member

@voborgus might know more about this.

@voborgus
Copy link
Collaborator

Integrated with quizdown-js our website:

https://innersourcecommons.org/learn/learning-path/introduction/02/

How to implement this:

  1. Add property on the top of the page.
quiz: true
  1. Use quiz snippet with markdown style questions:
{{< quiz >}}
## When an InnerSource project can be useful?

1. [ ] Your team lacks the resources to create its core software >
  InnerSource allows other teams to upgrade your software to meet their needs. You can’t depend on other teams to take on your own priorities, nor can you assign a project to another team. InnerSource relies on voluntary contributions, and works where the interests of the guest and the host team align.
1. [x] You are badgering a high-level manager to get another team to implement a software change >
  Large organizations that assign different teams to different parts of a code base routinely suffer battles over priorities. What’s critical to your team’s business plan may be seen as an extraneous annoyance to the host team that owns the code. With InnerSource, you add the code you need directly to the other team’s project, although you are responsible for following their guidelines and the host team vets it before it goes in.
1. [ ] Most of your software is bought rather than built >
  If a third party delivers a proprietary solution, you can’t participate in its development. However, free and open source software from third parties offers excellent opportunities for collaboration. The skills you learn doing InnerSource can be applied to open source projects outside your company, and vice versa.
1. [ ] Not enough software changes are being submitted to your team >
  InnerSource exploits the desires of other teams to enhance your software. If your software is mature and doesn’t need many changes, there is no reason for you or other teams to enhance it. Your skills can be directed to new projects.
{{< /quiz >}}

Will be happy to receive all questions from the workbook in that form as an incoming contribution. Check all types of questions supported by the library: https://github.com/bonartm/quizdown-js

@lenucksi
Copy link
Member

Looks great! Thank you!

@rrrutledge
Copy link
Contributor Author

Wow this is awesome! Is there a commit or pull request that can be referenced to show how it works, too? I took a quick look but didn't see anything.

@lenucksi
Copy link
Member

Wow this is awesome! Is there a commit or pull request that can be referenced to show how it works, too? I took a quick look but didn't see anything.

https://github.com/InnerSourceCommons/innersourcecommons.org/blob/master/content/learn/learning-path/introduction/02.md that one's got everything in the front matter and the first few lines. Might actually be a quick copy&paste job. Noice me says.

@rrrutledge
Copy link
Contributor Author

OK looks like here is the relevant commit. Neat! We'll need to add this into the autogeneration script.

@rrrutledge
Copy link
Contributor Author

@voborgus or @tsadler1988 may be interested in doing this?

@rrrutledge
Copy link
Contributor Author

Suggest putting the workbook questions at the bottom of the article in a way that is machine-parsable. Then they can be translated and the script has access to them.

@rrrutledge
Copy link
Contributor Author

Opened Host workbook on innersourcecommons.org to take forward this work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants