revise and clean up build files

To prepare for sharing Thebe with teachers, let's make this as simple as possible by giving a shell script build-book.sh that automates the entire build for all(?) platforms. I think this means the following:

• changing the name of build-lite.sh to build-book.sh and enabling it to work from file explorer on all platforms.
• regarding the above...rather than open the served website automatically, maybe it should just print a message to the user about opening the local server, not the local build, if interactive elements are needed
• updating the documentation in README and THEBE_LITE.md (move this to ./book/book/thebe_lite/ and refer to it in README???)
• can the docker files be collected in a sub-directory and modified to work the same way?
• deploy-book.sh should probably becomes something like deploy-docker.sh to avoid confusion with build-book.sh
• move the documentation for Docker in the README to a *.md file that mimics whatever is done for Thebe

in short: do whatever you can to clean up the root directory as much as possible so that the basic users don't get confused with all the extra "stuff"

Keep in mind that we will eventually be deploying this setup on other Jupyter Book repo's so keeping Docker and Thebe-Lite in separate and portable locations is important.

@tomvanwoudenbe and I can test Windows @cjungbacker can test Mac (he is back next week)

changed due date to August 09, 2023

changed milestone to %Thebe functionality Phase 1

added IT status::planned labels

assigned to @mguichard

changed the description

marked the checklist item changing the name of build-lite.sh to build-book.sh and enabling it to work from file explorer on all platforms. as completed

Should the docker container still host the website automatically? I would say it's more useful that way, and it's easy to manage the lifetime of the server when it's in a container. If it gets in the way they can just stop the deployment.

hard to say since i have never deployed it myself, but i get the sense that once a template is ready it's very simple. Regarding the necessity...for the website itself i guess not critical, but one other situation is having a backup plan: we haven't discussed this yet, but we should have everything ready to deploy elsewhere easily in case the TU GL or webserver goes down...seems like containers will make this easier, right? Perhaps even automated in a "deploy all" type script?

i think the GL CI/CD makes the deployment easy and Docker not truly necessary, right? If that is the case, the container should make it easier to deploy on GitHub?

I think you're right that it doesn't make the deployment process that much easier. In any case, setting up a server won't be trivial enough to just run some containers and call it a day, and not having the overhead of the container is good since we're just hosting some static files. Most of the server's resources can be used for other purposes. As for GL/Github, their CI/CD systems already run in Docker containers so it's redundant to use them for that. But my actual question was about running it locally, whether you'd like it to run the http server automatically. I've turned it off for when you manually run the build-book.sh script, but I'll keep it on for the docker version for now.

ahhhhh ok. i get it now, thanks for the extra explanation ;)

Yes, let's keep running the http server automatically, it's definitely easier to check and manage the server lifetime.

marked the checklist item deploy-book.sh should probably becomes something like deploy-docker.sh to avoid confusion with build-book.sh as completed

marked the checklist item regarding the above...rather than open the served website automatically, maybe it should just print a message to the user about opening the local server, not the local build, if interactive elements are needed as completed

marked the checklist item can the docker files be collected in a sub-directory and modified to work the same way? as completed

marked the checklist item move the documentation for Docker in the README to a *.md file that mimics whatever is done for Thebe as completed

All the Docker related bullet point have been addressed in !23 (merged)

mentioned in merge request !23 (merged)

marked the checklist item updating the documentation in README and THEBE_LITE.md (move this to ./book/book/thebe_lite/ and refer to it in README???) as completed

closed