Merge pull request #25 from BZFlag-Dev/redesign

The new design for our beloved website 🎉

.editorconfig

@@ -4,10 +4,9 @@ root = true
 
 [*]
 charset = utf-8
-indent_size = 2
+indent_size = 4
 indent_style = space
 insert_final_newline = true
-tab_width = 8
 trim_trailing_whitespace = true
 
 [*.md]

.github/CODEOWNERS

@@ -0,0 +1,7 @@
+.github/           @allejo @blast007
+_data/             @blast007
+_datasets/         @allejo @blast007
+_documentation/    @allejo @blast007 @jwmelto
+
+*.scss    @allejo
+*.twig    @allejo @blast007

.gitignore

@@ -1,5 +1,10 @@
 /_site/*
 /.stakx-cache/*
 /_data/privacy.yaml
-/_data/piwik.yaml
+/_data/matomo.yaml
 /.idea/
+*.dll
+*.dylib
+*.mp4
+*.so
+*.webm

LICENSES.md

@@ -0,0 +1,81 @@
+# Licenses
+
+## Content from or specifically for BZFlag
+
+Documentation and video/image assets created for the website should be licensed under the Creative Commons CC BY-SA 4.0 International license, unless otherwise prevented (such as if an asset is derived from another work). Code, markup, and data (twig, HTML, JS, CSS, sass, yaml, json) created for the site will be licensed under the MIT license.
+
+### Creative Commons CC BY-SA 4.0 International
+- _documentation/
+- assets/images/announcements/
+- assets/images/documentation/
+- assets/images/hexagonal-camo.png
+- assets/images/opengraph.jpg
+- assets/images/home/bzteaser.jpg
+- assets/images/home/flying_tank.jpg
+- assets/images/media/
+- assets/images/screenshots/
+
+### GNU LGPL 2.1
+- assets/images/home/blue_laser.png
+- assets/images/home/blue_super_bullet.png
+- assets/images/home/guided_missile.png
+- assets/bzflag-logo-combo.svg (the logo part of the SVG, not the font)
+- favicon.ico
+
+### MIT License
+- assets/js/main.js (except for the getOS function)
+- assets/js/screenshots.js
+- _data
+- _datasets
+- _includes
+- _layouts
+- _pages
+- _sass/abstracts/functions/_math.scss
+- _sass/abstracts/_mixins.scss
+- _sass/abstracts/_variables.scss
+- _sass/components/
+- _sass/layout/_background.scss
+- _sass/layout/_base.scss
+- _sass/layout/_documentation.scss
+- _sass/layout/_footer.scss
+- _sass/layout/_header.scss
+- _sass/layout/_navigation.scss
+- _sass/layout/_typography.scss
+- _sass/pages/
+- _sass/utilities/
+- _sass/styles.scss.twig
+- _sources/hexagonal-camo.php
+
+---
+
+## Third-Party
+
+### MIT License
+- [_sass/layout/_hamburger.scss](https://github.com/callmenick/Animating-Hamburger-Icons)
+- [_sass/abstracts/functions/_assets.scss](https://github.com/HugoGiraudel/sass-boilerplate)
+- [_sass/abstracts/functions/_gradients.scss](https://codepen.io/joeyquarters/pen/dWJYdV/?editors=0100) ([CodePen's terms state that public pens are MIT licensed](https://blog.codepen.io/legal/licensing/))
+- [_sass/abstracts/functions/_strings.scss](https://github.com/HugoGiraudel/SassyStrings)
+- [Bootstrap](https://getbootstrap.com/)
+	- _sass/_bootstrap.scss
+	- _sass/vendor/_bootstrap-reboot.scss
+- [PhotoSwipe](http://photoswipe.com/) by Dmitry Semenov - MIT License (with one exception: "Do not create a public WordPress plugin based on it")
+	- assets/images/photoswipe/
+	- assets/js/photoswipe*.js
+	- _sass/vendor/photoswipe/
+- [Plyr](https://github.com/selz/plyr)
+	- assets/images/plyr.svg
+	- assets/js/plyr.js
+	- _sass/vendor/_plyr.scss
+
+### Misc Licenses
+- assets/images/help/megaphone.svg - [Megaphone by Creative Stall](https://thenounproject.com/icon/147531/) from the Noun Project - CC-BY 3.0 US License
+- assets/images/help/bug.svg - [debug by Lemon Liu](https://thenounproject.com/icon/83827/) from the Noun Project - CC-BY 3.0 US License
+- assets/images/help/book.svg - [Book by Deemak Daksina](https://thenounproject.com/icon/1230262/) from the Noun Project - CC-BY 3.0 US License
+- assets/images/help/question.svg - [FAQ by ProSymbols](https://thenounproject.com/icon/790491/) from the Noun Project - CC-BY 3.0 US License
+- assets/images/help/chat-bubbles.svg - [chat icon](https://thenounproject.com/icon/888687/) from the Starter Icons Collection from the Noun Project - Public Domain
+- assets/images/macOS.svg - [Apple by zidney](https://thenounproject.com/term/apple/1426926/) from the Noun Project - CC-BY 3.0 US License
+- assets/images/Windows.svg - [Windows Logo](https://commons.wikimedia.org/wiki/File:Windows_logo_-_2012.svg) - Public Domain
+- Operating system logos are copyright and/or trademark their respective owners.
+- [highlight.js (just the monokai.css file for styling)](https://highlightjs.org/) - BSD 3-Clause "New" or "Revised" License
+	- _sass/vendor/highlightjs/
+- assets/js/main.js - [(the getOS function only)](https://stackoverflow.com/a/38241481) by [Vladyslav Turak](https://stackoverflow.com/users/4815056/vladyslav-turak) - CC BY-SA 3.0 Unported

README.md

@@ -1,26 +1,40 @@
 # BZFlag.org Main Website
 
-This is the source files for the static BZFlag.org website. The [stakx](https://github.com/stakx-io/stakx) project is used to build the site. 
+The [stakx](https://github.com/stakx-io/stakx) source files used to build the static [BZFlag.org](https://www.bzflag.org/) website.
 
 ## Building the site
 
-```
-git clone https://github.com/stakx-io/stakx
+This website uses features available in stakx 0.2.x. At the time of writing this, stakx 0.2.x is still in development so be sure to use the latest master branch or the [latest 0.2 beta executable](https://github.com/stakx-io/stakx/releases).
+
+```bash
 git clone https://github.com/BZFlag-Dev/bzflag.org
 cd bzflag.org
-../stakx/bin/stakx build
+
+# Build for production
+./path/to/stakx build
+
+# Build for development
+./path/to/stakx build -c _config-dev.yml
+```
+
+## Fetching assets
+
+We host some additional assets, such as videos, outside of the Git repository. To fetch those, run:
+```
+./fetch-assets.sh
 ```
 
 ## Web Server Configuration
 
 The web server needs to be configured to:
+
 - serve motd.txt as motd.php
 
 ### Apache
 
 Replace `/var/www/whatever/` with the actual webroot of the site.
 
 ```
-  # BZFlag requests motd.php, so make an alias
-  Alias /motd.php /var/www/whatever/motd.txt
+# BZFlag requests motd.php, so make an alias
+Alias /motd.php /var/www/whatever/motd.txt
 ```

_config-dev.yml

@@ -0,0 +1,10 @@
+# stakx configuration file for building the site in development mode
+
+import:
+    - _config.yml
+
+debug: true
+
+scss:
+    style: expanded
+    sourcemap: true

_config.yml

@@ -1,29 +1,55 @@
 target: _site
 
 data:
-  - _data
+    - _data
 
 datasets:
-  - name: downloads_bzflag
-    folder: _datasets/downloads/bzflag
-  - name: downloads_bzeditw32
-    folder: _datasets/downloads/bzeditw32
+    - name: announcements
+      folder: _datasets/announcements
+    - name: projects
+      folder: _datasets/projects
+    - name: downloads_bzflag
+      folder: _datasets/downloads/bzflag
+    - name: downloads_bzeditw32
+      folder: _datasets/downloads/bzeditw32
 
 pageviews:
-  - _pages
+    - _pages
 
 collections:
-  - name: user_documentation
-    folder: _documentation/user
-  - name: bzfs_api_events
-    folder: _documentation/developer/bzfs_api_events
+    - name: user_documentation
+      folder: _documentation/user/pages
+    - name: flags
+      folder: _documentation/user/flags
+    - name: slash_commands
+      folder: _documentation/user/slash_commands
+    - name: developer_documentation
+      folder: _documentation/developer/pages
+    - name: bzfs_api_events
+      folder: _documentation/developer/bzfs_api_events
+    - name: bzfs_api_functions
+      folder: _documentation/developer/bzfs_api_functions
+    - name: bzfs_api_types
+      folder: _documentation/developer/bzfs_api_types
 
 exclude:
-  - COPYING
-  - README.md
+    - COPYING
+    - LICENSES.md
+    - README.md
+    - /\.sh$/
 
 debug: false
 
+url: https://www.bzflag.org
+baseurl: /
+description: BZFlag is a free 3D online multi-player multi-platform tank battle game.
 github:
-  dev_repo: BZFlag-Dev/bzflag
-  dev_branch: 2.4
+    # For the site source
+    site_repo: BZFlag-Dev/bzflag.org
+    site_branch: redesign
+
+    # For the core project
+    dev_repo: BZFlag-Dev/bzflag
+    dev_branch: 2.4
+opengraph:
+    image: /assets/images/opengraph.jpg

_data/footer.yaml

@@ -0,0 +1,9 @@
+copyright: BZFlag & Associates
+
+links:
+    - url: https://github.com/bzflag-dev/bzflag
+      name: GitHub
+    - url: /credits/
+      name: Credits
+    - url: /privacy/
+      name: Privacy Policy

_data/matomo.yaml.example

@@ -0,0 +1,5 @@
+cookieDomain: "*.example.com"
+domains:
+    - "*.example.com"
+baseURL: https://example.com/matomo/
+siteID: 1006