syncope-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ilgro...@apache.org
Subject syncope git commit: [SYNCOPE-700] Initial AsciiDoctor setup + skeleton
Date Mon, 28 Sep 2015 16:20:46 GMT
Repository: syncope
Updated Branches:
  refs/heads/master 72e6ceb06 -> 5dc51917f


[SYNCOPE-700] Initial AsciiDoctor setup + skeleton


Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/5dc51917
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/5dc51917
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/5dc51917

Branch: refs/heads/master
Commit: 5dc51917f7c1e89da5d9558c17f1048a7eaa68cc
Parents: 72e6ceb
Author: Francesco Chicchiriccò <ilgrosso@apache.org>
Authored: Mon Sep 28 18:20:38 2015 +0200
Committer: Francesco Chicchiriccò <ilgrosso@apache.org>
Committed: Mon Sep 28 18:20:38 2015 +0200

----------------------------------------------------------------------
 archetype/pom.xml                               |  20 ++++
 client/pom.xml                                  |  19 ++++
 common/pom.xml                                  |  19 ++++
 core/pom.xml                                    |  19 ++++
 deb/pom.xml                                     |  27 ++++-
 ext/pom.xml                                     |  19 ++++
 fit/pom.xml                                     |  19 ++++
 installer/pom.xml                               |  17 ++++
 pom.xml                                         |  86 ++++++++++++++++
 .../getting-started/getting-started.adoc        |  64 ++++++++++++
 .../reference-guide/reference-guide.adoc        | 100 +++++++++++++++++++
 standalone/pom.xml                              |  17 ++++
 12 files changed, 421 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/archetype/pom.xml
----------------------------------------------------------------------
diff --git a/archetype/pom.xml b/archetype/pom.xml
index a921a3c..c62180e 100644
--- a/archetype/pom.xml
+++ b/archetype/pom.xml
@@ -227,4 +227,24 @@ under the License.
       </resource>
     </resources>
   </build>
+  
+  <profiles>
+    <profile>
+      <id>doc</id>
+
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctor-maven-plugin</artifactId>
+            <inherited>false</inherited>
+            <configuration>
+              <skip>true</skip>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+  
 </project>

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/client/pom.xml
----------------------------------------------------------------------
diff --git a/client/pom.xml b/client/pom.xml
index a708ad6..68bd1e5 100644
--- a/client/pom.xml
+++ b/client/pom.xml
@@ -37,6 +37,25 @@ under the License.
     <rootpom.basedir>${basedir}/..</rootpom.basedir>
   </properties>
 
+  <profiles>
+    <profile>
+      <id>doc</id>
+
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctor-maven-plugin</artifactId>
+            <inherited>false</inherited>
+            <configuration>
+              <skip>true</skip>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+  
   <modules>
     <module>lib</module>
     <module>console</module>

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/common/pom.xml
----------------------------------------------------------------------
diff --git a/common/pom.xml b/common/pom.xml
index db8b41c..8ba7e7a 100644
--- a/common/pom.xml
+++ b/common/pom.xml
@@ -37,6 +37,25 @@ under the License.
     <rootpom.basedir>${basedir}/..</rootpom.basedir>
   </properties>
 
+  <profiles>
+    <profile>
+      <id>doc</id>
+
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctor-maven-plugin</artifactId>
+            <inherited>false</inherited>
+            <configuration>
+              <skip>true</skip>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+
   <modules>
     <module>lib</module>
     <module>rest-api</module>

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/core/pom.xml
----------------------------------------------------------------------
diff --git a/core/pom.xml b/core/pom.xml
index bb61b7a..e42e36e 100644
--- a/core/pom.xml
+++ b/core/pom.xml
@@ -36,7 +36,26 @@ under the License.
   <properties>
     <rootpom.basedir>${basedir}/..</rootpom.basedir>
   </properties>
+  
+  <profiles>
+    <profile>
+      <id>doc</id>
 
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctor-maven-plugin</artifactId>
+            <inherited>false</inherited>
+            <configuration>
+              <skip>true</skip>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+  
   <modules>
     <module>persistence-api</module>
     <module>persistence-jpa</module>

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/deb/pom.xml
----------------------------------------------------------------------
diff --git a/deb/pom.xml b/deb/pom.xml
index 7e2cd11..b855c41 100644
--- a/deb/pom.xml
+++ b/deb/pom.xml
@@ -44,6 +44,11 @@ under the License.
     <log.directory>/var/log/apache-syncope</log.directory>
   </properties>
 
+  <modules>
+    <module>core</module>
+    <module>console</module>
+  </modules>
+
   <profiles>
     <profile>
       <id>apache-release</id>
@@ -60,11 +65,23 @@ under the License.
         </plugins>
       </build>
     </profile>
-  </profiles>
 
