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

Document! the reorganization how ottr package runs given the iframe #381

Closed
cansavvy opened this issue Jan 12, 2022 · 7 comments
Closed
Assignees
Labels
before-manuscript documentation Improvements or additions to documentation

Comments

@cansavvy
Copy link
Collaborator

Right now, we do a lot of conversions with leanbuild. But with the iframe solution recently implemented by the folks at Leanpub, we can link to each chapter like we do with Coursera. This eliminates a lot of conversion steps 👍

This does mean we need to reevaluate and reorganize the interactions and GHA between OTTR_Template and OTTR_Quizzes.

I think it probably makes sense to render both coursera and leanpub files in the OTTR_Template repository and then transfer them to the Quizzes repository. Then all a user needs to do is write quizzes in the _Quizzes repository (which makes sense).

@cansavvy cansavvy self-assigned this Jan 12, 2022
@cansavvy
Copy link
Collaborator Author

Here's an example of the preview of how iframe works:

https://leanpub.com/courses/jhu/jhudsl_course_template/read/preview/1

What we need to do is figure out what image to put on the poster space.

@cansavvy
Copy link
Collaborator Author

This is on hold until we hear back from the Leanpub people about how the iframe is going.

@cansavvy
Copy link
Collaborator Author

So what we have in Leanbuild is what we have. So solution number 2) will be going forward which is autogenerate a related image to put in place upon rendering.

This lists a couple options of how to do this programmatically. I will test some of these out and determine which makes sense and add it to the Docker image.
https://www.booleanworld.com/take-screenshots-webpages-command-line/

@cansavvy cansavvy changed the title Reorganize how leanbuild runs given the iframe Reorganize how ottr package runs given the iframe Feb 3, 2022
@cansavvy
Copy link
Collaborator Author

cansavvy commented Feb 3, 2022

The screenshots part is complete. Next for it to make rmarkdowns with those screenshots

@cansavvy
Copy link
Collaborator Author

cansavvy commented Feb 5, 2022

This is working pretty well now!

@cansavvy
Copy link
Collaborator Author

cansavvy commented Feb 8, 2022

All that's left is more documenting

@cansavvy cansavvy mentioned this issue Feb 10, 2022
16 tasks
@cansavvy cansavvy changed the title Reorganize how ottr package runs given the iframe Document! the reorganization how ottr package runs given the iframe Feb 10, 2022
@cansavvy cansavvy added the documentation Improvements or additions to documentation label Feb 10, 2022
@cansavvy
Copy link
Collaborator Author

Done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
before-manuscript documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant