Move documentation from Confluence to Git (#113)

initial Antora setup and pages stubs
ops4j · Oct 30, 2024 · ec8b586 · ec8b586
1 parent b73a486
commit ec8b586
Show file tree

Hide file tree

Showing 19 changed files with 53 additions and 27 deletions.
diff --git a/documentation/antora.yml b/documentation/antora.yml
@@ -0,0 +1,5 @@
+name: pax-swissbox
+title: Pax Swissbox
+version: master
+nav:
+  - modules/ROOT/nav.adoc
diff --git a/documentation/modules/ROOT/nav.adoc b/documentation/modules/ROOT/nav.adoc
@@ -0,0 +1 @@
+* xref:index.adoc[]
diff --git a/documentation/modules/ROOT/pages/bnd.adoc b/documentation/modules/ROOT/pages/bnd.adoc
@@ -0,0 +1,4 @@
+= Pax Swissbox Bnd
+:navtitle: Bnd
+
+BND utilities.
diff --git a/documentation/modules/ROOT/pages/core.adoc b/documentation/modules/ROOT/pages/core.adoc
@@ -0,0 +1,4 @@
+= Pax Swissbox Core
+:navtitle: Core
+
+Utilities related to OSGi core framework.
diff --git a/documentation/modules/ROOT/pages/extender.adoc b/documentation/modules/ROOT/pages/extender.adoc
@@ -0,0 +1,4 @@
+= Pax Swissbox Extender
+:navtitle: Extender
+
+Utilities related to extender pattern.
diff --git a/documentation/modules/ROOT/pages/framework.adoc b/documentation/modules/ROOT/pages/framework.adoc
@@ -0,0 +1,4 @@
+= Pax Swissbox Framework
+:navtitle: Framework
+
+Framework Helpers
diff --git a/documentation/modules/ROOT/pages/index.adoc b/documentation/modules/ROOT/pages/index.adoc
@@ -0,0 +1,4 @@
+= Pax Swissbox
+:navtitle: Pax Swissbox
+
+Utilities for OSGi
diff --git a/documentation/modules/ROOT/pages/lifecycle.adoc b/documentation/modules/ROOT/pages/lifecycle.adoc
@@ -0,0 +1,4 @@
+= Pax Swissbox Lifecycle
+:navtitle: Lifecycle
+
+Utilities related to lifecycle.
diff --git a/documentation/modules/ROOT/pages/optional-jcl.adoc b/documentation/modules/ROOT/pages/optional-jcl.adoc
@@ -0,0 +1,4 @@
+= Pax Swissbox Optional JCL
+:navtitle: Optional JCL
+
+Optional Apache Commons Logging.
diff --git a/documentation/modules/ROOT/pages/property.adoc b/documentation/modules/ROOT/pages/property.adoc
@@ -0,0 +1,4 @@
+= Pax Swissbox Property
+:navtitle: Property
+
+Utilities related to properties in OSGi.
diff --git a/documentation/modules/ROOT/pages/samples.adoc b/documentation/modules/ROOT/pages/samples.adoc
@@ -0,0 +1,4 @@
+= Pax Swissbox Samples
+:navtitle: Samples
+
+Manifest entry extender sample.
diff --git a/documentation/modules/ROOT/pages/tracker.adoc b/documentation/modules/ROOT/pages/tracker.adoc
@@ -0,0 +1,4 @@
+= Pax Swissbox Tracker
+:navtitle: Tracker
+
+Utilities related to service tracking.
diff --git a/pax-swissbox-bnd/pom.xml b/pax-swissbox-bnd/pom.xml
@@ -14,9 +14,7 @@
     <packaging>bundle</packaging>
 
     <name>OPS4J Pax Swissbox :: Bnd Utils</name>
-    <description>
-        OPS4J Pax Swissbox - BND utilities.
-    </description>
+    <description>OPS4J Pax Swissbox - BND utilities.</description>
 
     <properties>
         <bundle.symbolicName>org.ops4j.pax.swissbox.bnd</bundle.symbolicName>

diff --git a/pax-swissbox-core/pom.xml b/pax-swissbox-core/pom.xml
@@ -14,10 +14,7 @@
   <packaging>bundle</packaging>
 
   <name>OPS4J Pax Swissbox :: OSGi Core</name>
-  <description>
-    OPS4J Pax Swissbox - Utilities related to OSGi core framework.
-    Detailed information to be found at http://wiki.ops4j.org/confluence/x/MgRN.
-  </description>
+  <description>OPS4J Pax Swissbox - Utilities related to OSGi core framework.</description>
 
   <properties>
     <bundle.symbolicName>org.ops4j.pax.swissbox.core</bundle.symbolicName>

diff --git a/pax-swissbox-extender/pom.xml b/pax-swissbox-extender/pom.xml
@@ -14,10 +14,7 @@
   <packaging>bundle</packaging>
 
   <name>OPS4J Pax Swissbox :: Extender</name>
-  <description>
-    OPS4J Pax Swissbox - Utilities related to extender pattern.
-    Detailed information to be found at http://wiki.ops4j.org/confluence/x/NQRN.
-  </description>
+  <description>OPS4J Pax Swissbox - Utilities related to extender pattern.</description>
 
   <properties>
     <bundle.symbolicName>org.ops4j.pax.swissbox.extender</bundle.symbolicName>

diff --git a/pax-swissbox-lifecycle/pom.xml b/pax-swissbox-lifecycle/pom.xml
@@ -14,10 +14,7 @@
   <packaging>bundle</packaging>
 
   <name>OPS4J Pax Swissbox :: Lifecycle</name>
-  <description>
-    OPS4J Pax Swissbox - Utilities related to lifecycle.
-    Detailed information to be found at http://wiki.ops4j.org/confluence/x/NgRN.
-  </description>
+  <description>OPS4J Pax Swissbox - Utilities related to lifecycle.</description>
 
   <properties>
     <bundle.symbolicName>org.ops4j.pax.swissbox.lifecycle</bundle.symbolicName>

diff --git a/pax-swissbox-optional-jcl/pom.xml b/pax-swissbox-optional-jcl/pom.xml
@@ -14,10 +14,7 @@
   <packaging>bundle</packaging>
 
   <name>OPS4J Pax Swissbox :: Optional JCL</name>
-  <description>
-    OPS4J Pax Swissbox - Optional Apache Commons Logging.
-    Detailed information to be found at http://wiki.ops4j.org/confluence/x/NwRN. 
-  </description>
+  <description>OPS4J Pax Swissbox - Optional Apache Commons Logging.</description>
 
   <properties>
     <bundle.symbolicName>org.ops4j.pax.swissbox.optional.jcl</bundle.symbolicName>

diff --git a/pax-swissbox-property/pom.xml b/pax-swissbox-property/pom.xml
@@ -14,10 +14,7 @@
   <packaging>bundle</packaging>
 
   <name>OPS4J Pax Swissbox :: Property</name>
-  <description>
-    OPS4J Pax Swissbox - Utilities related to properties in osgi.
-    Detailed information to be found at http://wiki.ops4j.org/confluence/x/OARN.
-  </description>
+  <description>OPS4J Pax Swissbox - Utilities related to properties in OSGi.</description>
 
   <properties>
     <bundle.symbolicName>org.ops4j.pax.swissbox.property</bundle.symbolicName>

diff --git a/pax-swissbox-tracker/pom.xml b/pax-swissbox-tracker/pom.xml
@@ -14,10 +14,7 @@
   <packaging>bundle</packaging>
 
   <name>OPS4J Pax Swissbox :: Tracker</name>
-  <description>
-    OPS4J Pax Swissbox - Utilities related to service tracking.
-    Detailed information to be found at http://wiki.ops4j.org/confluence/x/OQRN.
-  </description>
+  <description>OPS4J Pax Swissbox - Utilities related to service tracking.</description>
 
   <properties>
     <bundle.symbolicName>org.ops4j.pax.swissbox.tracker</bundle.symbolicName>