You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@training.apache.org by rs...@apache.org on 2020/05/29 14:56:29 UTC
[incubator-training] branch master updated: TRAINING-31 Create
directory for Apache Community Development (ComDev) material (#65)
This is an automated email from the ASF dual-hosted git repository.
rskraba pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-training.git
The following commit(s) were added to refs/heads/master by this push:
new 1b9cdc0 TRAINING-31 Create directory for Apache Community Development (ComDev) material (#65)
1b9cdc0 is described below
commit 1b9cdc0e8baa1e7af63603991662ebcff73a02bd
Author: sharanf <sh...@apache.org>
AuthorDate: Fri May 29 16:56:23 2020 +0200
TRAINING-31 Create directory for Apache Community Development (ComDev) material (#65)
* Added New ComDev directory
* Added introduction to ComDev presentation to ComDev directory
* Fixed spelling mistakes and added some additional speaker notes
* Update content/ComDev/src/main/asciidoc/index.adoc
Fix typo in presentation description.
Co-authored-by: RyanSkraba <ry...@skraba.com>
* Update content/ComDev/src/main/asciidoc/index.adoc
Fix typo in in presentation.
Co-authored-by: RyanSkraba <ry...@skraba.com>
* Update content/ComDev/src/main/asciidoc/index.adoc
Fixed typo.
Co-authored-by: RyanSkraba <ry...@skraba.com>
* Update content/ComDev/src/main/asciidoc/index.adoc
Fix typo.
Co-authored-by: RyanSkraba <ry...@skraba.com>
* Update content/ComDev/src/main/asciidoc/index.adoc
Added missing closing bracket
Co-authored-by: RyanSkraba <ry...@skraba.com>
* Update content/ComDev/src/main/asciidoc/index.adoc
Correct formatting error. Add extra space.
Co-authored-by: RyanSkraba <ry...@skraba.com>
* Moved presentation into a new ComDevIntro subdirectory
* Minor adjustments and remove unnecessary files
* Remove subdir examples as not used
* Delete pom.xml
* Delete StringUtils.java
* Delete _settings.adoc
* Delete index.adoc
* Delete duplicate of ApacheLogo.png
* Delete duplicate photo
* Delete duplicate handshake graphic
Co-authored-by: RyanSkraba <ry...@skraba.com>
---
content/ComDev/ComDevIntro/README.md | 66 +++++++++
content/ComDev/ComDevIntro/pom.xml | 39 ++++++
.../ComDevIntro/src/main/asciidoc/_settings.adoc | 36 +++++
.../ComDevIntro/src/main/asciidoc/index.adoc | 151 +++++++++++++++++++++
.../src/main/resources/images/ApacheLogo.png | Bin 0 -> 82055 bytes
.../resources/images/handshake-2009183_1920-1.png | Bin 0 -> 1726721 bytes
6 files changed, 292 insertions(+)
diff --git a/content/ComDev/ComDevIntro/README.md b/content/ComDev/ComDevIntro/README.md
new file mode 100644
index 0000000..1845bc1
--- /dev/null
+++ b/content/ComDev/ComDevIntro/README.md
@@ -0,0 +1,66 @@
+<!--
+
+ 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.
+
+-->
+
+# Presentation with Reveal.JS and AsciiDoctor
+
+Remarks:
+- Currently it seems as if the system can't detect the 'docinfo' files, so we have to replace the `document.html.slim` file from `asciidoctor-reveal.js` with an updated one, that adds some additional js and css references. This template is located in `libs/docinfo-hack`.
+- In order to use the preview of the IntelliJ asciidoctor plugin, you need to set an attribute in the plugin settings: `imagesdir` = `../resources/images`
+- Even if it is possible to run the presentation directly from the `generated-slides` directory, some JavaScript extensions don't work in this case. Therefore it is required to run the presentation from a local webserver.
+- In order to generate the diagrams, GraphVIS needs to be installed locally. Get it from: http://www.graphviz.org/
+- The template is adjusted to use the codecentric font `Panton`, so be sure to have that installed on your presentation machine.
+- Any css adjustments can go to `src/main/theme/cc.css` as this is automatically embedded into the themes directory.
+
+## Building the presentation
+
+By running the following command, you can generate the presentation:
+
+ mvn clean package
+
+## Running the presentation
+
+In order to start a local web server serving the presentation, execute the following command:
+
+ mvn jetty:run-exploded
+
+As soon as that's done, just point your browser to:
+
+ http://localhost:8080/
+
+## Generating PDF versions
+
+In order to generate a PDF version of the presentation just add `?print-pdf` to the url. (Keep in mind, that you have to add it before any `#blahblah`)
+
+The following link should do the trick:
+
+ http://localhost:8080/?print-pdf
+
+As soon as that's loaded, just use the normal `print` functionality of the browser and `print as PDF`.
+
+## Installing third party software:
+
+### Mermaid
+
+ npm install mermaid.cli
+
+This will install mermaid under `node_modules/.bin/mmdc`.
+
+### PhantomJS
+
+https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-macosx.zip
diff --git a/content/ComDev/ComDevIntro/pom.xml b/content/ComDev/ComDevIntro/pom.xml
new file mode 100644
index 0000000..01d4d1b
--- /dev/null
+++ b/content/ComDev/ComDevIntro/pom.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+ 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.
+
+--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.training</groupId>
+ <artifactId>content-master-pom</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+
+ <!-- Required in our case as per http://maven.apache.org/ref/3.0.3/maven-model/maven.html#class_parent -->
+ </parent>
+
+ <artifactId>ComDevIntro</artifactId>
+
+ <groupId>org.apache.training</groupId>
+ <version>1.0.0.SNAPSHOT</version>
+ <packaging>war</packaging>
+
+ <name>Introduction to Community Development: What is this ComDev Thing?</name>
+ <description>A short 30 minute introduction talk about what Apache Community Development is.</description>
+
+</project>
diff --git a/content/ComDev/ComDevIntro/src/main/asciidoc/_settings.adoc b/content/ComDev/ComDevIntro/src/main/asciidoc/_settings.adoc
new file mode 100644
index 0000000..261a396
--- /dev/null
+++ b/content/ComDev/ComDevIntro/src/main/asciidoc/_settings.adoc
@@ -0,0 +1,36 @@
+////
+
+ 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.
+
+////
+
+:goto:
+:menu:
+:navigation:
+:status:
+:arrows:
+:revealjs_theme: cc_black
+:revealjs_progress: true
+:revealjs_slidenumber: true
+:pdf-page-size: A4
+:revealjs_center: false
+:revealjs_history: true
+:icons: font
+:imagesdir: images
+:sourcedir: ../java
+:title-slide-background-image: background-dark-orig.jpg
+:idprefix:
+:idseparator: -
diff --git a/content/ComDev/ComDevIntro/src/main/asciidoc/index.adoc b/content/ComDev/ComDevIntro/src/main/asciidoc/index.adoc
new file mode 100644
index 0000000..9608879
--- /dev/null
+++ b/content/ComDev/ComDevIntro/src/main/asciidoc/index.adoc
@@ -0,0 +1,151 @@
+////
+
+ 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.
+
+////
+
+include::_settings.adoc[]
+:presenter_name: Your Name
+:presenter_company: Your Company
+:description: A short 30 minute introduction talk about what Apache Community Development is
+:keywords: ComDev, Community Development
+:author: Your Name
+:email: Your email
+:position: Your role
+
+== What is this ComDev thing?
+
+image::ApacheLogo.png[]
+
+== Who am I?
+{author} +
+{position} +
+{email} +
+
+[NOTE.speaker]
+--
+Please add your own details here
+--
+
+== What am I going to cover?
+* What is ComDev?
+* What does it do?
+* Why do we have it at the ASF?
+* What resources do we have available?
+* Get feedback from you!
+
+== What is ComDev?
+* 'Community Development' http://community.apache.org/
+* An Apache project that isn't focussed on producing software
+* It plays a key role in helping support collaboration and attracting new contributors
+* It has an internal and external role
+
+[NOTE.speaker]
+--
+How do we develop communities? We help support and grow them.
+Why is it important to support communities? Shouldn't they be able to support themselves? (Yes and No)
+The objective is to create self sustaining communities but there is a lifecycle for open source projects and sometimes projects need a little help just like anyone else.
+We work internally within the ASF and also externally doing things such as outreach.
+--
+
+== What is Community Development?
+* Providing resources and information for developing communities
+* Supporting and helping communities grow
+* Attracting new contributors
+
+[NOTE.speaker]
+--
+The ASF has lots and lots of projects and so we are a central place they can find out information.
+Also if a project has done something good that has helped the community - why not share it with other ASF projects? They may be looking for the same thing!
+New contributors can come from within the ASF or outside it, which is why ComDev has both an internal and external focus.
+--
+
+== Why is it important to support open source communities?
+[%step]
+* Generally projects start small so need support to grow
+* Open source is about being open and sharing the workload
+* Encourage sustainability and attract new contributors
+
+== Contributors - The missing link?
+* Lots of open source projects and lots of potential contributors BUT
+** People don't realise they can contribute
+** People don't know how to contribute
+** People may not know where to find out or even ask
+** People think only developers can contribute
+* Projects are looking for you!
+
+[NOTE.speaker]
+--
+The most important point to note is that a lot of people dont realise that they can contribute, or dont know how to!
+So the first thing we focus on is getting the message out to people to let them know that all our projects and are always looking for new contributors. People to help with coding, documentation, event management, graphics, webdesign, training and anything else.
+
+The second thing we focus on is giving them information on how to contribute and participate. So as a new person who doesn't know anything. We help you get started.
+--
+
+== Community Development at the ASF
+* We have lots of projects!
+* Central place for basic information about where to start
+* We provide tools, processes and advice
+* We also coordinate and manage common tasks within the ASF (eg GSoC, Logo Repository, Info Brochure, Stickers etc)
+* We create tools (eg projects.a.o, people.a.o, reporter.a.o, helpwanted.a.o)
+
+[NOTE.speaker]
+--
+Remember I said we dont focus on producing software? We don't! But that doesn't mean that we don't produce any.
+In fact we do provide software tools that make things easier for our projects. So we have a tool where you can find a full project list, what each project is and what technology it uses. (projects.apache.org).
+We also have a tool that helps you find someone on a project (people.apache.org)
+And for the projects who have identified specific tasks they need help with (helpwanted.apache.org)
+We created reporter.apache.org for all projects to use to generate a template for their quarterly board reports.
+--
+
+== Communication
+
+image::handshake-2009183_1920-1.png[scaledwidth=75%]
+
+* Mailing list dev@community.apache.org
+
+
+[NOTE.speaker]
+--
+All our communication happens via a mailing list - dev@community.apache.org
+We introduce ourselves, have discussions, build relationships, make decisions all on the mailing list.
+If you want to know about and understand any ASF community - take a look at their mailing lists.
+Everything is archived so you can easily go back and search.
+--
+
+== Events and Participation
+* ApacheCon https://www.apachecon.com/
+* Apache Roadshows
+* Third Party Events:
+** Levels of participation from stickers, booth to talks or a track
+** If you want us to participate - please ask!
+
+== Feedback from You
+* We are here to listen and learn too!
+* How can we help support you in your open source journey?
+
+== Newcomer resources
+* Getting Started http://community.apache.org/newcomers/index.html
+* FAQs http://community.apache.org/newbiefaq.html
+* ASF Brochure https://cwiki.apache.org/confluence/display/COMDEV/ASF+Information+Brochure
+** Help Wanted https://helpwanted.apache.org/
+** GSoC http://community.apache.org/gsoc.html
+
+== Contacting ComDev
+* Website: community.apache.org
+* Mailing List: dev@community.apache.org
+* Twitter @ApacheCommunity
+* Slack : the-asf.slack.com
diff --git a/content/ComDev/ComDevIntro/src/main/resources/images/ApacheLogo.png b/content/ComDev/ComDevIntro/src/main/resources/images/ApacheLogo.png
new file mode 100644
index 0000000..61bc612
Binary files /dev/null and b/content/ComDev/ComDevIntro/src/main/resources/images/ApacheLogo.png differ
diff --git a/content/ComDev/ComDevIntro/src/main/resources/images/handshake-2009183_1920-1.png b/content/ComDev/ComDevIntro/src/main/resources/images/handshake-2009183_1920-1.png
new file mode 100644
index 0000000..b676a9d
Binary files /dev/null and b/content/ComDev/ComDevIntro/src/main/resources/images/handshake-2009183_1920-1.png differ