wics-uw / website

The code that runs http://wics.uwaterloo.ca/
Other
9 stars 49 forks source link

Add heroku documentation to README #227

Closed evykassirer closed 8 years ago

evykassirer commented 8 years ago

addresses #181

evykassirer commented 8 years ago

@ehashman and @fboxwala - would appreciate your comments on this cause idk if this the kind of information that you were thinking of or if it's explained clearly

thanks!

ehashman commented 8 years ago

Since the comment is now hidden:

I like the code formatting to show it as a clear label (I see it as a way of quoting something clearly

Backticks and code formatting should be reserved for things that require that formatting for clarity. It should not be used for general emphasis---that's what asterisks/bold are for. Backticks should be reserved for cases where they convey additional meaning/clarity.

For example, command and code samples typically use triple backticks for legibility (triple backticks denote a large block that may contain newlines and should be rendered as a separate paragraph, and can use code hilighting, like this: ...)

{:hello (if Tuesday? "world" "moto")}
=> {:hello "moto"}

or single backticks for conveying additional meaning. We tend to use single backticks for directories, program names, user and Unix group names, etc. This helps to distinguish git (software for distributed version control) from git (a jerk) without providing additional written context.

fboxwala commented 8 years ago

lgtm