HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton.

.gitignore

@@ -60,4 +60,4 @@ log.html
 output.xml
 report.html
 
-hadoop-ozone/docs/public
+hadoop-hdds/docs/public

hadoop-hdds/docs/README.md

@@ -30,7 +30,7 @@ You can check the rendering with:
 hugo serve
 ```
 
-This maven project will create the rendered HTML page during the build (ONLY if hugo is available). 
+This maven project will create the rendered HTML page during the build (ONLY if hugo is available).
 And the dist project will include the documentation.
 
 You can adjust the menu hierarchy with adjusting the header of the markdown file:
@@ -43,7 +43,7 @@ menu: main
 ---
 ```
 
-To show it as a subpage, you can set the parent. (The value could be the title of the parent page, 
+To show it as a subpage, you can set the parent. (The value could be the title of the parent page,
 our you can defined an `id: ...` in the parent markdown and use that in the parent reference.
 
 ```

hadoop-hdds/docs/content/CommandShell.md

@@ -106,4 +106,3 @@ or it can be invoked to explain a specific action like
 ozone sh volume create --help
 {{< /highlight >}}
 This command will give you command line options of the create command.
-

hadoop-hdds/docs/content/_index.md

@@ -36,4 +36,3 @@ Ozone consists of volumes, buckets, and Keys.
 
 
 <a href="{{< ref "RunningViaDocker.md" >}}"><button class="btn btn-danger btn-lg">Getting started</button></a>
-

hadoop-hdds/docs/dev-support/bin/generate-site.sh

@@ -22,7 +22,7 @@ if [ ! "$(which hugo)" ]; then
    exit 0
 fi
 
-DESTDIR="$DOCDIR/target/classes/webapps/docs"
+DESTDIR="$DOCDIR/target/classes/docs"
 mkdir -p "$DESTDIR"
 cd "$DOCDIR"
 hugo -d "$DESTDIR" "$@"

hadoop-hdds/docs/pom.xml

@@ -19,13 +19,13 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
     <groupId>org.apache.hadoop</groupId>
-    <artifactId>hadoop-ozone</artifactId>
+    <artifactId>hadoop-hdds</artifactId>
     <version>0.4.0-SNAPSHOT</version>
   </parent>
-  <artifactId>hadoop-ozone-docs</artifactId>
+  <artifactId>hadoop-hdds-docs</artifactId>
   <version>0.4.0-SNAPSHOT</version>
-  <description>Apache Hadoop Ozone Documentation</description>
-  <name>Apache Hadoop Ozone Documentation</name>
+  <description>Apache Hadoop HDDS/Ozone Documentation</description>
+  <name>Apache Hadoop HDDS/Ozone Documentation</name>
   <packaging>jar</packaging>
 
   <dependencies>
@@ -56,11 +56,15 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
           <excludes>
             <exclude>themes/ozonedoc/static/js/bootstrap.min.js</exclude>
             <exclude>themes/ozonedoc/static/js/jquery.min.js</exclude>
-            <exclude>themes/ozonedoc/static/css/bootstrap-theme.min.css</exclude>
+            <exclude>themes/ozonedoc/static/css/bootstrap-theme.min.css
+            </exclude>
             <exclude>themes/ozonedoc/static/css/bootstrap.min.css.map</exclude>
             <exclude>themes/ozonedoc/static/css/bootstrap.min.css</exclude>
-            <exclude>themes/ozonedoc/static/css/bootstrap-theme.min.css.map</exclude>
-            <exclude>themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg</exclude>
+            <exclude>themes/ozonedoc/static/css/bootstrap-theme.min.css.map
+            </exclude>
+            <exclude>
+              themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg
+            </exclude>
             <exclude>themes/ozonedoc/layouts/index.html</exclude>
             <exclude>themes/ozonedoc/theme.toml</exclude>
           </excludes>

hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg

@@ -285,4 +285,4 @@
 <glyph unicode="&#x1f511;" d="M250 1200h600q21 0 35.5 -14.5t14.5 -35.5v-400q0 -21 -14.5 -35.5t-35.5 -14.5h-150v-500l-255 -178q-19 -9 -32 -1t-13 29v650h-150q-21 0 -35.5 14.5t-14.5 35.5v400q0 21 14.5 35.5t35.5 14.5zM400 1100v-100h300v100h-300z" />
 <glyph unicode="&#x1f6aa;" d="M250 1200h750q39 0 69.5 -40.5t30.5 -84.5v-933l-700 -117v950l600 125h-700v-1000h-100v1025q0 23 15.5 49t34.5 26zM500 525v-100l100 20v100z" />
 </font>
-</defs></svg> 
+</defs></svg>

hadoop-hdds/pom.xml

@@ -37,6 +37,7 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <module>container-service</module>
     <module>server-scm</module>
     <module>tools</module>
+    <module>docs</module>
 
   </modules>
 
@@ -106,6 +107,12 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
         <version>${hdds.version}</version>
       </dependency>
 
+      <dependency>
+        <groupId>org.apache.hadoop</groupId>
+        <artifactId>hadoop-hdds-docs</artifactId>
+        <version>${hdds.version}</version>
+      </dependency>
+
       <dependency>
         <groupId>org.apache.hadoop</groupId>
         <artifactId>hadoop-hdds-container-service</artifactId>

hadoop-hdds/server-scm/pom.xml

@@ -49,6 +49,11 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
       <artifactId>hadoop-hdds-server-framework</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>org.apache.hadoop</groupId>
+      <artifactId>hadoop-hdds-docs</artifactId>
+    </dependency>
+
     <dependency>
       <groupId>org.apache.hadoop</groupId>
       <artifactId>hadoop-hdds-container-service</artifactId>
@@ -118,6 +123,13 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
                   </outputDirectory>
                   <includes>webapps/static/**/*.*</includes>
                 </artifactItem>
+                <artifactItem>
+                  <groupId>org.apache.hadoop</groupId>
+                  <artifactId>hadoop-hdds-docs</artifactId>
+                  <outputDirectory>${project.build.outputDirectory}/webapps/scm
+                  </outputDirectory>
+                  <includes>docs/**/*.*</includes>
+                </artifactItem>
               </artifactItems>
               <overWriteSnapshots>true</overWriteSnapshots>
             </configuration>

hadoop-ozone/dist/dev-support/bin/dist-layout-stitching

@@ -107,8 +107,7 @@ run cp "${ROOT}/hadoop-ozone/objectstore-service/target/hadoop-ozone-objectstore
 
 
 # Optional documentation, could be missing
-cp -r "${ROOT}/hadoop-ozone/docs/target/classes/webapps/docs" ./share/hadoop/ozone/webapps/ozoneManager/
-cp -r "${ROOT}/hadoop-ozone/docs/target/classes/webapps/docs" ./share/hadoop/hdds/webapps/scm/
+cp -r "${ROOT}/hadoop-hdds/docs/target/classes/docs" ./
 
 #Copy docker compose files
 run cp -p -r "${ROOT}/hadoop-ozone/dist/src/main/compose" .

hadoop-ozone/dist/pom.xml

@@ -191,5 +191,9 @@
       <groupId>org.apache.hadoop</groupId>
       <artifactId>hadoop-ozone-datanode</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.apache.hadoop</groupId>
+      <artifactId>hadoop-hdds-docs</artifactId>
+    </dependency>
   </dependencies>
 </project>

hadoop-ozone/ozone-manager/pom.xml

@@ -40,6 +40,11 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
       <artifactId>hadoop-ozone-client</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>org.apache.hadoop</groupId>
+      <artifactId>hadoop-hdds-docs</artifactId>
+    </dependency>
+
     <dependency>
       <groupId>org.bouncycastle</groupId>
       <artifactId>bcprov-jdk15on</artifactId>
@@ -75,6 +80,12 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
                   </outputDirectory>
                   <includes>webapps/static/**/*.*</includes>
                 </artifactItem>
+                <artifactItem>
+                  <groupId>org.apache.hadoop</groupId>
+                  <artifactId>hadoop-hdds-docs</artifactId>
+                  <outputDirectory>${project.build.outputDirectory}/webapps/ozoneManager</outputDirectory>
+                  <includes>docs/**/*.*</includes>
+                </artifactItem>
               </artifactItems>
               <overWriteSnapshots>true</overWriteSnapshots>
             </configuration>

hadoop-ozone/pom.xml

@@ -51,7 +51,6 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <module>datanode</module>
     <module>s3gateway</module>
     <module>dist</module>
-    <module>docs</module>
   </modules>
 
   <repositories>
@@ -132,6 +131,11 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
         <artifactId>hadoop-hdds-server-scm</artifactId>
         <version>${hdds.version}</version>
       </dependency>
+      <dependency>
+        <groupId>org.apache.hadoop</groupId>
+        <artifactId>hadoop-hdds-docs</artifactId>
+        <version>${hdds.version}</version>
+      </dependency>
       <dependency>
         <groupId>org.apache.hadoop</groupId>
         <artifactId>hadoop-hdds-container-service</artifactId>