-

username being your github username, branch being the branch you have been working on.

+_**username** being your github username, **branch** being the branch you have been working on._ -

You should now be able to see listed below, all the changes that you wish to contribute. If everything looks as it should, click ‘Create pull request’.

+You should now be able to see listed below, all the changes that you wish to contribute. If everything looks as it should, click '*Create pull request*'. -

Give your pull request a title and description, then click ‘Create pul request’. You have now contributed your pages to the Handbook :)

+Give your pull request a title and description, then click '*Create pul request*'. You have now contributed your pages to the Handbook :) diff --git a/contribute/editing.md b/contribute/editing.md index 778de73f5..ab0a6bc62 100644 --- a/contribute/editing.md +++ b/contribute/editing.md @@ -6,96 +6,86 @@ authors: - Sam Smith --- -

If you haven’t done so already, the first thing you need to do is head over to Github and create your free account.

+

If you haven't done so already, the first thing you need to do is head over to Github and create your free account.

-

There are three steps to editing a page. First you need to locate the page you wish to edit. There are a couple of ways to do this. Method A is probably the simplest, and most likely way you’ll do it. Method B will serve as a primer for the next section: Adding a page.

+There are three steps to editing a page. First you need to locate the page you wish to edit. There are a couple of ways to do this. **Method A** is probably the simplest, and most likely way you'll do it. **Method B** will serve as a primer for the next section: *Adding a page*. -

1: Locate the page

+## 1. Locate the page -

Method A: Browse the website

+#### Method A: Browse the website -

While reading any section of the Handbook you’ll see a button with the paper icon [paper icon] Improve this page in the right side or bottom of the page, depending on the size of the screen. Hovering over it then clicking an 'Edit on Github' button will take you directly to an editable version of that page. Easy huh?

+While reading any section of the Handbook you'll see a button with the paper icon [paper icon] Improve this page in the right side or bottom of the page, depending on the size of the screen. Hovering over it then clicking an '*Edit on Github*' button will take you directly to an editable version of that page. Easy huh?
Note
-

When the editable page opens it will (most likely) contain a message saying “You need to fork this repository to propose changes.”. If this is your first edit to The Open Data Handbook there will be a 'Fork this repository and propose changes' button. This is normal and part of the workflow. Click the button to start editing.

+

When the editable page opens it will (most likely) contain a message saying "You need to fork this repository to propose changes.". If this is your first edit to The Open Data Handbook there will be a 'Fork this repository and propose changes' button. This is normal and part of the workflow. Click the button to start editing.

-

Method B: Browse the Github repository

+#### Method B: Browse the Github repository -

The entire file structure of this site can be browsed on Github. For example, the root of the site is here, and the English language guide section of the Handbook is here. It’s helpful to understand that the page URLs correspond to the file structure you see here. So, if you wanted to edit the Open Data Guide introduction page, given that it’s URL is {{ site.url }}/guide/en/introduction/ we know this file can be found in the guide/en/introduction directory with the filename index.md Following these links you should see a preview of the page you wish to edit. From here click the edit icon [pencil icon] to start editing.

