tahoe-lafs/web-landing-page
tahoe-lafs/web-landing-page
2
0
Fork 0
Code Issues 5 Pull Requests Actions Activity

README.md: Add goals and how to build this web page. #22

Merged
btlogy merged 2 commits from add-readme into main 2025-05-02 08:12:50 +00:00
Conversation 1 Commits 2 Files Changed 3 +25 -1
3 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -0,0 +1,23 @@
# 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. A preview is also automaticaly genereated for PRs made from branches local to this repository (require push/write permission).
btlogy commented 2025-04-25 14:39:32 +00:00
Outdated
Review
Copy Link

To be complete, the CI is also providing a preview so contributor (w/ push/write permission in this repo) do not have to build locally.

To be complete, the CI is also providing a preview so contributor (w/ push/write permission in this repo) do not have to build locally.
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 and refresh the page automatically on source file change:
btlogy commented 2025-04-25 14:36:58 +00:00
Outdated
Review
Copy Link

Maybe we should notify that the pages will not reload, so a refresh is still needed.

I've been using --livereload elsewhere, but I've not yet implemented here...

Maybe we should notify that the pages will not reload, so a refresh is still needed. I've been using `--livereload` elsewhere, but I've not yet implemented here...
```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.

1
docker-compose.yml
View File

@ -13,6 +13,7 @@ services:
working_dir: /appdata
ports:
- "4000:4000"
- "35729:35729"
stdin_open: true
tty: true
hostname: jekyll.local

2
docker/jekyll/Dockerfile
View File

@ -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"]