{"id":15360283,"url":"https://github.com/mkcor/2016-06-01-mcgill","last_synced_at":"2026-04-18T04:30:23.517Z","repository":{"id":148249486,"uuid":"59423423","full_name":"mkcor/2016-06-01-mcgill","owner":"mkcor","description":"Software Carpentry workshop with extra Python (NumPy)","archived":false,"fork":false,"pushed_at":"2016-05-26T16:33:19.000Z","size":908,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"gh-pages","last_synced_at":"2025-01-01T17:23:08.517Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://mkcor.github.io/2016-06-01-mcgill/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkcor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-22T16:52:46.000Z","updated_at":"2016-05-23T18:17:12.000Z","dependencies_parsed_at":"2023-05-25T08:30:21.797Z","dependency_job_id":null,"html_url":"https://github.com/mkcor/2016-06-01-mcgill","commit_stats":{"total_commits":453,"total_committers":73,"mean_commits":6.205479452054795,"dds":0.7880794701986755,"last_synced_commit":"42bdfa673ad78d6c8892703e8148469da212a5b3"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkcor%2F2016-06-01-mcgill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkcor%2F2016-06-01-mcgill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkcor%2F2016-06-01-mcgill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkcor%2F2016-06-01-mcgill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkcor","download_url":"https://codeload.github.com/mkcor/2016-06-01-mcgill/tar.gz/refs/heads/gh-pages","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240018685,"owners_count":19734872,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-01T12:49:03.399Z","updated_at":"2026-04-18T04:30:23.460Z","avatar_url":"https://github.com/mkcor.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# workshop-template\n\nThis repository is [Software Carpentry](http://software-carpentry.org)'s\ntemplate for creating websites for workshops.\n\n1.  Do *not* fork this repository directly on GitHub.\n    Instead, please use GitHub's importer following the instructions [below](#creating-a-repository)\n    to create a website repository for your workshop.\n\n2.  Please *do your work in your repository's `gh-pages` branch*,\n    since that is what is [automatically published as a website by GitHub](https://help.github.com/articles/creating-project-pages-manually/).\n\n3.  Once you are done,\n    please **send your repository's URL to the [Software Carpentry administrator](mailto:admin@software-carpentry.org)**.\n    We build the [list of workshops on the main website](http://software-carpentry.org/workshops/index.html)\n    from the data included in your `index.html` page.\n    We can only do that if you [customize](CUSTOMIZATION.md) that page correctly\n    *and* send us a link to your workshop website.\n\n4.  Please also read\n    [the notes on customizing your website](CUSTOMIZATION.md) and the [FAQ](FAQ.md).\n    If you're interested in knowing more about why we do things the way we do,\n    please check out the [design notes](DESIGN.md).\n\n5.  If you are teaching Git,\n    please [create a separate repository](#setting-up-a-separate-repository-for-learners)\n    for your learners to practice in.\n\n6.  If you run into problems,\n    or have ideas about how to make this process simpler,\n    please [get in touch](#getting-and-giving-help).\n\n## Creating a Repository\n\n1.  Go to [GitHub's importer][import].\n\n2.  Click on \"Check the URL\".  (GitHub won't import until you've done this.)\n\n3.  Select the owner for your new repository.\n    (This will probably be you, but may instead be an organization you belong to.)\n\n4.  Choose a name for your workshop website repository.\n    This name should have the form `YYYY-MM-DD-site`,\n    e.g., `2015-07-01-miskatonic`.\n\n5.  Make sure the repository is public.\n\n6.  At this point, you should have a page like this:\n\n    ![](img/using-github-import.png?raw=true)\n\n    You can now click \"Begin Import\".\n    When the process is done,\n    you can click \"Continue to repository\" to visit your newly-created repository.\n\n**Note:**\nsome people have had intermittent errors during the import process,\npossibly because of the network timing out.\nIf you experience a problem, please re-try;\nif the problem persists,\nplease [get in touch](#getting-and-giving-help).\n\n## Customizing Your Website\n\n1.  Go into your newly-created repository,\n    which will be at `https://github.com/your_username/YYYY-MM-DD-site`.\n    For example,\n    if `your_username` is `gvwilson`,\n    the repository's URL will be `https://github.com/gvwilson/2015-07-01-mistaktonic`.\n\n2.  Edit `index.html` to customize the list of instructors,\n    workshop venue, etc. \n    You can do this in the browser by clicking on it in the file view on GitHub\n    and then selecting the pencil icon in the menu bar:\n\n    ![](img/edit-index-file-menu-bar.png?raw=true)\n    \n    Editing hints are embedded in `index.html`,\n    and full instructions are in [CUSTOMIZATION.md](CUSTOMIZATION.md).\n\n    \u003e Alternatively, you can clone the repository to your desktop,\n    \u003e edit `index.html` there,\n    \u003e and push your changes back to the repository.\n    \u003e\n    \u003e ~~~\n    \u003e git clone -b gh-pages https://github.com/your_username/YYYY-MM-DD-site\n    \u003e ~~~\n    \u003e\n    \u003e This is needed because the imported repository doesn't have a `master` branch.\n    \u003e\n    \u003e **Note:** please do all of your work in your repository's `gh-pages` branch,\n    \u003e since [GitHub automatically publishes that as a website](https://help.github.com/articles/creating-project-pages-manually/).\n\n3.  Edit `_config.yml` in the same way\n    so that `workshop_repo` and `workshop_site`\n    are the URLs of your repository and your GitHub Pages website respectively.\n\n    Note: the URL for your website is determined automatically\n    based on the URL for your repository.\n    If your repository is at `https://github.com/your_username/YYYY-MM-DD-site`,\n    its GitHub Pages website is at `http://your_username.github.io/YYYY-MM-DD-site`.\n\n4.  When you are done editing,\n    you can view your website:\n    if your repository is `https://github.com/your_username/YYYY-MM-DD-site`,\n    its website will be `http://your_username.github.io/YYYY-MM-DD-site`.\n\nFull instructions are available in [CUSTOMIZATION.md](CUSTOMIZATION.md).\nThis [FAQ](FAQ.md) includes a few extra tips\n(additions are always welcome)\nand these notes on [the background and design](DESIGN.md) of this template may help as well.\n\nThat's it.\nThe following steps are only necessary if you want to run the website locally on your computer.\n\n## Checking Your Changes\n\n1.  To check your changes on your desktop you need some softwares\n    described at [Installing Software session](#installing-software).\n    This may require some work to set up,\n    so feel free to preview by pushing to the website.\n\n2.  For some links to work properly,\n    particularly the link to your workshop's Eventbrite registration page,\n    you must view `_site/index.html` using an HTTP server.\n    If you have Jekyll installed,\n    you can do this by running:\n\n    ~~~\n    $ jekyll server -d _site\n    ~~~\n\n    and going to http://localhost:4000.\n\n## Installing Software\n\nIn order to preview the workshop website locally on your computer,\nyou must install the software described below.\n\n\u003e If you aren't able to install this software (or you just can't be\n\u003e bothered), you can still create a website for your workshop.  Every\n\u003e time you push a change to your website respository the live website\n\u003e will update automatically, so you can check your changes on the live\n\u003e site instead of locally.\n\n1.  Ruby 2.0 or greater\n\n    On Debian/Ubuntu based machines you can install it using\n\n    ~~~\n    $ sudo apt-get install ruby2.0 ruby2.0-dev\n    ~~~\n\n2.  NodeJS\n\n    On Debian/Ubuntu based machines you can install it using\n\n    ~~~\n    $ sudo apt-get install nodejs\n    ~~~\n\n3.  Jekyll\n\n    Install `github-pages`:\n\n     ~~~\n     $ gem install github-pages\n     ~~~\n\n     or if that doesn't work:\n\n     ~~~\n     $ gem install jekyll\n     $ gem install kramdown\n     ~~~\n\n     We use Kramdown to translate Markdown into HTML, instead of\n     the default Redcarpet, because Kramdown handles Markdown\n     inside HTML blocks.\n\n    Note: you may need to specify the version of gem to use for installation\n    if you have multiple versions of Ruby installed.\n    For example for version 2.0 you could use:\n\n     ~~~\n     $ gem2.0 install github-pages\n     ~~~\n\n\n2.  The Python YAML module\n\n    If you are using the Anaconda Python distribution, you probably\n    already have it; if you don't, you can install it with:\n\n    ~~~\n    $ conda install pyyaml\n    ~~~\n\n    If you are using some other distribution, you can install the\n    Python YAML module using Pip:\n\n    ~~~\n    $ pip install pyyaml\n    ~~~\n\n    and if you are on Debian Linux, you can use:\n\n    ~~~\n    $ apt-get install python-yaml\n    ~~~\n\n## Setting Up a Separate Repository for Learners\n\nIf you are teaching Git,\nyou should create a separate repository for learners to use in that lesson.\nYou should not have them use the workshop website repository because:\n\n*   your workshop website repository contains many files\n    that most learners don't need to see during the lesson,\n    and\n\n*   you probably don't want to accidentally merge\n    a damaging pull request from a novice Git user\n    into your workshop's website while you are using it to teach.\n\nYou can call this repository whatever you like,\nand add whatever content you need to it.\n\n## Getting and Giving Help\n\nWe are committed to offering a pleasant setup experience for our learners and organizers.\nIf you find bugs in our instructions,\nor would like to suggest improvements,\nplease [file an issue](https://github.com/swcarpentry/workshop-template/issues)\nor [mail us](mailto:admin@software-carpentry.org).\n\n[import]: http://import.github.com/new?import_url=https://github.com/swcarpentry/workshop-template\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkcor%2F2016-06-01-mcgill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkcor%2F2016-06-01-mcgill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkcor%2F2016-06-01-mcgill/lists"}