-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
33 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| website-relaunch.opentechschool.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,129 +1,48 @@ | ||
| # [www.opentechschool.org](http://www.opentechschool.org) | ||
|
|
||
| [](https://gitter.im/OpenTechSchool/www.opentechschool.org?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
| # Realunching OpenTechSchool Website | ||
| On this repository we are working on the version 2.0 of OTS Website | ||
|
|
||
| [](https://travis-ci.org/OpenTechSchool/www.opentechschool.org) | ||
| [](https://gitter.im/OpenTechSchool/www.opentechschool.org?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
| [](http://discourse.opentechschool.org) | ||
|
|
||
|
|
||
| The source code behind OTS' main web site. | ||
|
|
||
| This project is built with the help of | ||
|
|
||
| * [Bourbon](http://bourbon.io) | ||
| * [Bitter](bitters.bourbon.io) | ||
| * [Flexbox Grid](http://flexboxgrid.com/) | ||
| * jekyll | ||
|
|
||
| In order to be able to compile the site on your own computer, you can install | ||
| the two ruby dependencies with `bundle install` if you have bundler. | ||
|
|
||
| ## Building the site | ||
|
|
||
| 1. run `bundle install` to grab ruby dependencies | ||
| 2. clean up jekyll's build directory: `rm -r _site/*` | ||
| 3. build and serve the site: `jekyll serve` | ||
| 4. Navigate to http://localhost:4000 | ||
|
|
||
|
|
||
| ## Adding a city | ||
|
|
||
| If you want to add a new city to the site, follow these steps: | ||
|
|
||
| * Create a file in the `_cities` directory. It should have a `.md` extension. | ||
|
|
||
| The file name is important and will be used as the key in several places, eg. | ||
| the applicable RSS feed, relevant Discourse category, default Meetup page, | ||
| and CSS class. We will refer to it as `$city` from here on. | ||
|
|
||
| * Add a preamble, looking like this, to the top of the file: | ||
| # Why a new website? | ||
| Ots community grow a lot since the time we build our current website, we have now new chapters, new formats but in particular we have more users interested in our community. Reason why we need to rethink about our website, starting from the UX and giving some refresh to our UI too. <br/> | ||
| In order to build this new website we need the help of all our community so if you are ready to contribute check the links below to know where to start. <br/> | ||
|
|
||
| <!-- To people reading this file's source, it's actually: | ||
| # How can i contribute? | ||
| 1. [Read our code of condaction](http://www.opentechschool.org/code-of-conduct/) | ||
| 2. [Check our open Issues](https://github.com/OpenTechSchool/website-relaunch/issues) | ||
| 3. [Read our contributing guideline](https://github.com/OpenTechSchool/website-relaunch/wiki/Contributing-guideline) | ||
| 4. [Set up the website locally](https://github.com/OpenTechSchool/website-relaunch/wiki/Installation) | ||
| 5. [Got issues? get in touch](http://discourse.opentechschool.org) | ||
|
|
||
| --- | ||
| title: ... | ||
| ... | ||
| --- | ||
|
|
||
| --> | ||
| ## Requirements | ||
| To set up the website locally and to contribute you need: | ||
| * Github account | ||
| * Git | ||
| * Ruby | ||
| * Bundle gem | ||
| * Jekill | ||
|
|
||
| <pre> | ||
| --- | ||
| title: My City | ||
| location: City, Country | ||
| --- | ||
| </pre> | ||
| We also provide a [Vagrant file]() | ||
|
|
||
| `title` and `location` are the name and the geographic context of your city, | ||
| respectively, in your preferred locale used for formatting only. That means | ||
| --- depending on your cultural background --- `Berlin, Germany` and | ||
| `Washington, DC` are both perfectly fine. | ||
| ## Build with | ||
|
|
||
| * Add members to your city: | ||
|
|
||
| * Add the `members` key to your preamble and have its value be a bullet list | ||
| with all your members' opentechschool.org usernames, for example: | ||
|
|
||
| members: | ||
| - alice | ||
| - bob | ||
|
|
||
| (See below for members without an opentechschool.org account.) | ||
|
|
||
| * Explain the usernames in `_data/names.yml`. (This *should* have been done | ||
| by [team.tech@](mailto:[email protected]) when they set up the | ||
| user, if they knew her real name.) It is a simple mapping between username | ||
| and real name, such as: | ||
|
|
||
| alice: Alice Smith | ||
| bob: Bob Johnson | ||
|
|
||
| * Put images into `images/team/`, named like their opentechschool.org | ||
| account and ending in `.jpg`. | ||
|
|
||
| * ***Caveat for non-opentechschool.org accounts:*** If you are adding | ||
| members to your chapter which do not yet have an opentechschool.org | ||
| account, you can use an alternative syntax: | ||
|
|
||
| members: | ||
| - charlie: Charlie Jones | ||
|
|
||
| The first value acts as an image key, the second as a name. It is not | ||
| possible to add emails for non-opentechschool.org accounts for privacy | ||
| reasons. (While we are confident that opentechschool.org accounts won't | ||
| receive large amounts of spam, we can't guarantee that for third-party | ||
| accounts and thus wouldn't want to publish them unmasked on the Web.) | ||
|
|
||
|
|
||
| ### Optional metadata | ||
|
|
||
| All the following values can go into the preamble as well: | ||
| This project is built with the help of | ||
|
|
||
| * `tagline` is a catchy, single line in the top banner of the page describing | ||
| your chapter/city in a playful way. | ||
| * `twitter` is your chapter's Twitter account. | ||
| * `meetup` is the group name on Meetup and would result in links to | ||
| `http://meetup.com/$meetup`. It defaults to `opentechschool-$city`. | ||
| * `does` is the list of projects present in your chapter. It defaults to | ||
| `[workshops]`. | ||
| * `mailing_list` is the mailing list potential coaches can write to. It is | ||
| used in the call-to-action at the bottom of the members list and adds a neat | ||
| *Subscribe* button. | ||
| * [flexbox grid](http://flexboxgrid.com/) | ||
| * [jekyll](https://jekyllrb.com/) | ||
| * Github pages | ||
|
|
||
| ### Redirect stub | ||
|
|
||
| If you don't have too much to say about your city yet and just want to redirect | ||
| to your Meetup page, do the following: | ||
| # Quick start | ||
|
|
||
| * Create a HTML(!) file in the `cities` directory (eg. `berlin.html`.) | ||
| Redirects to *not* work with files ending in `.md`. | ||
| * Add a preamble: | ||
| 1. run `bundle install` to grab ruby dependencies | ||
| 2. clean up jekyll's build directory: `rm -r _site/*` | ||
| 3. build and serve the site: `jekyll serve` | ||
| 4. Navigate to http://localhost:4000 | ||
|
|
||
| <pre> | ||
| --- | ||
| title: My City | ||
| location: City, Country | ||
| redirect_to: "http://meetup.com/opentechschool-city" | ||
| --- | ||
| </pre> | ||
|
|
||
| (See above for a description of the values.) | ||
| Thank you ♡ |