-  <modules>
-    <module>core</module>
-    <module>console</module>
-  </modules>
+    <profile>
+      <id>doc</id>
 
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctor-maven-plugin</artifactId>
+            <inherited>false</inherited>
+            <configuration>
+              <skip>true</skip>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+  
 </project>

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/ext/pom.xml
----------------------------------------------------------------------
diff --git a/ext/pom.xml b/ext/pom.xml
index 7579cc8..d4423ce 100644
--- a/ext/pom.xml
+++ b/ext/pom.xml
@@ -37,6 +37,25 @@ under the License.
     <rootpom.basedir>${basedir}/..</rootpom.basedir>
   </properties>
 
+  <profiles>
+    <profile>
+      <id>doc</id>
+
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctor-maven-plugin</artifactId>
+            <inherited>false</inherited>
+            <configuration>
+              <skip>true</skip>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+  
   <modules>
     <module>camel</module>
   </modules>

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/fit/pom.xml
----------------------------------------------------------------------
diff --git a/fit/pom.xml b/fit/pom.xml
index f070c29..203e414 100644
--- a/fit/pom.xml
+++ b/fit/pom.xml
@@ -37,6 +37,25 @@ under the License.
     <rootpom.basedir>${basedir}/..</rootpom.basedir>
   </properties>
 
+  <profiles>
+    <profile>
+      <id>doc</id>
+
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctor-maven-plugin</artifactId>
+            <inherited>false</inherited>
+            <configuration>
+              <skip>true</skip>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+  
   <modules>
     <module>build-tools</module>
     <module>core-reference</module>

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/installer/pom.xml
----------------------------------------------------------------------
diff --git a/installer/pom.xml b/installer/pom.xml
index 4aed304..7727574 100644
--- a/installer/pom.xml
+++ b/installer/pom.xml
@@ -215,6 +215,23 @@ under the License.
         </plugins>
       </build>
     </profile>
+    
+    <profile>
+      <id>doc</id>
+
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctor-maven-plugin</artifactId>
+            <inherited>false</inherited>
+            <configuration>
+              <skip>true</skip>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
   </profiles>
 
 </project>

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index bd03ee3..e0b4b184e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1512,6 +1512,92 @@ under the License.
     </profile>
 
     <profile>
+      <id>doc</id>
+      <build>
+        <defaultGoal>clean generate-resources</defaultGoal>
+        
+        <plugins>
+          <plugin>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctor-maven-plugin</artifactId>
+            <version>1.5.2.1</version>
+            <dependencies>
+              <dependency>
+                <groupId>org.asciidoctor</groupId>
+                <artifactId>asciidoctorj-pdf</artifactId>
+                <version>1.5.0-alpha.9</version>
+              </dependency>
+            </dependencies>
+            <configuration>
+              <doctype>book</doctype>
+              <relativeBaseDir>true</relativeBaseDir>
+              <sourceHighlighter>coderay</sourceHighlighter>
+              <attributes>
+                <docVersion>${project.version}</docVersion>
+                <numbered>true</numbered>
+                <icons>font</icons>
+                <pagenums/>
+                <idprefix/>
+                <idseparator>-</idseparator>
+                <last-update-label>Copyright © 2010–2015 The Apache Software Foundation.
All rights reserved. Last Updated:</last-update-label>
+              </attributes>
+            </configuration>
+            <executions>
+              <execution>
+                <id>getting-started-html</id>
+                <phase>generate-resources</phase>
+                <goals>
+                  <goal>process-asciidoc</goal>
+                </goals>
+                <configuration>
+                  <sourceDirectory>${basedir}/src/main/asciidoc/getting-started</sourceDirectory>
+                  <sourceDocumentName>getting-started.adoc</sourceDocumentName>
+                  <backend>html</backend>
+                </configuration>
+              </execution>
+              <execution>
+                <id>getting-started-pdf</id>
+                <phase>generate-resources</phase>
+                <goals>
+                  <goal>process-asciidoc</goal>
+                </goals>
+                <configuration>
+                  <sourceDirectory>${basedir}/src/main/asciidoc/getting-started</sourceDirectory>
+                  <sourceDocumentName>getting-started.adoc</sourceDocumentName>
+                  <backend>pdf</backend>
+                </configuration>
+              </execution>
+              <execution>
+                <id>reference-guide-html</id>
+                <phase>generate-resources</phase>
+                <goals>
+                  <goal>process-asciidoc</goal>
+                </goals>
+                <configuration>
+                  <sourceDirectory>${basedir}/src/main/asciidoc/reference-guide</sourceDirectory>
+                  <sourceDocumentName>reference-guide.adoc</sourceDocumentName>
+                  <backend>html</backend>
+                </configuration>
+              </execution>
+              <execution>
+                <id>reference-guide-pdf</id>
+                <phase>generate-resources</phase>
+                <goals>
+                  <goal>process-asciidoc</goal>
+                </goals>
+                <configuration>
+                  <sourceDirectory>${basedir}/src/main/asciidoc/reference-guide</sourceDirectory>
+                  <sourceDocumentName>reference-guide.adoc</sourceDocumentName>
+                  <backend>pdf</backend>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+
+    <profile>
       <id>site</id>
       <build>
         <defaultGoal>clean site-deploy</defaultGoal>

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/src/main/asciidoc/getting-started/getting-started.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/getting-started/getting-started.adoc b/src/main/asciidoc/getting-started/getting-started.adoc
new file mode 100644
index 0000000..9643501
--- /dev/null
+++ b/src/main/asciidoc/getting-started/getting-started.adoc
@@ -0,0 +1,64 @@
+//
+// 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.
+//
+
+// Quick reference: http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
+// User manual: http://asciidoctor.org/docs/user-manual/
+
+= Apache Syncope - Getting Started
+:revnumber: {docVersion}
+:toc: right
+:toclevels: 4
+:homepage: http://syncope.apache.org
+:description: Several ways to get started with Apache Syncope
+:keywords: Apache Syncope, IdM, provisioning, identity management, getting started, tutorial
+
+:sectanchors:
+:sectnums:
+:sectlinks:
+
+[NOTE]
+.This document is under active development and discussion!
+If you find errors or omissions in this document, please don’t hesitate to 
+http://syncope.apache.org/issue-tracking.html[submit an issue] or 
+https://github.com/apache/syncope/pulls[open a pull request] with 
+a fix. We also encourage you to ask questions and discuss any aspects of the project on the

