Thanks Chris, sounds great!! One thing that came to mind while reading, and this is just thinking out loud, not a full blown suggestion:
"But when it comes to content, feel free to add and/or edit your projects under as you want:" Should we add a sentence to please exercise common sense about whether or not a PR is appropriate, when changing content that other people created? Best regards, Sönke On Tue, 22 Sep 2020 at 12:39, Justin Mclean <[email protected]> wrote: > > Hi, > > I correct a few minor English things, hope you don’t mind. > > Hi, > > We, the Apache Training PPMC, would like to tell you about the Apache > Training (incubating) project. > > We at Apache build all sorts of great software. Some people even create > training projects for Apache projects. > With the enormous pace of most the projects, it's almost impossible to keep > training material up-to-date. > And even if you might know a given project, preparing training material might > be too much. > Also, even if you are a great coder, whipping up presentations might not be > your favourite thing to do. > > Apache Training was created especially to help with all of this. > > We created a framework for simply writing presentations in a way they can be > easily created, versioned, branched, tagged whatsoever. > It's generally a RevealJS based presentation-framework using Asciidoctor (A > Markdown-like format but with a lot more control over the output and > additional features). > The primary supported build system is Maven. However, if you prefer, you can > also build your presentation with Ruby and Node.JS (The latter two are still > experimental). > > The output is a Browser-based presentation with a dedicated speaker view, > which also allows exporting your presentation into PDF format for > distribution. > > We would like to make Apache Training the place you look first if you are in > need of Apache related training or presentation material. > > As you probably know your projects best, who would be better suited to help > with creating this material, if not you? > > That's why the Apache Training PPMC has turned on the commit permissions for > all Apache committers. > > We trust that you will use these rights wisely. However, we do have one > restriction: > If you want to contribute to the fundamental presentation framework and the > tooling, please use PRs. > But when it comes to content, feel free to add and/or edit your projects > under as you want: > > https://github.com/apache/incubator-training/tree/develop/content > <https://github.com/apache/incubator-training/tree/develop/content> > > To get you started in no-time, we provide Maven archetypes for generating > your presentation skeleton. > In order to use this please just run: > > mvn archetype:generate -DarchetypeGroupId=org.apache.training > -DarchetypeArtifactId=content-archetype -DarchetypeVersion=1.0.0 > > This will ask you for a group-id, artifact-id, version and a package-name and > as soon as you have provided them, will generate your new presentation. > > To now build the presentation, change into the freshly created directory and > run: > > mvn package > > You can then run your presentation by opening the following file in your > browser: > > target/generated-slides/index.html > > We hope Apache Training will help you and your projects. > > The Apache Training (incubating) PPMC -- Sönke Liebau Partner Tel. +49 179 7940878 OpenCore GmbH & Co. KG - Thomas-Mann-Straße 8 - 22880 Wedel - Germany
