Skip to content

Commit

Permalink
updaet links to rtfd
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastien Varrette <Sebastien.Varrette@uni.lu>
  • Loading branch information
Sebastien Varrette authored and Sebastien Varrette committed Dec 11, 2016
1 parent eeb805a commit 9df4919
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 14 deletions.
12 changes: 6 additions & 6 deletions docs/hands-on/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
List of Tutorial Hands-on


| Id | Topic | Link |
|----|--------------------------------------------------------------|--------------------------------|
| 1 | [Documentation with Markdown and MkDocs](hands-on/docs.html) | [`hands-on/01/`](hands-on/01/) |
| 2 | VCS and Git to Share Code and Data for Reproducible Research | _(slides)_ |
| 3 | Environment Management with Vagrant | [`hands-on/03/`](hands-on/03/) |
| | | |
| Id | Topic | Link |
|----|--------------------------------------------------------------|------------|
| 1 | [Documentation with Markdown and MkDocs](docs/) | |
| 2 | VCS and Git to Share Code and Data for Reproducible Research | _(slides)_ |
| 3 | [Environment Management with Vagrant](vagrant/) | |
| | | |
14 changes: 13 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,22 @@

[![By svarrette](https://img.shields.io/badge/by-svarrette-blue.svg)](https://varrette.gforge.uni.lu) [![Licence](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](http://www.gnu.org/licenses/gpl-3.0.html)[![GitHub Project](https://img.shields.io/badge/sources-Github-green.svg)](https://github.com/Falkor/RR-tutorials/) [![GitHub issues](https://img.shields.io/github/issues/Falkor/RR-tutorials.svg)](https://github.com/Falkor/RR-tutorials/issues/) [![Build Status](https://travis-ci.org/Falkor/RR-tutorials.svg?branch=master)](https://travis-ci.org/Falkor/RR-tutorials) [![GitHub forks](https://img.shields.io/github/forks/Falkor/RR-tutorials.svg?style=social&label=Fork)](https://github.com/Falkor/RR-tutorials)

This website hosts documents, material and information related to the tutorial "__Reproducible Research at the Cloud Era__" given during the [IEEE CloudCom 2016](http://2016.cloudcom.org/) conference.

The **objective** of this tutorial is to offer a set of **practical sessions** around selected tools we consider relevant for the many challenges opened by _Reproducible Research_:

This website hosts documents, material and information related to the tutorial "__Reproducible Research at the Cloud Era__" given during the [IEEE CloudCom 2016](http://2016.cloudcom.org/) conference.
* Accurate, organized and _easy-to\{read|take|share\} Docs_
- [ Markdown](https://guides.github.com/features/mastering-markdown/), [mkdocs](http://www.mkdocs.org/), [org-mode](http://doc.norang.ca/org-mode.html), [Read the Docs](https://readthedocs.org/)...
* _Sharing Code and Data_
- [`git`](https://git-scm.com/), [Github](https://github.com/), [Bitbucket](https://bitbucket.org/), [Gitlab](https://about.gitlab.com/)...
* _Mastering your environment clean and automated_ by:
- Using common building tools \hfill{make, cmake etc.}
- Using a constrained environment
* Sandboxed Ruby/Python,[Vagrant](https://www.vagrantup.com), [Docker](https://www.docker.com/)
- Automate its building through cross-platform recipes
- Automatically test your recipes for Environment configuration

The hands-on are listed on [this page](hands-on/).


_Note:_ This documentation is built using [mkdocs.org](http://mkdocs.org).
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ pages:
- 'Directory Layout': 'contributing/layout.md'
- 'Repository Setup and Developments': 'contributing/setup.md'
- 'Semantic Versioning': 'contributing/versioning.md'
- List of Hands-on: 'hands-on/index.md'
theme: readthedocs
2 changes: 1 addition & 1 deletion slides/2016/cloudcom2016/src/_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ theme: readthedocs

### Hands-On 1: [Markdown](https://daringfireball.net/projects/markdown/syntax) \& [MkDocs](http://www.mkdocs.org/)

\wbegin{Your Turn! \hfill\myurl{http://rr-tutorials.readthedocs.io/en/latest/hands-on/01/}}
\wbegin{Your Turn! \hfill\myurl{http://rr-tutorials.readthedocs.io/en/latest/hands-on/docs/}}

* **\alert{Easy-to-\{Read | Take | Share\} Docs with MkDocs}**
- installation of MkDocs \hfill{}\myurl{http://www.mkdocs.org/\#installation}
Expand Down
4 changes: 2 additions & 2 deletions slides/2016/cloudcom2016/src/_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
. . .

\begin{tcolorbox}\centering\scriptsize
\url{http://rr-tutorials.readthedocs.io/en/latest/hands-on/03/}
\url{http://rr-tutorials.readthedocs.io/en/latest/hands-on/vagrant/}
\end{tcolorbox}

\scriptsize
\hfill{}**\alert{IF NOT YET DONE:}** \myurl{http://rr-tutorials.readthedocs.io/en/latest/setup/ }
\hfill{}**\alert{IF NOT YET DONE:}** \myurl{http://rr-tutorials.readthedocs.io/en/latest/setup/}

### Grab the [Code/Data] Source

Expand Down
8 changes: 4 additions & 4 deletions slides/2016/cloudcom2016/src/_vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ end

### Back to Hands-on 1

\wbegin{Your Turn! \hfill\myurl{http://rr-tutorials.readthedocs.io/en/latest/hands-on/03/}}
\wbegin{Your Turn! \hfill\myurl{http://rr-tutorials.readthedocs.io/en/latest/hands-on/vagrant/}}

* **\alert{Steps [1-4]}** to cover the following elements:
- _Basic Usage of Vagrant_
Expand Down Expand Up @@ -174,7 +174,7 @@ SHELL

### Vagrant Box Inline Provisioning

\wbegin{Your Turn! \hfill\myurl{http://rr-tutorials.readthedocs.io/en/latest/hands-on/03/}}
\wbegin{Your Turn! \hfill\myurl{http://rr-tutorials.readthedocs.io/en/latest/hands-on/vagrant/}}

* **\alert{Steps 5}**:
- adapt the `Vagrantfile` to embed your commands
Expand All @@ -200,7 +200,7 @@ yum install -y <package> # CentOS/ Redhat
config.vm.provision "shell", path: "<script>.{sh|py|rb}"
~~~

\wbegin{Your Turn! \hfill\myurl{http://rr-tutorials.readthedocs.io/en/latest/hands-on/03/}}
\wbegin{Your Turn! \hfill\myurl{http://rr-tutorials.readthedocs.io/en/latest/hands-on/vagrant/}}

* **\alert{Steps 6}**: copy and adapt `vagrant/bootstrap.sample.sh`
- adapt the `Vagrantfile` to provision the VM with your script
Expand Down Expand Up @@ -308,7 +308,7 @@ $> vagrant package \

### Vagrant Box Packaging

\wbegin{Your Turn! \hfill\myurl{http://rr-tutorials.readthedocs.io/en/latest/hands-on/03/}}
\wbegin{Your Turn! \hfill\myurl{http://rr-tutorials.readthedocs.io/en/latest/hands-on/vagrant/}}

* **\alert{Steps 7-8}**: Package your box and diffuse it on [Vagrant Cloud](https://vagrantcloud.com)
- Make preliminary checks
Expand Down

0 comments on commit 9df4919

Please sign in to comment.