CSWomen website information

Overview

This site was made using Jekyll, specifically with the theme Mediumish (with heavy simplifying modifications). I've made an effort to stick to vanilla Jekyll as much as possible, and remove parts of the theme that aren't required for the website with its current content. If you are unfamiliar with Jekyll, I strongly recommend going through this excellent, short introductory tutorial, and following along with pages in the CS Women website:

• Our _pages and _posts directories are pretty standard
• _officers contains officers files which consitute a good example of collections
• assets contains css and image assets
• _includes has includes for the blog post boxes (postbox.html) and for the officer boxes (officerbox.html)
• _layouts contains the page, post and default layouts -- this site uses just the basics.

Common tasks

Adding a blog post

Please read the relevant README here.

Adding a new page

Pages are similar to posts, so please follow the instructions in the blog post README. In addition, please add the following front matter:

• order: determines the order in which pages appear in the top navbar
• short-title: determines the title that appears in the top navbar for this page
• hide-nav: if set to true, prevents page from being shown in the top navbar

Adding or changing officer

To modify officers, you can either fork the repository and set up in the same way as instructed in the blog README file. But make sure that you fork the entire repository rather than just only the blog branch (otherwise pulling from upstream would be a problem). The best way to do it is to obtain admin permission first. The rest of the README is based on the assumption that the user can freely change and this repository.

Modify an Officer's Information

Go to _officers folder, find the officer's .md file which you want to update and change according to the original format. To update a thumbnail picture, change the pictures at assets/images/officers.

Add a New Officer

If you are creating a new position, add a new .md file. Copy the format from the other files and add the information accordingly. If the position exists, please refer to the previous section. Make sure the picture names make sense and you clean up unused pictures.

Some idiosyncrasies and particulars of this website

• pagination: I took it out because it was more trouble than it was worth for the number of blog posts we had. Feel free to add it back in later!
• blog/: The reason the blog index is a separate html file in its own folder (and not a page) is because pagination only works on html pages... this was supposed to aid future addition of pagination
• positions: This used to be a fancy collection, but based on lower participation and in the interests of keeping the website as simple as possible, I moved all position information to one unlinked page. (TODO)
• cards: The pages blog/index.html and /officers both use Bootstrap cards in masonry grids.

Contact

Please contact Neha (nnayak@cs...) if you have any questions about the website. I will probably have forgotten most of what I did but it's ok! We can work it out together.