# viewsourceconf

**Repository Path**: mirrors_mdn/viewsourceconf

## Basic Information

- **Project Name**: viewsourceconf
- **Description**: Repo for View Source Conference site
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# viewsourceconf

This is a repository for the viewsourceconf.org website source code.

## 2017

In 2017 we're still using a static site generator, [metalsmith](http://metalsmith.io), to generate the site.

## 2016

In 2016 we're using a static site generator, [metalsmith](http://metalsmith.io), to generate the site.

### Repository structure

`/source`: Most source code for the site lives here: HTML, Stylus, JavaScript. Subdirectories:
  * `/2015`: The prior year's website (which is mostly ignored by metalsmith using [metalsmith-branch](https://github.com/ericgj/metalsmith-branch)).
  * `/berlin-2016`: Like 2015, ignored by metalsmith
  * `/london-2017`: Any source code specific to the event.
  * `/js` and `/stylesheets` (which are processed by [metalsmith-uglify](https://github.com/ksmithut/metalsmith-uglify) and [metalsmith-stylus](https://github.com/esundahl/metalsmith-stylus), respectively)
  * `/index.html`: the main landing page that'll live at http://viewsourceconf.org

`/layouts`: One or more layouts that page content can live in. For example we might have a berlin layout, a front layout, an interior layout. These files are processed by [metalsmith-layouts](https://github.com/superwolff/metalsmith-layouts).

`/data`: json files containing structured data. For example, `berlin_speakers.json`. Data files are an appropriate place to put content that we want to handle in a structured, templated way. Data files are processed by [metalsmith-models](https://github.com/jaichandra/metalsmith-models).

`/build`: The built site goes here. It looks a lot like the source directory, but files have been processed and composed. JS will be uglified; stylus files will be CSS-ified. This directory may or may not be checked into the repo.

`build.js`: This is the node script that does the site build -- the metalsmith controller, sort of.

### How to contribute

We welcome your help making this code better! Here's how to hack on it:

1. Fork & clone this repository
2. `cd viewsourceconf && npm install`
3. `node build dev`
4. Make a branch for your changes: `git branch my_changes`
5. Navigate to http://localhost:8080 to develop and test. Some kinds of changes may require forcing a build (ctrl+C + `node build dev` will do it, or `node build` in a separate terminal).
5. Commit and push your changes, then PR.

### How to build the site

* `node build` will build the site and then exit
* `node build dev` will
  * build the site
  * start a web server at http://localhost:8080 using [metalsmith-serve](https://github.com/mayo/metalsmith-serve)
  * watch the source directory for changes using [metalsmith-watch](https://github.com/FWeinb/metalsmith-watch)

### How to deploy the site

* [Build status is in Jenkins](https://ci.vpn1.moz.works/view/viewsourceconf/)
* Code merged to [https://github.com/mdn/viewsourceconf/tree/master](https://github.com/mdn/viewsourceconf/tree/master) will land on [staging](https://viewsourceconf-stage.virginia.moz.works) automatically, unless it breaks the build.
* Don't do anything else until your code is merged to master and you have tested it in staging. Srsly.
* Pushing a commit to the `prod` branch will trigger a deploy to [https://viewsourceconf-prod.virginia.moz.works](https://viewsourceconf-prod.virginia.moz.works)
	* the `deploy_to_prod.sh` script automates this for you by generating a tag name, committing an annotated tag, merging it to prod, and pushing the prod branch to origin.
* Watch your build in Jenkins. Verify it in production.

### Docker

The site is deployed to staging and production using Docker and Deis, and you can also use Docker for local development without installing nodejs or npm dependencies. Most of the commands below will try to use an image based on the local git sha first and then fall back to the 'latest' image when appropriate, which allows you to build and test docker images with local commits when desired, or automatically use the images built by CI in the common case. All of the `make` commands make use of environment variables with defaults; see the Makefile for more details.

* `make build`: build the site by running `node build` in a Docker container
* `make dev`: run the `node build dev` command described above in a docker container
* `make build-build-image`: build the image used to build the site
  * run this if you add a new dependency to package.json or Dockerfile-build
* `make build-deploy-image`: package the built site into an nginx container for deployment
  * useful for testing nginx.conf changes
* `make serve`: run the nginx deployment image
  * listens on port 8000 by doefault, override with the SERVE_PORT environment variable
* `make generate-cert`: create a self signed cert for localhost
* `make serve-https`: run the nginx deployment image but force https
  * does not use port number
  * generate a cert first
* `make curl`: run curl with the "X-Forwarded-Proto: https" header to bypass the http>https redirect
* `make sh`: run an interactive shell in a "build" container
  * useful for debugging new build dependencies


## LICENSE

This software is licensed under the MPL-2.0. For more information see `LICENSE`.

## 2015

The 2015 site was built in WordPress. That site no longer exists. But a static archival site exists, and should live at http://viewsourceconf.org/2015 for a while.