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

Have a local version of docs on the Pioreactor leader #19

Open
CamDavidsonPilon opened this issue Nov 18, 2022 · 0 comments
Open

Have a local version of docs on the Pioreactor leader #19

CamDavidsonPilon opened this issue Nov 18, 2022 · 0 comments

Comments

@CamDavidsonPilon
Copy link
Member

As a web app

So in local AP mode, we don't have access to the internet. It's a bit jarring hit "help" and getting a 400 error. An idea is to host the docs locally on the RPi, docs.pioreactor.local. Our docs use docusaurus, which is a React SPA with static assets. In fact, running python3 -m http.server in the build directory of the docs folder gets us 50% of the way there (a fully functioning website) - we only need to add a new config to lighttp that does a redirect.

Cons:

  • adds ~100mb to the image
  • how we update docs on remote Pioreactors? Could be a git repo on the Rpi

As a PDF

Tools exist to convert a docusaurus site to pdfs. The PDFs looks okay.

Cons:

  • adds ~50mb to the image
  • how we update docs on remote Pioreactors?
  • Doesn't take advantage of using a computer to do computer things
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant