blob: 1cc0095d3f6b6f5a93e3b6141de5b8f4e90d8c82 [file] [log] [blame]
//
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
:imagesdir: ../images/
== Creating Presentation with Apache Training
Currently the setup uses https://asciidoctor.org/[Asciidoctor] to write content and builds the presentation using https://maven.apache.org/[Apache Maven] and https://revealjs.com/#/[Reveal.JS].
We have prepared everything that it should be pretty simple to get started with creating a new presentation.
Requirements:
- Java 8 or newer
- Maven 3.3 or newer
In order to create an empty presentation to start with, please execute the following command:
mvn -Dmaven.repo.remote=https://repository.apache.org/content/repositories/snapshots org.apache.maven.plugins:maven-archetype-plugin:3.1.2:generate -DarchetypeGroupId=org.apache.training -DarchetypeArtifactId=content-archetype -DarchetypeVersion=1.0.0-SNAPSHOT
After choosing `groupId`, `artifactId`, `version` and `package` there should be a new directory that matches the `artifactId` that you selected.
Change into this directory and run the following command to build the presentation:
mvn package
After that, there should be a directory `target/generated-slides`.
If you open the `index.html` in that directory your presentation should open in the browser.