Skip to content

Commit 8d196c2

Browse files
WasabiFanWasabiFan
committed
Merge upstream/master into 'add-ci-config'
2 parents 09b94d0 + a3e3fc3 commit 8d196c2

37 files changed

Lines changed: 195 additions & 193 deletions

‎README.md‎

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -48,21 +48,10 @@ Now you should be able to visit your page at: [http://localhost:4000](http://loc
4848
Previewing Your Changes Online
4949
---
5050

51-
When forking, you can create a new branch called `gh-pages`, then your
52-
changes can be viewed as `http://<user>.github.io/ev3dev.github.io`. When you do this
53-
though, GitHub will send you lots of email like this, which you should ignore.
54-
55-
The page build completed successfully, but returned the following warning:
56-
57-
CNAME already taken: www.ev3dev.org
58-
59-
For information on troubleshooting Jekyll see:
60-
61-
https://help.github.com/articles/using-jekyll-with-pages#troubleshooting
62-
63-
If you have any questions please contact us at https://github.com/contact.
64-
65-
If it really gets on your nerves, you can rename the `CNAME` file. Just make sure to
66-
change it back before you submit your pull request.
67-
68-
51+
We have a special script to use to publish your changes using the `gh-pages`
52+
branch of your fork of ev3dev.github.io. If you have SSH setup for your GitHub
53+
account, simply run`./publish <gh-user>` where *gh-user* is your actual GitHub
54+
user name. If you don't have SSH setup, you can use https by running
55+
`./publish https://github.com/<gh-user>/ev3dev.github.io.git` instead.
56+
This will copy the contents of `_site`, fix it up a bit and push it to your
57+
fork on GitHub. You can view the results at `http://<gh-user>.github.io/ev3dev.github.io`.

‎_config.yml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
markdown: kramdown
22
permalink: pretty
3-
exclude: [README.md, Gemfile, Gemfile.lock, "repo-metadata.html", vendor, cibuild.sh, .travis.yml]
3+
exclude:
4+
- README.md
5+
- Gemfile
6+
- Gemfile.lock
7+
- repo-metadata.html
8+
- publish.rb
9+
- vendor
10+
- cibuild.sh
11+
- .travis.yml
412

513
gems:
614
- jekyll-mentions

‎_includes/head.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,31 @@
44
<meta http-equiv="X-UA-Compatible" content="IE=edge">
55

66
<title>{{ page.title }}</title>
7-
<link rel="alternate" type="application/atom+xml" href="{{ site.github.url }}/news/atom.xml" title="Atom feed">
7+
<link rel="alternate" type="application/atom+xml" href="/news/atom.xml" title="Atom feed">
88
<link rel="icon" href="favicon.ico" />
99

1010
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
11-
<link rel="stylesheet" href="{{ site.github.url }}/stylesheets/bootstrap.css">
12-
<link rel="stylesheet" href="{{ site.github.url }}/stylesheets/bootstrap-extensions.css">
11+
<link rel="stylesheet" href="/stylesheets/bootstrap.css">
12+
<link rel="stylesheet" href="/stylesheets/bootstrap-extensions.css">
1313
<!-- Nav infrastructure and misc utils (search, user cards, embeds, CC license) -->
14-
<link rel="stylesheet" href="{{ site.github.url }}/stylesheets/infrastructure-utils.css" />
14+
<link rel="stylesheet" href="/stylesheets/infrastructure-utils.css" />
1515

1616
<!-- 3rd-party libraries -->
1717
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js"></script>
1818
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
19-
<script src="{{ site.github.url }}/javascripts/jquery.getUrlParam.js"></script>
20-
<script src="{{ site.github.url }}/javascripts/jquery.loadTemplate-1.4.4.min.js"></script>
21-
<script src="{{ site.github.url }}/javascripts/respond.js"></script>
22-
<script src="{{ site.github.url }}/javascripts/ua-parser.min.js"></script>
19+
<script src="/javascripts/jquery.getUrlParam.js"></script>
20+
<script src="/javascripts/jquery.loadTemplate-1.4.4.min.js"></script>
21+
<script src="/javascripts/respond.js"></script>
22+
<script src="/javascripts/ua-parser.min.js"></script>
2323

2424
<!-- Loads user-cards from GH API -->
25-
<script src="{{ site.github.url }}/javascripts/cards.js"></script>
25+
<script src="/javascripts/cards.js"></script>
2626
<!-- Responds to queries typed into the "Quick nav" box -->
27-
<script src="{{ site.github.url }}/javascripts/search.js"></script>
27+
<script src="/javascripts/search.js"></script>
2828
<!-- Converts static descriptors of tab target content into live text and links -->
29-
<script src="{{ site.github.url }}/javascripts/tabs.js"></script>
29+
<script src="/javascripts/tabs.js"></script>
3030
<!-- Adds classes and other styles to pages where hard-coded css can't be used -->
31-
<script src="{{ site.github.url }}/javascripts/style-helpers.js"></script>
31+
<script src="/javascripts/style-helpers.js"></script>
3232

3333
<!--[if lt IE 9]>
3434
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>

‎_includes/header.html‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
<span class="icon-bar"></span>
88
<span class="icon-bar"></span>
99
</button>
10-
<a class="navbar-brand" href="{{ site.github.url }}/">
11-
<img id="brand-logo" src="{{ site.github.url }}/images/ev3dev_logo_white.png" alt="ev3dev logo" />
10+
<a class="navbar-brand" href="/">
11+
<img id="brand-logo" src="/images/ev3dev_logo_white.png" alt="ev3dev logo" />
1212
</a>
1313
</div>
1414
<div class="collapse navbar-collapse">
1515
<ul class="nav navbar-nav" id="main-nav">
1616
<li>
17-
<a href="{{ site.github.url }}/" title="There's no place like Home...">Home</a>
17+
<a href="/" title="There's no place like Home...">Home</a>
1818
</li>
1919
<li class="dropdown">
2020
<a class="dropdown-toggle" href="#main-nav" data-toggle="dropdown" title="Documentation on using ev3dev">
@@ -23,26 +23,26 @@
2323
</a>
2424
<ul class="dropdown-menu">
2525
<li>
26-
<a href="{{ site.github.url }}/docs/getting-started">Getting Started</a>
26+
<a href="/docs/getting-started">Getting Started</a>
2727
</li>
2828
<li>
29-
<a href="{{ site.github.url }}/docs/tutorials">Tutorials</a>
29+
<a href="/docs/tutorials">Tutorials</a>
3030
</li>
3131
<li role="separator" class="divider"></li>
3232
<li>
33-
<a href="{{ site.github.url }}/docs/motors">Motors</a>
33+
<a href="/docs/motors">Motors</a>
3434
</li>
3535
<li>
36-
<a href="{{ site.github.url }}/docs/sensors">Sensors</a>
36+
<a href="/docs/sensors">Sensors</a>
3737
</li>
3838
<li role="separator" class="divider"></li>
3939
<li>
40-
<a href="{{ site.github.url }}/docs">More...</a>
40+
<a href="/docs">More...</a>
4141
</li>
4242
</ul>
4343
</li>
4444
<li>
45-
<a href="{{ site.github.url }}/news" title="News about ev3dev">News</a>
45+
<a href="/news" title="News about ev3dev">News</a>
4646
</li>
4747
<li class="dropdown">
4848
<a class="dropdown-toggle" data-toggle="dropdown" href="#main-nav">
@@ -51,16 +51,16 @@
5151
</a>
5252
<ul class="dropdown-menu">
5353
<li>
54-
<a href="{{ site.github.url }}/projects" title="Discover projects that use ev3dev">Projects</a>
54+
<a href="/projects" title="Discover projects that use ev3dev">Projects</a>
5555
</li>
5656
<li>
57-
<a href="{{ site.github.url }}/share" title="Share projects that use ev3dev">Share</a>
57+
<a href="/share" title="Share projects that use ev3dev">Share</a>
5858
</li>
5959
<li>
60-
<a href="{{ site.github.url }}/contribute" title="How to contribute to ev3dev">Contribute</a>
60+
<a href="/contribute" title="How to contribute to ev3dev">Contribute</a>
6161
</li>
6262
<li>
63-
<a href="{{ site.github.url }}/support" title="Found a bug? Have a question?">Get Help</a>
63+
<a href="/support" title="Found a bug? Have a question?">Get Help</a>
6464
</li>
6565
</ul>
6666
</li>

‎_includes/inline-screenshot.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div class="screenshot inline-screenshot pull-right">
2-
<a href="{{ site.github.url }}{{ include.source }}">
3-
<img src="{{ site.github.url }}{{ include.source }}" />
2+
<a href="{{ include.source }}">
3+
<img src="{{ include.source }}" />
44
</a>
55
<p>
66
<small>

‎_includes/screenshot.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
source: The url of the image
88
caption: (optional) A caption that is displayed under the image.
99

10-
{% endcomment %}<span class="screenshot"><a href="{{ site.github.url }}{{ include.source }}"><img src="{{ site.github.url }}{{ include.source }}" class="img-responsive" alt="screenshot"/></a>{% if include.caption %}<p><small>{{ include.caption }}</small></p>{% endif %}</span>
10+
{% endcomment %}<span class="screenshot"><a href="{{ include.source }}"><img src="{{ include.source }}" class="img-responsive" alt="screenshot"/></a>{% if include.caption %}<p><small>{{ include.caption }}</small></p>{% endif %}</span>

‎_includes/title.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ <h1>
1717
{% if edit_path %}
1818
<a class="btn btn-primary pull-right" href="{{ edit_path }}">Edit on Github</a>
1919
{% elsif show_news_link %}
20-
<a class="btn btn-primary pull-right" href="{{ site.github.url }}/news/atom.xml">Subscribe via Atom</a>
20+
<a class="btn btn-primary pull-right" href="/news/atom.xml">Subscribe via Atom</a>
2121
{% endif %}
2222
</h1>
2323
</div>

‎docs/getting-started.md‎

Lines changed: 6 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ First, here are the things you need before starting:
3434
The instructions on this page only apply to releases dated December
3535
2015 or later. Older releases are no longer supported. There are many major changes
3636
in the December release, so if something seems broken or the documentation seems incorrect,
37-
please [open an issue on GitHub]({{ site.github.url }}/support){: .alert-link}.
37+
please [open an issue on GitHub](/support){: .alert-link}.
3838
{: .alert .alert-warning}
3939

4040
## Step 1: Download the latest ev3dev image file
@@ -118,7 +118,7 @@ You will notice the number in the battery in the upper right corner. This
118118
displays the remaining voltage of the power supply. It is not possible to
119119
calculate an accurate percent value of the remaining energy, so this value is
120120
chosen. If the voltage drops below 5V the brick will turn off. All not saved
121-
data may be lost. Keep in mind, that is may take a much longer time from 8V to
121+
data may be lost. Keep in mind, that it may take a much longer time from 8V to
122122
6.5V than from 6.5V down to 5V!
123123

124124
<div class="panel panel-info">
@@ -157,55 +157,7 @@ to connect for the first time. You can setup additional connections using the
157157
`connmanctl` command.
158158
{: class="alert alert-info"}
159159

160-
## Step 5: First things to do with ev3dev
161-
162-
Here are some suggestions of some things you should do to get ev3dev setup.
163-
These commands are run on the EV3 in a terminal window. See the networking
164-
tutorials above if you don't know how to open terminal window and connect via SSH.
165-
166-
### Change your password
167-
168-
The default password is `maker`.
169-
170-
robot@ev3dev:~$ passwd
171-
Enter new UNIX password:
172-
Retype new UNIX password:
173-
passwd: password updated successfully
174-
175-
### Set the time zone
176-
177-
robot@ev3dev:~$ sudo dpkg-reconfigure tzdata
178-
179-
Then just follow the instructions on the screen.
180-
181-
{% include icon.html type="info" %}
182-
The EV3 and Raspberry Pi do not have a battery backup for the realtime clock.
183-
Whenever you remove the batteries, the clock will be reset. If the EV3 is
184-
connected to the Internet, the clock will be automatically set via NTP,
185-
otherwise, you can manually set the date/time with the `date` command.
186-
{: class="alert alert-info"}
187-
188-
### Set the locale
189-
190-
You can skip this if en-US is OK.
191-
192-
robot@ev3dev:~$ sudo dpkg-reconfigure locales
193-
194-
### Update packages
195-
196-
Make sure your EV3 is connected to the Internet first.
197-
Updating the packages for the first time will take minutes.
198-
The duration depends on the speed class of the SD card and on the updates involved.
199-
200-
robot@ev3dev:~$ sudo apt-get update
201-
robot@ev3dev:~$ sudo apt-get upgrade
202-
robot@ev3dev:~$ sudo apt-get dist-upgrade
203-
204-
If a new kernel package is installed, you will need to reboot.
205-
206-
robot@ev3dev:~$ sudo reboot
207-
208-
## Step 6: Do something awesome
160+
## Step 5: Do something awesome
209161

210162
This will be where we tell you how to use the EV3's main functions, and how
211163
to write programs. We are still learning, so everything here should be
@@ -218,8 +170,8 @@ Here are some guides for using each of the major components.
218170
* [Sensors](/docs/sensors)
219171
* [Motors](/docs/tutorials/tacho-motors/)
220172
* [Sound](https://github.com/ev3dev/ev3dev/wiki/Using-Sound)
221-
* [LCD](/docs/tutorials/LCD/)
222-
* [Buttons](/docs/tutorials/buttons/)
173+
* [LCD](/docs/tutorials/using-ev3-lcd/)
174+
* [Buttons](/docs/tutorials/using-ev3-buttons/)
223175
* [LEDs](https://github.com/ev3dev/ev3dev/wiki/Using-the-LEDs)
224176
* [Bluetooth](https://github.com/ev3dev/ev3dev/wiki/Using-Bluetooth)
225177

@@ -236,7 +188,7 @@ hang of it, you can even write your own interface library and have it listed her
236188

237189
{% include inline-screenshot.html source="/images/brickman/shutdown-menu.png" caption="The 'Shutdown...' dialog in Brickman" %}
238190

239-
## Step 7: Calling it a day
191+
## Step 6: Calling it a day
240192

241193
When you are ready to wish your EV3 goodnight, turn if off by pressing the
242194
*back* button from the main menu in brickman or pressing and holding the *back*

‎docs/sensors/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,12 +201,12 @@ kernel.
201201
[LEGO 8528]: http://www.bricklink.com/catalogItem.asp?S=8528-1
202202
[I2C protocol]: https://en.wikipedia.org/wiki/I2c
203203
[I2C Sensor Addressing]: i2c-sensor-addressing
204-
[lego-port class]: http://www.ev3dev.org/docs/drivers/lego-port-class
204+
[lego-port class]: /docs/drivers/lego-port-class
205205
[Using I2C Sensors]: using-i2c-sensors
206206
[UART]: https://en.wikipedia.org/wiki/Uart
207207
[using-uart-sensors-on-any-linux]: http://lechnology.com/2014/09/using-uart-sensors-on-any-linux/
208208
[opening an issue]: https://github.com/ev3dev/ev3dev/issues
209-
[contributing page]: http://www.ev3dev.org/contributing/
209+
[contributing page]: /contributing/
210210
[lego-sensor class]: /docs/drivers/lego-sensor-class
211211
[EV3 Input Port Driver]: /docs/ports/legoev3-input-port
212212
[Supported Sensors]: #supported-sensors

‎docs/tutorials/adding-new-project.md‎

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -39,29 +39,12 @@ looking at your own copy.
3939

4040
##Step 2: Setting Up A Preview (Optional)
4141

42-
If you want to be able to preview your new page before you submit it, and are
43-
willing to add a bit of extra complexity, you have to create a new branch
44-
called `gh-pages`. Adding this branch will let you preview the whole site, so
45-
you can see how your page will look when it is published (which is different
46-
from the markdown preview that you will see on GitHub). To do this, click the
47-
box where it says "branch: master". It should expand to show you a text box.
48-
Type the text `gh-pages` in to the box that appears (make sure that it is
49-
exactly that text; this is important). It should give you the option to create
50-
a new branch; click that button.
51-
52-
{% include screenshot.html source="/images/Website/Branching-on-GitHub.png" scale="50" %}
53-
54-
Now, you should be able to navigate to
55-
`http://<username>.github.io/ev3dev.github.io` in a new tab to see your copy of
56-
the site. After you complete step 3, visit this preview URL again to make sure
57-
that your page looks as it should.
58-
59-
If you complete this step, note that everywhere it says "`master`" in the
60-
screenshots below, it should say "`gh-pages`" instead.
61-
62-
*WARNING*: If you complete this step, GitHub will send you emails warning you
63-
about the CNAME. You can ignore them; but if they get annoying, see [the readme]
64-
on the official site repo for information on circumventing the problem.
42+
If you want to be able to preview your new page before you submit it, and you are
43+
willing to add a bit of extra complexity, you can do so by using the `./publish.rb`
44+
script. This involves cloning the ev3dev.github.io repository on your local
45+
computer and installing ruby. See the ev3dev.github.io [README] for more info.
46+
47+
[README]: https://github.com/ev3dev/ev3dev.github.io#readme
6548

6649
##Step 3: Adding Your Page
6750

@@ -132,12 +115,12 @@ to submit your changes.
132115
The project maintainers will be notified automatically that you have submitted
133116
edits, and will review and merge your changes when they get the chance.
134117

135-
[projects page]: {{ site.github.url }}/projects
118+
[projects page]: /projects
136119
[mindsensor.com]: http://mindsensors.com/
137120
[projects folder]: https://github.com/ev3dev/ev3dev.github.io/tree/master/projects/_posts
138121
[kramdown basics]: http://kramdown.gettalong.org/quickref.html
139122
[template project]: https://github.com/ev3dev/ev3dev.github.io/blob/master/projects/_posts/2014-03-21-Example-Project.md
140-
[template page]: http://www.ev3dev.org/projects/2014/03/21/Example-Project/
123+
[template page]: /projects/2014/03/21/Example-Project/
141124
[raw template]: https://raw.githubusercontent.com/ev3dev/ev3dev.github.io/master/projects/_posts/2014-03-21-Example-Project.md
142125
[website repository]: http://github.com/ev3dev/ev3dev.github.io
143126
[the readme]: https://github.com/ev3dev/ev3dev.github.io

0 commit comments

Comments
 (0)