compsocialscience / summer-institute

Overview This site was originally created for Summer Institute in Computational Social Science. It is currently powered by GitHub Pages, Jekyll, and Bootstrap. Table of Contents • Layouts • Default • Home • Navigation Links • Sidebar • Hiding the sidebar • Customizing the sidebar • Post-Mortems • Adding Additional Pages • Homepage • Adding a partner location • Videos • Adding Learning Materials • Admin Documentation Layouts Default The layout is a very basic layout with a header, navbar, footer, and area where Markdown content converted to HTML will be placed. Home The layout is intended to be used for as the homepage. It in includes the global navigation, announcement banner, hero, and promotional content that is located at the root of the directory. For most of these sections, the content can be controlled by the data populated within these YAML files. Should you want to change the content within the announcement banner, you can update the content in the file at the root of the directory. Navigation Links The global navigation links to the various, high level information related to the various programs, both historical and current. They are the following: • Home: links to homepage • Locations: lists all historical and upcoming locations • Curriculum: lists the general curriculum • People: lists all people to participate, organized by location and year Each global page has a custom sidebar based upon the data it is responsible for. For and these are dynamically generated with each new location (more on this later). In the case of this is controlled by the file in the root of the directory. Curriculum example: Keep in mind that this file controls both the generation of the sidebar and the video listing as well. Sidebar By default, the sidebar links will be automatically generated for pages with a of: , , or . Additionally, if a page has set , then it will also have a sidebar automatically generated. Hiding the sidebar You can hide the sidebar by adding the following to a page's front matter: Customizing the sidebar You can also completely customize the sidebar updating the page's front matter to list the links for the sidebar: Post-Mortems > 📖 **For detailed instructions, see the Post-Mortem Guide** To add a post-mortem, three files are needed: • The for the location for a particular year, with the following entries (eg. Tokyo 2021): • The location will also need a file, with the following entry: • The parent year (in this scenario ) will also need a file in its root, as a sibling to the file. This file will contain all of the markdown for that year's post mortems. In addition, be sure when you are writing the markdown for each event's post mortem, that you include a title tag, with the corresponding anchor id, associated to the value you created in the . In this case would anchor to the corresponding title tag in the post mortem's markdown: For troubleshooting and detailed examples, consult the complete post-mortem guide. Location specific pages Each location should have it's own unique directory within the file structure. This means, that each location will have a specific directory filled with data in , as well as a directory of Markdown files in the appropriate year at the root of the project. For simplicity, when creating a new location, we recommend copying the settings from an existing location as a starting point. Customizing how the location appears on the locations page By adding "apply_button: hidden" in , that location's Apply button will be hidden on the location list page, the global apply screen, and the sidebar for that location. The order of the locations is determined first by the location's order key in their file (e.g., order: 99) and secondly by the location's title. In other words, the "title" is the the tie break. Adding Additional Location Detail Pages You're free to add additional pages by created a new Markdown file in the directory that would map to the URL that you desire. For example, would be available at the URL . The Markdown variation that is used by GitHub Pages is kramdown. You'll always want to include the proper front-matter in the Markdown file to give the page a layout and a title. Again, we suggest referring to the structure of the other markdown files within the locations directory, to ensure that the correct front-matter is present. You will also want to update the file within the appropriate location, and add a link to point to your newly created page. Sidebar example: (eg. ) and to add a link to the newly created : Sidebar example updated: (eg. ) Adding a partner location As mentioned early, the global page and sidebar is powered by each individual location directory within the file structure. This means, that when a new location is added, the global locations page with update with a new card, the sidebar will update with the appropriate link, and a new page will be generated. Partner locations must have their own directory with one or more pages. For example, a partner location for 2020 at Northwestern University can have a URL like https://compsocialscience.github.io/summer-institute/2020/northwestern/ complete with their own data and sub-pages. Example steps for creating a new partner location for 2018 at Northwestern University: • Create a new file at . • Front matter data in the newly created file should at least include: The field above tells the site where to look for the data files for this page. In this example, it'd use the data files in . The field identifies that this is the file, and should look for the appropriate layout (with images and correct format) • Create the data files as desired. For example data, feel free to checkout the files in . When creating the file, you'll need to be sure that the corresponding markdown files exist, or the link with throw a error. • Additional markdown pages may be created inside the directory. They should use the following front matter data: Keep in mi…