SCaLE A/V Coordination

Welcome to the SCaLE A/V Coordination GitHub repo!

This repo contains source files that serve the dual purpose of generating the scale-av webpage, scale-av-user-manual.html, and scale-av-user-manual.pdf, as well as offering a wiki and issue tracker for SCaLE A/V logistics and planning.

If you are interested in volunteering, please refer to the scale-av wiki.

SCaLE A/V is the team that handles audio & visual (A/V) for the Southern California Linux Expo, a volunteer-organized open-source conference.

Developer Notes

Documentation in this repo, including the scale-av webpage, scale-av-user-manual.html, and scale-av-user-manual.pdf, were generated using Asciidoctor - a static-site generator for the AsciiDoc markup language.

Contributing

Source files for the SCaLE A/V User Manual are maintained in the user_manual/ directory and published to the gh-pages branch. To update the manual, simply edit the appropriate files in the user_manual/, note the changes in CHANGELOG.adoc, then commit changes to the main branch.

Building the documentation locally

The following instructions are for building the scale-av-user-manual.html & scale-av-user-manual.pdf documents locally.

Prerequisites

You will need to install podman for your specific platform.

Cloning the repo

Clone this repo, then change directory into the cloned repo:

git clone https://github.com/socallinuxexpo/scale-av-web.git
cd scale-av-web/

Usage

The following will locally generate the scale-av-user-manual.html & scale-av-user-manual.pdf documents to the dist/ folder.

./build.sh