Skip to content
Snippets Groups Projects
Commit b8045063 authored by Jose Torres's avatar Jose Torres
Browse files

Add guide to index. Add RevealJS getting started. Add static_content.

parent 76c9ab50
No related branches found
No related tags found
1 merge request!14WIP: Contributing to GLU
Pipeline #
Loading
Loading
@@ -2,8 +2,4 @@
 
This repository contains documents related to GitLab University.
 
For most information, see [the website](https://about.gitlab.com/university/).
## Viewing Slides
Use [Deckset](http://www.decksetapp.com/) to view the slides in a nice way.
For most information, see [the website](https://about.gitlab.com/university/).
\ No newline at end of file
# Getting Started with RevealJS
RevealJS is a presentation library that can render MarkDown as slides on
your browser using JavaScript. To use the complete version we'll run
the full setup described below.
## Pre Requisites
1. Install [Node.js](http://nodejs.org/)
2. Install [Grunt](http://gruntjs.com/getting-started#installing-the-cli)
Create a directory for your new presentation and run the following
commands to setup the project. Note the data-markdown attribute on the
section script.
## Full setup
1. Clone: `git clone https://github.com/hakimel/reveal.js.git`
2. Navigate to: `cd reveal.js`
3. Install. `npm install`
4. Run server: `grunt serve`
After successfully installing RevealJS edit the index.html to add each
slide. For markdown we can use a section with MarkDown within a template
script.
```
<section data-markdown>
<script type="text/template">
## Page title
A paragraph with some text and a [link](http://gitlab.com).
</script>
</section>
```
The recommended approach is to use external MarkDown files that point to
your GLU repository and link to each md file.
>Note the separator arguments which determine how slides are delimited
in the external file. The data-charset attribute is optional and
specifies which charset to use when loading the external file.
You can add a new directory with the content you'd like to use from the
University project and link to it with the following syntax.
```
<section data-markdown="training/user_training.md"
data-separator="^\n\n\n"
data-separator-vertical="^\n\n"
data-separator-notes="^Note:"
data-charset="iso-8859-15">
</section>
```
There are also plugins that can be used such as
[Chalkboard](http://courses.telematique.eu/reveal.js-plugins/chalkboard-demo.html#/)
listed on the reference below.
## Reference
* https://github.com/hakimel/reveal.js
* https://github.com/hakimel/reveal.js/wiki/Plugins,-Tools-and-Hardware
* http://htmlcheats.com/reveal-js/reveal-js-tutorial-reveal-js-for-beginners/
Loading
Loading
@@ -32,16 +32,59 @@ please submit a merge request to add an upcoming class, assign to
 
### How to make a recording
 
To record your screen you can use any tool available for your
environment such as [QuickTime](https://www.apple.com/es/quicktime/) for
Mac. You'll also need a video editing tool such as [Movie Maker](http://windows.microsoft.com/en-us/windows/movie-maker)
for Windows or [iMovie](https://www.apple.com/mac/imovie/) for mac.
 
### How to upload to Youtube
1. Create an outline of your videos workflow with screens, images, or
concepts you'd like to share.
2. Create a script that matches the above outline. This is a good place
to measure and tweak the time the video will take.
3. Create you video without recording any sound. Just following your
outline.
4. Record the audio following your script and reviewing the video.
5. Patch them together. You'll be able to fast forward or delay screens,
as well as add graphics or other media on sections where you need
more time to explain a concept.
### How to share through GitLab's YouTube Channel
This channel is where all our videos will be hosted so after you've
finished your recording you'll need to upload it to your Google drive
and share the link with person managing content. They will review and if
accepted it will be uploaded to YouTube.
### How to generate a presentation from markdown
There are plenty tools that will render slides from markdown. Some that
we use are:
1. [Deckset](http://www.decksetapp.com/) for Mac (paid).
2. [RevealJS](https://github.com/hakimel/reveal.js) cross platform and
open source.
RevealJS will render a web presentation while Deckset renders the
presentation within the app.
You can find a guide on how to setup a presentation on RevealJS at
[Getting Started with RevealJS](getting_started_revealjs.md).
 
 
### How to generate pdfs from markdown
 
Each tool has its own way of generating pdfs. Deckset for example can
export but RevealJS uses the browser to render a pdf. The latter can
be accomplished by following the guide at https://github.com/hakimel/reveal.js#pdf-export.
 
### How to add a pdf to the repo
 
### How to add a pdf to the repo
 
To add static content or content that cannot be contributed to such as
pdfs you can upload them to the `static_content` directory. Shared
content such as Google slides can be added to the directories
[README](../static_content/README.md).
 
 
[» Back](../)
# Content Description
This directory holds rendered content. This type of content usually
can't be contributed to such as PDFs.
## Shared content
Shared presentations such as public Google slides can be listed here.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment