Skip to content
This repository has been archived by the owner on Aug 17, 2022. It is now read-only.

Clean Slate

Eric Phetteplace edited this page Jul 17, 2018 · 14 revisions

work in progress

Creating a Clean Slate

  1. clone last year's GitHub repo
  2. delete the ".git" folder

3. Clean _data directory

Keep

  • examples dir, contains the templates for future files

Edit

  • conf.yml, the sites configuration file
    1. Remove all of the old urls and links
    2. turn all toggles to false
  • past-keynotes.yml
    1. Copy the keynote speaker information from the speakers.yml file into this file
    2. Add their year
    3. Move their images from /assets/img/speakers to /assets/img/past-keynotes/
    4. Update their image-src

Remove

  • day*_menu.yml
  • dinner.yml
  • duty_officers*.yml
  • locations.yml
  • *-proposals.yml files
  • scheduke
  • speakers.yml
  • sponsors.yml

4. Delete unneeded media files

  • these often live in assets/img, for instance past year's speakers images
  • do not delete the past-keynotes images, "nopics", "badges", "clockface" or "persistent" directories

5. Remove all the presentations and workshops

  • Keynote speaker posts should be in the /_posts/keynotes/ dir, edit their frontmatter to follow this format:
layout: presentation
title: 'CODE FOR LIBERATION'
speaker: kate-krauss
slides: http://2016.code4lib.org/slides/Kate_Krauss_Code4Lib_Keynote.pptx
categories: past-keynote
  • Note that "speakers" plural property is changed to "speaker"
  • Remove all the html files from _posts
  • do not remove the keynotes or examples dir or their contents

6. Comment out or delete content from html file

Excluding "assets" and any "_*" dirs, work through all of the other directories and files. Either comment out or remove any information that is no longer valid.

7. Create a new Google Analytics property & add new web committee members

  • ensure you're a member of the Code4Lib Website Working Group in Google Analytics
  • create a new property named "YYYY Conference" with the URL format of yyyy.code4lib.org
  • update the tracking code in "_includes/analytics.html" with the new property's ID (e.g. the ga('create', 'UA-12345678-9', 'auto'); line)
  • add any new members of the website group to the analytics account under the User Management section
    • they need to have Google-related emails :(
    • give everyone read & analyze, edit, collaborate permissions
    • adding user's to the web property rather than the root of the group might make the most sense

8. Commit to the new conf site's repo

  • Once all the cleaning is complete, make a new repo within the code4lib organization YYYY.code4lib.org
  • Within the root dir:
    • git init
    • git remote add origin $NEW_REPO_SRC
    • git add .
    • git commit -m "init"
    • git push origin master

9. Migrate last year's GitHub wiki from one repository to another

First, create the wiki in the new repository by visiting it and creating an index page. Then, download the git repos behind both wikis and copy of the files of last year into this year. Here's the process on the command line:

# clone the 2 wikis
git clone https://github.com/code4lib/2017.code4lib.org.wiki.git
git clone https://github.com/code4lib/2018.code4lib.org.wiki.git
# copy last year into this year, overwriting whatever exists
cp 2017.code4lib.org.wiki/* 2018.code4lib.org.wiki
# add changes & push to github
cd 2018.code4lib.org.wiki
git add .
git commit -m 'copy wiki from last year'
git push

Note that a lot of the internal links within the wiki (e.g. in the _Sidebar.md menu) will still reference the last year's URL and so will need to be updated. A search-and-replace of the old year for the new should do it.

10. Setup the CNAME

  1. Ask whomever stewards the code4lib.org domain to setup the conference year's subdomain (this has been Oregon St University in the past but will change)
  2. Once the domain has been set up, in the repo's GitHub settings go to Options > GitHub Pages > Custom domain and then enter the domain
  3. You won't be able to activate the Force HTTPS setting immediately but can return in a day or two to turn that on