+The entire file structure of this site can be browsed on Github. For example, the root of the site is [here](https://github.com/{{ site.github_username }}/{{ site.github_repo }}), and the English language guide section of the Handbook is [here](https://github.com/{{ site.github_username }}/{{ site.github_repo }}/tree/gh-pages/guide/en). It's helpful to understand that the page URLs correspond to the file structure you see here. So, if you wanted to edit the Open Data Guide introduction page, given that it's URL is {{ site.url }}/guide/en/introduction/ we know this file can be found in the guide/en/introduction directory with the filename index.md Following these links you should see a preview of the page you wish to edit. From here click the edit icon [pencil icon] to start editing.
Pro Tip!

Press t on any tree or blob page to launch the file finder.

-

2: Make your changes

+## 2. Make your changes -

With the editable content in front of you, you’re probably either thinking “great, let’s get editing”, or “hang on, this looks a bit weird”. In case it’s the latter, let’s have a closer look. The first thing to recognise is the ‘Front Matter’, which will look like this:

+With the editable content in front of you, you're probably either thinking "great, let's get editing", or "hang on, this looks a bit weird". In case it's the latter, let's have a closer look. The first thing to recognise is the 'Front Matter', which will look like this: -
----
-title: Introduction
----
-
+ --- + title: Introduction + --- -

The front matter must be the first thing in the file, must adhere to the above syntax, and must be set between triple-dashed lines. Numerous variables can be set here, but you’ll usually just need title. The title set here will be used as the main heading for the page, as well as in the browser tab.

+The front matter must be the first thing in the file, must adhere to the above syntax, and must be set between triple-dashed lines. Numerous variables can be set here, but you'll usually just need `title`. The title set here will be used as the main heading for the page, as well as in the browser tab. -

The other important thing to recognise is the Markdown syntax. For example, where you see a line commencing with two hash marks:

+The other important thing to recognise is the Markdown syntax. For example, where you see a line commencing with two hash marks: -
-##Do you know exactly how much of your tax money is spent on street lights?
-
+ ## Do you know exactly how much of your tax money is spent on street lights? -

This is the Markdown way of creating a level two heading. On the site it will be outputted like so:

+This is the Markdown way of creating a level two heading. On the site it will be outputted like so: -

Do you know exactly how much of your tax money is spent on street lights?

+## Do you know exactly how much of your tax money is spent on street lights? -

Another common formatting requirement is bullet points, or lists. These are achieved in Markdown by using asterisks, like so:

+Another common formatting requirement is bullet points, or lists. These are achieved in Markdown by using asterisks, like so: -
-* civil servants
-* journalists
-* politicians
-
+ * civil servants + * journalists + * politicians -

giving you:

+giving you: - +* civil servants +* journalists +* politicians -

Links are created like so:

+Links are created like so: -
-Give your data a home at the [Datahub](http://datahub.io/).
-
+ Give your data a home at the [Datahub](http://datahub.io/). -

result:

+result: -

Give your data a home at the Datahub.

+Give your data a home at the [Datahub](http://datahub.io/).
Pro Tip!

To get a link to a specific heading on this site, hover over it then click the section icon [section icon]. This will show you the URL.

-

More Markdown examples can be found here, and a more detailed overview here.

+More Markdown examples can be found [here]({{ "/contribute/markdown-examples/" | prepend: site.baseurl }}), and a more detailed overview [here](http://daringfireball.net/projects/markdown/syntax). -

If you are unsure of your markup while editing, you can switch to the preview tab [eye icon] Preview changes to see how it will be rendered.

+If you are unsure of your markup while editing, you can switch to the preview tab [eye icon] Preview changes to see how it will be rendered.
Note

The Github previews will look stylistically different from the live site. A different font will be used for example.

-

Once you are happy with your changes, add a summary of what you've changed in the field below the editable text. Then click ‘Propose file change’.

+Once you are happy with your changes, add a summary of what you've changed in the field below the editable text. Then click '*Propose file change*'. -

3: Make a pull request

+## 3. Make a pull request -

You will now be presented with a ‘pull request’ form. So far, the changes you have made are to your own copy, or fork of the handbook. A pull request simply sends a request to the authors/maintainers of the live handbook, asking them to include your changes - and put them live! Add any comments you have for the handbook team, then press ‘Create pull request’.

+You will now be presented with a 'pull request' form. So far, the changes you have made are to your own copy, or fork of the handbook. A pull request simply sends a request to the authors/maintainers of the live handbook, asking them to include your changes - and put them live! Add any comments you have for the handbook team, then press '*Create pull request*'. -

Your work here is done :) If you need to make related changes though, any new commits pushed to your branch will automatically be added to the pull request.

+Your work here is done :) If you need to make related changes though, any new commits pushed to your branch will automatically be added to the pull request. diff --git a/contribute/index.md b/contribute/index.md index 442f36232..f80f3ce8f 100644 --- a/contribute/index.md +++ b/contribute/index.md @@ -6,45 +6,46 @@ authors: lang: en --- -
-

Thank you for your interest in helping to build The Open Data Handbook. We warmly welcome comments, corrections and additions, as well as suggestions for additional sections and areas to examine. For general discussion about the Handbook, please get in touch. To jump in with improvements and additions, read on.

+

Thank you for your interest in helping to build The Open Data Handbook. We warmly welcome comments, corrections and additions, as well as suggestions for additional sections and areas to examine. For general discussion about the Handbook, please get in touch. To jump in with improvements and additions, read on.

+ +## How this site works -

How this site works

-

In order to contribute, you need a little insight of how things work under the hood. We’re not going to go into too much detail here, but there are three components you need some understanding of.

+In order to contribute, you need a little insight of how things work under the hood. We're not going to go into too much detail here, but there are three components you need some understanding of. +
+
-

Github

+

Github

-

What is it?

+#### What is it? -

GitHub is a web-based repository hosting service, which amongst other things offers revision control and source code management via a web-based graphical interface.

+GitHub is a web-based repository hosting service, which amongst other things offers revision control and source code management via a web-based graphical interface. -

Why should I care?

+#### Why should I care? -

Any changes you wish to make, whether they be edits to an existing page, or creating a new one, will most likely be done via the Github website (it is also possible to download and edit the files on your local machine, instructions for this method will be added in the future). All the files for this site can be browsed and edited the Github website. You will need to sign up for a (free) Github account. For full instructions, see Editing a page.

+Any changes you wish to make, whether they be edits to an existing page, or creating a new one, will most likely be done via the Github website (it is also possible to download and edit the files on your local machine, instructions for this method will be added in the future). All the files for this site can be browsed and edited the Github website. You will need to [sign up](https://github.com/) for a (free) Github account. For full instructions, see [Editing a page](editing/). -

Jekyll

+

Jekyll

-

What is it?

+#### What is it? -

Jekyll is a static site generator, which allows us to host websites based on our GitHub repositories. Jekyll takes the content, renders Markdown, and produces a complete, static website ready to be viewed on the web.

+Jekyll is a static site generator, which allows us to host websites based on our GitHub repositories. Jekyll takes the content, renders Markdown, and produces a complete, static website ready to be viewed on the web. -

Why should I care?

+#### Why should I care? -

All you really need to know about Jekyll is the method it uses to include metadata (ie. page title). Each page needs to start with a section it calls Front Matter, containing the page title. An example is provided in the Adding a page section.

+All you really need to know about Jekyll is the method it uses to include metadata (ie. page title). Each page needs to start with a section it calls Front Matter, containing the page title. An example is provided in the [Adding a page](adding/) section. -

Markdown

+

Markdown

-

What is it?

+#### What is it? -

Markdown is a markup language with plain text formatting, designed so that it can be converted to HTML. Markdown can be used to create rich text using a plain text editor.

+Markdown is a markup language with plain text formatting, designed so that it can be converted to HTML. Markdown can be used to create rich text using a plain text editor. -

Why should I care?

+#### Why should I care? -

Markdown is your key to formatting the text you provide for this site. By learning a few intuitive rules you’ll be able to ensure your text is formatted with headings, list, quotes etc, without writing any HTML. For examples, head to the Markdown section.

-
+Markdown is your key to formatting the text you provide for this site. By learning a few intuitive rules you'll be able to ensure your text is formatted with headings, list, quotes etc, without writing any HTML. For examples, head to the [Markdown]({{ "/contribute/markdown-examples/" | prepend: site.baseurl }}) section. diff --git a/contribute/translate-glossary.md b/contribute/translate-glossary.md index 3cfaecb82..3287fbb1f 100644 --- a/contribute/translate-glossary.md +++ b/contribute/translate-glossary.md @@ -6,65 +6,62 @@ authors: - Mor Rubinstein --- -

What's new in the glossary

+## What's new in the glossary -

In the old version of the handbook, the glossary was one page with all of the term in it. In the new version, we gave each glossary a webpage for better referencing and linking.

+In the old version of the handbook, the glossary was one page with all of the terms in it. In the new version, we gave each glossary a webpage for better referencing and linking. -

Glossaries that were translated in the old version of the handbook have been transfered to the new site. Please check if your language has an old version of the glossary. You can find them here. +Glossaries that were translated in the old version of the handbook have been transfered to the new site. Please check if your language has an old version of the glossary. You can find them [here](https://github.com/{{ site.github_username }}/{{ site.github_repo }}/tree/gh-pages/glossary). -

If you do have an old version translated, follow these steps:

+## If you do have an old version translated, follow these steps: -

The old glossary format does not allow linking from the new version of the guide, and you will need to transfer the term to the new format.

+The old glossary format does not allow linking from the new version of the guide, and you will need to transfer the term to the new format. -

1. Create a new folder for the term

+### 1. Create a new folder for the term -

Under your language folder, follow the breadcrumb trail {{ site.github_repo }}/glossary/es/, to the right of which is a plus symbol [plus icon]. Create a folder for each term by pressing on the plus symbol [plus icon] and type the term name in English. The folder name should be in lower-case letters with dashes ('-') instead of white spaces. Add a slash ('/') in the end of the name to create a new folder.

+Under your language folder, follow the breadcrumb trail `{{ site.github_repo }} / glossary / es /`, to the right of which is a plus symbol [plus icon]. Create a folder for each term by pressing on the plus symbol [plus icon] and type the term name in English. The folder name should be in lower-case letters with dashes ('-') instead of white spaces. Add a slash ('/') in the end of the name to create a new folder. -

2. Translate the term

+### 2. Translate the term -

Open a new 'index.md' file by clicking on the plus symbol [plus icon].

+Open a new 'index.md' file by clicking on the plus symbol [plus icon]. -

In the text editor below add the front matter:

+In the text editor below add the front matter: -
----
-section: terms
-lang: en
-title: Bulk
----
-
+ --- + section: terms + lang: en + title: The term name + --- -

Change the 'lang' field to your language code. Change the title to the term title in YOUR language.

-

Below the front matter copy the term from the old glossary.

+Change the 'lang' field to your language code. Change the title to the term title in YOUR language. -

3. Make a pull request.

+Below the front matter copy the term from the old glossary. -

All done! Keep doing this until all terms got their own folder and page.

+### 3. Make a pull request. -

If you have never translated the glossary before, follow the these steps:

+All done! Keep doing this until all terms got their own folder and page. -

1. Copy the English glossary

+## If you have never translated the glossary before, follow the these steps: -

Copy the English terms directory into your target language directory in the glossary folder. This step can not be done through the Github website and you will have to fork the handbook for your machine. Information about forking and cloning can be find here. Notice, some languages have already been moved and translated. Check the folder to make sure you are not overwriting someone's work.

+### 1. Copy the English glossary -

2. Edit the term

+Copy the English terms directory into your target language directory in the glossary folder. This step can not be done through the Github website and you will have to fork the handbook for your machine. Information about forking and cloning can be find [here](https://help.github.com/articles/fork-a-repo/). Notice, some languages have already been moved and translated. Check the folder to make sure you are not overwriting someone's work. -

Choose a term and open the 'index.md' file.

+### 2. Edit the term -

The front matter looks as follows:

+Choose a term and open the 'index.md' file. -
----
-section: terms
-lang: en
-title: Bulk
----
-
+The front matter looks as follows: + + --- + section: terms + lang: en + title: The term name + --- -

Change the lang field to your language code. Change the title to the term title in YOUR language.

+Change the lang field to your language code. Change the title to the term title in YOUR language. -

In the text editor, below the front matter, enter your translation to the term.

+In the text editor, below the front matter, enter your translation to the term. -

3. Submit changes through a pull request.

+### 3. Submit changes through a pull request. -

All done! Thank you for your help!

+All done! Thank you for your help! diff --git a/contribute/translate-guide.md b/contribute/translate-guide.md index 02f0b977e..d25a2ac13 100644 --- a/contribute/translate-guide.md +++ b/contribute/translate-guide.md @@ -8,35 +8,33 @@ authors:

Translating the guide is easy, no need to any other software, all you need is a github account!

-

Some languages already have translated versions of the guide. If you don't have a version in your language, here is how to do it.

+Some languages already have translated versions of the guide. If you don't have a version in your language, here is how to do it. -

1. Create a new language folder

+## 1. Create a new language folder -

In github, under the breadcrumb - {{ site.github_repo }}/guide/ there will be a plus symbol [plus icon]. Click on it and enter your two letter languages code. Add a slash ('/') after the two letter to create a folder.

+In github, under the breadcrumb - `{{ site.github_repo }} / guide /` there will be a plus symbol [plus icon]. Click on it and enter your [two letter languages code](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). Add a slash ('/') after the two letter to create a folder. -

2. Create a page folder

+## 2. Create a page folder -

Now you will see your language code and a plus symbol [plus icon] on the breadcrumb. Add a page name that you want to translate in English and add a slash at the end.

+Now you will see your language code and a plus symbol [plus icon] on the breadcrumb. Add a page name that you want to translate in **English** and add a slash at the end. -

3. Translate the content

+## 3. Translate the content -

You will now see a new plus symbol [plus icon]. Add the file name 'index.md'.

+You will now see a new plus symbol [plus icon]. Add the file name 'index.md'. -

In the text editor add the following front matter:

+In the text editor add the following front matter: -
----
-section: guide
-lang: The two letter code for your language
-title: The title in your language
----
-
+ --- + section: guide + lang: The two letter code for your language + title: The title in your language + --- -

Translate as usual.

+Translate as usual. -

4. Create a pull request

+## 4. Create a pull request -

If all good, we will add it to the site.

+If all good, we will add it to the site. -

Repeat for other parts of the guide if needed. That's it, you are all done!
-Thank you for helping us to make the guide accessiable to others!

+Repeat for other parts of the guide if needed. That's it, you are all done!
+Thank you for helping us to make the guide accessiable to others! diff --git a/css/main.scss b/css/main.scss index 12a2e89f9..8bd340565 100755 --- a/css/main.scss +++ b/css/main.scss @@ -1599,6 +1599,16 @@ html.mm-background .mm-page, margin: 0 4px; } } + + &.panel { + margin-bottom:1.5em; + text-align:center; + + @include media($large-screen) { + margin-left:-10em; + margin-right:-10em; + } + } } }