From ea38125cd72df6c10beb32ee92739238d7eae248 Mon Sep 17 00:00:00 2001 From: Florian Sesser Date: Fri, 25 Apr 2025 10:20:00 +0000 Subject: [PATCH 1/2] README.md: Add goals and how to build this web page. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index e69de29..ab1975d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,24 @@ +# Web landing page for the Tahoe-LAFS project + +The goal of this web page is to represent the Tahoe-LAFS project to the public. + +It gives guidance on getting started for end-users, developers building with Tahoe-LAFS and hackers interested working on Tahoe-LAFS itself alike. + + +## Building + +This web page is built and deployed by CI. + +If you want to pre-view your changes on your local machine before pushing commits, you might want to start a development server. + +Issuing this command on a system with Docker runs a web server on http://localhost:4000/ that re-builds the page automatically on source file change: + +```sh +docker-compose up +``` + + +## Contributing + +We welcome contributions! Easiest is to open tickets or pull requests directly. If unsure, join the IRC or ask on the Tahoe-LAFS developer mailing list. + From 74bf4ce3775a874123848bd86d1e031e7fe978e4 Mon Sep 17 00:00:00 2001 From: Benoit Donneaux Date: Fri, 2 May 2025 09:55:17 +0200 Subject: [PATCH 2/2] Enable livereload and adapt the doc accordingly Signed-off-by: Benoit Donneaux --- README.md | 5 ++--- docker-compose.yml | 1 + docker/jekyll/Dockerfile | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ab1975d..1e2f062 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,16 @@ It gives guidance on getting started for end-users, developers building with Tah ## Building -This web page is built and deployed by CI. +This web page is built and deployed by CI. A preview is also automaticaly genereated for PRs made from branches local to this repository (require push/write permission). If you want to pre-view your changes on your local machine before pushing commits, you might want to start a development server. -Issuing this command on a system with Docker runs a web server on http://localhost:4000/ that re-builds the page automatically on source file change: +Issuing this command on a system with Docker runs a web server on http://localhost:4000/ that re-builds and refresh the page automatically on source file change: ```sh docker-compose up ``` - ## Contributing We welcome contributions! Easiest is to open tickets or pull requests directly. If unsure, join the IRC or ask on the Tahoe-LAFS developer mailing list. diff --git a/docker-compose.yml b/docker-compose.yml index 1191885..5ece0a7 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -13,6 +13,7 @@ services: working_dir: /appdata ports: - "4000:4000" + - "35729:35729" stdin_open: true tty: true hostname: jekyll.local diff --git a/docker/jekyll/Dockerfile b/docker/jekyll/Dockerfile index e5a57eb..1313b96 100644 --- a/docker/jekyll/Dockerfile +++ b/docker/jekyll/Dockerfile @@ -40,4 +40,4 @@ RUN echo "gem: --no-document --user-install --bindir /home/${user}/bin" >> /home ENV PATH=/home/${user}/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin ENTRYPOINT ["jekyll"] -CMD ["server", "--verbose", "--host", "0.0.0.0", "--incremental"] +CMD ["server", "--verbose", "--host", "0.0.0.0", "--incremental", "--livereload"]