Giter VIP home page Giter VIP logo

bsides's Introduction

BSides Goldie Website

This is the site for BSides Goldie (BSides Gold Coast) that is deployed via GitHub Actions to GitHub Pages.

It's a Jekyll site.

Year-Over-Year Changes

I've made an effort to start extracting some year-over-year changes into site config variables to ensure a consistent messaging across the website. But some things in our current site are not conducive to this. A rough outline of steps needed for year-over-year is as follows:

  • Update all values in _config.yml for the appropriate values for your event.
  • Update _includes/map.html to point to your address (if you choose to use the map, otherwise we can control showing map with a boolean)
  • Update index.html#citystate with the city/state of your event. Even if you're not providing the whole address online, you should provide city and state to help people estimate their plans.
  • Update venue.html to include whatever level of detail you are comfortable with for your venue. Ensure you remove the previous host's details (e.g. if it says Google and you are not representing Google, make sure you change this)
  • Change the logo for your event's logo. This should typically change every year. Reach out to Paul if you want contact info for the designer of a previous year.
  • If you wish to publish a schedule, use schedule.html to do so

Things you probably don't need to change

It is unlikely that, as a host, you will need to change any content on about.html, code.html, or guidelines.html. These are typically pretty static year over year.

Developing

Changes made to this repo are made live immediately.

Ideally you will make changes locally, test that it looks fine, then submit a Pull Request and get the changes merged into master.

To view the site locally you'll need to render it with Jekyll, a Ruby static site generator.

Here are some instruction from GitHub Pages on how to do this.

Environment Setup

This setup assumes you're using macOS with no Ruby environment:

  1. brew install ruby

  2. Append the following line to your ~/.bash_profile (or whatever is appropriate for your shell). Make sure the Ruby major and minor versions are correct so the path resolves. If you're not sure, bundle will tell you what the path should be.

export PATH=/usr/local/opt/ruby/bin:~/.gem/ruby/2.6.0/bin:$PATH
  1. gem install --user-install bundler

  2. Clone this repository, and inside the repo run bundle install

Running a Local Preview

Once you have Jekyll installed via bundler, you should be able to run a local Jekyll server and access it at localhost:4000:

bundle exec jekyll serve

bsides's People

Contributors

6mile avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.