Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #365

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #365

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The code that runs the WiCS site #
# THE CODE THAT RUNS THE WISC WEBSITE #

The site is generates static content from Markdown articles, using software
called [Pelican](http://docs.getpelican.com/en/3.5.0/).
Expand All @@ -19,7 +19,7 @@ These docs are aimed at a Debian-based Linux user.

[Deployment](#deployment)

## Installation ##
## INSTALATION PROCESS ##

### `git` ###

Expand Down Expand Up @@ -294,7 +294,7 @@ single commit). You might see the error message failed to push some refs to
It will bring back in a copy of all the commits you
squashed and potentially other commits unrelated to your change.

### Merging ###
### MERGING ###

A back-and-forth revision process will occur during the course of the review.
For the developer to update the pull request, they simply need to push new
Expand All @@ -307,17 +307,17 @@ merged into the upstream master branch. For the changes to appear on the
website, someone needs to deploy the new code (see the **Deployment** section
for more details).

## Development ##
## DEVLOPMENT ##

You can either add content to the site or modify its theme.

### Adding site content ###
### ADDING SITES CONTENT ###

All site content is contained in the `content/` directory. Posts are sorted by
term directories, e.g. "F2014". There is also a `pages/` directory that
contains non-post type pages, such as contact info, about us, etc.

#### Posts ####
#### POSTS ####

We currently use three posting categories: **Blog**, **Events**, and **Media**.

Expand All @@ -332,7 +332,7 @@ Please try to use a consistent naming scheme. Articles are named by term,
category, and slug; for instance, posting a video of a talk about automata in
S13 might be named `S13-media-automata.md`.

#### Pages ####
#### PAGES ####

We only need a limited number of pages. You probably won't need to add many
more. These include things like our Code of Conduct, contact info, etc.
Expand All @@ -342,7 +342,7 @@ To do so, make sure you set `Status: hidden` in the Markdown preamble. This
will cause the page to be generated without showing up in the site's main
navigation.

### Markup beautification ###
### MARKUP BEAUTIFICATION ###

The theme we are currently using is called `notmyidea`. Pelican uses the
[jinja2](http://jinja.pocoo.org/docs/dev/) templating system; if you've used
Expand All @@ -351,7 +351,7 @@ Django, you'll find the templates very similar.
To modify the theme css or html, simply take a look at the theme data under
`theme/notmyidea/` and modify it at will.

### Testing Locally ###
### TESTING LOCALLY ###

To test a local copy of the site, you'll need to start the development server.
There's no additional software you need to install to launch a local version of
Expand All @@ -372,7 +372,7 @@ To shut down the development server, use
./develop_server stop
```

## Heroku Review Apps ##
## HEROKU REVIEW APPS ##

When prompted, Heroku will provision temporary public web hosting and a domain
name for any open pull request, and post a pingback on GitHub. This allows
Expand Down