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

Updated readme, to reflect new changes #73

Closed
wants to merge 2 commits into from
Closed

Updated readme, to reflect new changes #73

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c4cf9f
Updated readme, to reflect new changes
Nov 16, 2017
698b79d
tweaks to readme, for PR info
Nov 16, 2017
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
42 changes: 39 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,48 @@
![NodeSchool Montréal Logo](http://nodeschool.io/montreal/i/NodeSchoolMTL.svg)

# Develop NodeSchoolMTL
# NodeSchool Montreal Website

We use [Jekyll](https://jekyllrb.com/) to build [http://nodeschool.io/montreal](http://nodeschool.io/montreal). If you want to run the site or develop it locally you'll have to install [Jekyll](https://github.com/jekyll/jekyll) and [Jekyll-Sitemap](https://github.com/jekyll/jekyll-sitemap).

`gem install jekyll`
Aditionally, in order to suport both French and English
content, we need to use gems (Ruby modules) that are not
supported by GitHub's gh-pages Jekyll scripts. For this
reason we run jekyll with the help of [Travis](https://travis-ci.com/).

`gem install jekyll-sitemap`
Notes to Mentors
----------------

If you are adding yourself or removing yourself as a
mentor, you should create a PR request, first having modified
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Against which branch?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was stated in a section below, but we can put it in this section.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed that. This is fine.

the following resources, as appropiate:

- _config.yml
- i/mentors/

Generating the Site
-------------------

One you have made your changes, you can test them, by
running (tested on macOS and Linux):

`script/cibuild`

`bundle exec jekyll serve`

Note, that the `script/deploy` is intended to be used
by Travis and should not be run locally. When run it
will do all the magic necessary to take the generated
site and push it to the gh-pages branch.

Pull Request
------------

Remember when making your pull request (PR) to do it against
the [gh-pages-src](https://github.com/nodeschool/montreal/tree/gh-pages-src) branch. Doing anything else will most definitely
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have other branches? Can we just have the one, or at the least set it as the default?

Copy link
Collaborator Author

@ajmas ajmas Nov 16, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why we have both master and gh-pages? As for gh-pages-src, this is where we are publishing from to gh-pages, as part of the Travis CI process. I wanted to do the changes incrementally, until I had feedback from the relevant people.

We could change things up, such that master and gh-pages-src are merged into one branch and that we publish to gh-pages. I don't want to do this until I have an okay from @pcuci

GitHub does not support i18n at this point. There is the following open issue tracking this: github/pages-gem#401

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's remove master, or, better, remove gh-pages-src and rename it to master, and just have people push all commits against master, which would then generate gh-pages automatically. I think this is a more common flow. @pcuci sound good?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ajmas Can we go with this flow, then?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be updated.

result in a rejected PR.

Event Information
-----------------

We pull in event information through the [Tito](http://tito.io) embed widget but all the attendees listed are pulled via the [Tito API](http://api.tito.io). In order to update the listing of attendees, you'll have:

Expand Down