USB membership applications are now open until January 19, 2024!

Contribute to the Wiki

Add or edit an article on the Student Wiki

Authored by
October 28, 2020

Introduction

The Student Wiki is designed to be a source of information that is useful for the Purdue CS/DS community. We encourage anyone to create a new article for the Wiki or edit a preexisting article. We only ask that new articles are tangentially useful to the CS/DS community. We are using GitHub as the means of managing edits to the Student Wiki. Therefore, to contribute to the Student Wiki, you must have a GitHub account

Create a New Article

Step 1

First, you need to fork the purdueusb.com website repository. This can be done by going to the GitHub repository page, and click the “Fork” button on the top right.

Fork Repo

Step 2

Once you are in your fork of the Purdue USB website repository, navigate to the _wiki directory.

Wiki Directory

Step 3

Next, click “Add file” on the top right, then click “Create new file”.

Add File

Step 4

From here you are going to create a Markdown file for your article. If you are not familiar with Markdown, please read through this guide.

The name of your Markdown file’s name should be no more that 3 words long, with dashes (-) separating the words. The file should always end in the .md file extension. The filename will be the URL slug, so lawson-fob.md becomes /wiki/lawson-fob.

To maintain format consistency, please do not use h1 (#) or h2 (##) headings.

You can also use emojis seen on this cheat sheet! :bangbang:

The beginning of your Markdown file should begin with “front matter.” This is metadata that is used by Jekyll to better organize your article. This is an example of front matter.

---
title:  "Contribute to the Wiki"
description: "Add or edit an article on the Student Wiki"
author: Noah Alderton
date:   2020-10-28 12:00:00 -0400
categories: campus
---
  • title: Title of the article
  • description: Describe what the article is about. Keep this down to one sentence.
  • author: List of author names exactly as they appear in membership data files.
  • date: Date of most recent edit
  • categories: Category this fits the article, like technical or campus. Multiple categories can be included, as long as they are comma separated and between square brackets.

A note about images: Please only use images hosted by USB - not from an outside source. In addition, use descriptive and readable captions for wiki images, as they will be displayed to the user and read aloud via screen readers. Add images to a directory in /assets/images/wiki/<article-name>. From there, will be able to reference local images in your article like so:

![Community Hub Homepage](/assets/images/wiki/connect-vpn/step1.png)

Step 5

Once you are finished typing up your article, add a commit message, and click the green “Commit new file” button on the bottom.

Create New File

Step 6

Now, you need to go to the “Pull requests” tab, and click the green “New pull request” button. Here, you are going to create a new pull request that merges your fork of the website into the Purdue-CSUSB/purdueusb.com repo.

Pull Request

Edit Existing Article

Step 1

Navigate to the _wiki directory and open the Markdown file that you wish to edit.

Wiki Directory

Step 2

Click the edit button on the top right. This will make a fork of the website repository. From here you can the desired changes to the wiki article. If you are not familiar with Markdown, please read through [this guide]. Also, please do not use h1 (#) or h2 (##) headings in an effort to maintain format consistency across the articles.

Edit Document

Step 3

Once you are finished making those edits, add a commit message, and click the green “Commit changes” button on the bottom.

Commit Changes

Step 4

Now, you need to go to the “Pull requests” tab, and click the green “New pull request” button. Here, you are going to create a new pull request that merges your fork of the website into the Purdue-CSUSB/purdueusb.com repo.

Pull Request

Category: campus

Was this page helpful?

Thank you for your feedback!:tada:
https://purdueusb.com/wiki/make-article
purdueusb.com
CC-MAIN-2023-50
30309
application/http; msgtype=response
sha1:TY5LTAN4C75NVYBTKWXO4IMVGDTN3NV5
<urn:uuid:04a6194f-a8ad-4477-b39a-d8805d756f58>
2023-12-02T02:49:24Z
172.67.190.143
text/html
sha1:KWNTRHWV5EDVSQRUXAYAT6JT26A7FEJR
<urn:uuid:65a761d2-2d96-48b3-b62e-8a66f5494327>
https://purdueusb.com/wiki/make-article
response
<urn:uuid:94d2c237-817f-4a49-afad-4415cdc9a65f>
isPartOf: CC-MAIN-2023-50
publisher: Common Crawl
description: Wide crawl of the web for November/December 2023
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-18
software: Apache Nutch 1.19 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.5-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/