+http://syncope.apache.org/mailing-lists.html[mailing lists or IRC]. 
+New contributors are always welcome!
+
+[discrete] 
+== Preface
+This guide shows you how to get started with Apache Syncope services for identity management,
provisioning, and 
+compliance.
+
+== Introduction
+
+== Which method?
+
+=== Standalone
+
+=== Debian packages
+
+=== GUI installer
+
+=== Maven project
+
+== Moving forward
+
+// Chapters will be placed in separate .adoc files in the same directory
+//include::XXX.adoc[]
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/src/main/asciidoc/reference-guide/reference-guide.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/reference-guide.adoc b/src/main/asciidoc/reference-guide/reference-guide.adoc
new file mode 100644
index 0000000..48c2a80
--- /dev/null
+++ b/src/main/asciidoc/reference-guide/reference-guide.adoc
@@ -0,0 +1,100 @@
+//
+// 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.
+//
+
+// Quick reference: http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
+// User manual: http://asciidoctor.org/docs/user-manual/
+
+= Apache Syncope - Reference Guide
+:revnumber: {docVersion}
+:toc: right
+:toclevels: 4
+:homepage: http://syncope.apache.org
+:description: Comprehensive guide about Apache Syncope
+:keywords: Apache Syncope, IdM, provisioning, identity management, reference, guide
+
+:sectanchors:
+:sectnums:
+:sectlinks:
+
+[NOTE]
+.This document is under active development and discussion!
+If you find errors or omissions in this document, please don’t hesitate to 
+http://syncope.apache.org/issue-tracking.html[submit an issue] or 
+https://github.com/apache/syncope/pulls[open a pull request] with 
+a fix. We also encourage you to ask questions and discuss any aspects of the project on the

+http://syncope.apache.org/mailing-lists.html[mailing lists or IRC]. 
+New contributors are always welcome!
+
+[discrete] 
+== Preface
+This guide provides comprehensive reference to Apache Syncope services for identity management,
provisioning, and 
+compliance.
+
+== Introduction
+
+=== A bit of history
+
+== Identity and Access Management
+
+=== Identity Stores
+
+=== Provisioning Engines
+
+=== Access Managers
+
+== Building blocks
+
+=== Data model
+
+==== Schema
+
+==== Attributes
+
+==== Mapping
+
+=== The external world
+
+==== Connectors, Resources
+
+==== Propagation & Synchronization
+
+=== Policies
+
+=== Workflow
+
+=== Reports
+
+== Working with Apache Syncope
+
+=== Architecture
+
+=== RESTful services
+
+==== Client library
+
+=== Extending
+
+==== Core
+
+==== Console
+
+== Examples
+
+// Chapters will be placed in separate .adoc files in the same directory
+//include::XXX.adoc[]
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/5dc51917/standalone/pom.xml
----------------------------------------------------------------------
diff --git a/standalone/pom.xml b/standalone/pom.xml
index a23b810..def2d20 100644
--- a/standalone/pom.xml
+++ b/standalone/pom.xml
@@ -282,6 +282,23 @@ under the License.
         </plugins>
       </build>
     </profile>
+
+    <profile>
+      <id>doc</id>
+
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctor-maven-plugin</artifactId>
+            <inherited>false</inherited>
+            <configuration>
+              <skip>true</skip>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
   </profiles>
 
 </project>


Mime
View raw message