Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 2.45 KB

README.md

File metadata and controls

80 lines (56 loc) · 2.45 KB
Raw

things-nyc-www

Website for The Things Network New York.

Changes made here will be reflected on thethings.nyc upon being reviewed & pulled by the webmaster.

Development

The site is static HTML generated from markdown with jekyll, using the Bootstrap 5 framework.

Website pages live in the docs directory.

Updating the web pages

XXX - Add some notes about the layout of the directory and what to modify.

XXX - Add notes on how to add a blog entry.

Running under docker

TL;DR

git clone https://github.com/things-nyc/things-nyc.github.io.git
cd things-nyc.github.io
make
# Open http://localhost:4000 in your browser
# Edit files in docs/
# Commit your changes and push to a branch
# Create a Pull Request on Github

Notes

The _dl and _site directories are temporary, created by the fetch and build process, any changes there will be overwritten. Use

make clean

to delete them. They will not saved to github.

To update a JavaScript package, update the version info in the Makefile and

make clean fetch

Details

If you don't want to install Ruby and Jekyll (hint: you don't) you can use the Docker container. Install Docker and Docker-compose. Clone the repo. Run docker-compose up from any project directory to start the container. The project directory is mounted as a volume in the container so you can edit the files with your normal editor. Jekyll will automatically generate new HTML when you make changes. The container runs a web server http://0.0.0.0:4000 so you can preview your work.

Docker Troubleshooting

During the build, you may get DNS failures similar to:

Err:1 http://security.debian.org/debian-security buster/updates InRelease
  Temporary failure resolving 'security.debian.org'

In that case, follow the suggestions from StackOverflow:

  • Try sudo service docker restart, then retry docker-compose build.
  • If appropriate, try sudo /etc/init.d/docker restart, then retry docker-compose build
  • Try rebooting the Linux system, then retry docker-compose build.

In our limited experience, the first step was enough.