One of the goals of alohamask is to make the process as open and accessible as possible. That is why both this website and our design and instructions are open source and available on GitHub. Contributions are welcome through pull requests.
Contributing to alohamask.org
There are generally two use cases for contributing to alohamask.org
- To maintain and improve the original alohamask.org
- To create your own local version of alohamask.org for your own community
We will examine both of these use cases.
The top-level directory
alohamask.org contains readmes, scripts, licenses, git metadata, and a subdirectory
alohamask.org. The actual static site as generated by hugo resides in
Whether you are improving the original alohamask.org or utilizing it as a template for your own local community, you will want to create a fork of the repository into your own github account.
alohamask.org was designed using the hugo static site generator. hugo converts Markdown into static web pages. These web pages can easily be hosted with a general purpose webserver or on platforms such as GitHub Pages or AWS S3. Please install the latest version of hugo from their release page.
We are using the cupper theme to theme alohamask.org. The design is simple, clean, and most importantly, designed to be accessible. cupper also provides numerous shortcodes which provide capabilities beyond basic Markdown.
After reading through the hugo documentation and the cupper documentation, the best way to learn how hugo and cupper work is by going through cupper’s exampleSite directory, which when compiled, produces this.
User feedback is currently handled by Google forms whose URLs are embedded in the source of the static site. We also utilize a shared Google account to track and organize responses and volunteers. Eventually, we may move to a more robust web framework and collect our own form values. Because we wanted to make this as accessible as possible and to get off the ground quickly, we decided a static site makes the most sense for the time being.
Some basic bits on interacting with hugo
Assuming you are using a terminal and your current working directory is the top-level directory of alohamask.org, you can take the following actions.
Run the hugo server in development mode.
hugo server --source alohamask.org
Compile the static site. The generated site will be available at
hugo --source alohamask.org
We’ve provided some helper shell scripts to make these tasks a little easier. Please run them from the top level directory.
build.shwill compile your static site and place both the uncompressed and compressed compiled files in
clean.shwill clean all build files and directories
run_local.shwill run the hugo server in development mode
Some basic bits on adding or editing content
All content that can be edited or added to the site exists in either
alohamask.org/alohamask.org/content/*. You shouldn’t need to edit or add files anywhere else.
- Top level menu items are configured in
- Each page must have the
- If a post has images, create a new directory for the post that contains an
index.mdfile and any images that will be used in the post.
- New “News Items” are automatically added the the list of news items on the news page.
- When in doubt, reference the exampleSite.
Maintaining or improving alohamask.org
If you would like to make edits or improvements to the original alohamask.org, follow these steps.
- Create a new issue describing the change you would like to make
- Fork the repository
- Create a new branch named
- Make your changes and test locally
- Commit your changes
- Create a pull request
Creating your own local version of alohamask.org
We encourage other community led efforts to build off of our efforts to create your own version alohamask.org for your community. Please fork our repository and then make the requested changes specified in the next section.
Modifying alohamask.org for your own community
There are some changes that will need to be made if you would like to use this template for your own community.
- Update the
- Change contact information provided in
- Create your own Google Forms for volunteers and mask requests. Please feel free to model your Google Forms off of ours.
- Update the URLs to your Google Forms in
- Delete all items in
- Remove any references to latest news in
Serving your modified alohamask.org to your community
The details of hosting a static site are generally outside the scope of this discussion. There are essentially two strategies.
- Use a traditional web server (Apache, nginx, Caddy, etc) to host the content
- Use a service to host the content (GitHub Pages, Netlify, AWS S3, etc)
Confused by any of this?
Please create an issue and we will work to answer your questions.