diff --git a/.gitignore b/.gitignore index ac245c7575..a60553d1b6 100644 --- a/.gitignore +++ b/.gitignore @@ -60,4 +60,4 @@ log.html output.xml report.html -hadoop-ozone/docs/public +hadoop-hdds/docs/public diff --git a/hadoop-ozone/docs/README.md b/hadoop-hdds/docs/README.md similarity index 95% rename from hadoop-ozone/docs/README.md rename to hadoop-hdds/docs/README.md index 85817a79d0..8d5cdb714f 100644 --- a/hadoop-ozone/docs/README.md +++ b/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. ``` diff --git a/hadoop-ozone/docs/archetypes/default.md b/hadoop-hdds/docs/archetypes/default.md similarity index 100% rename from hadoop-ozone/docs/archetypes/default.md rename to hadoop-hdds/docs/archetypes/default.md diff --git a/hadoop-ozone/docs/config.yaml b/hadoop-hdds/docs/config.yaml similarity index 100% rename from hadoop-ozone/docs/config.yaml rename to hadoop-hdds/docs/config.yaml diff --git a/hadoop-ozone/docs/content/BucketCommands.md b/hadoop-hdds/docs/content/BucketCommands.md similarity index 100% rename from hadoop-ozone/docs/content/BucketCommands.md rename to hadoop-hdds/docs/content/BucketCommands.md diff --git a/hadoop-ozone/docs/content/BuildingSources.md b/hadoop-hdds/docs/content/BuildingSources.md similarity index 100% rename from hadoop-ozone/docs/content/BuildingSources.md rename to hadoop-hdds/docs/content/BuildingSources.md diff --git a/hadoop-ozone/docs/content/CommandShell.md b/hadoop-hdds/docs/content/CommandShell.md similarity index 99% rename from hadoop-ozone/docs/content/CommandShell.md rename to hadoop-hdds/docs/content/CommandShell.md index fdd6c01af3..b2617f60ee 100644 --- a/hadoop-ozone/docs/content/CommandShell.md +++ b/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. - diff --git a/hadoop-ozone/docs/content/Concepts.md b/hadoop-hdds/docs/content/Concepts.md similarity index 100% rename from hadoop-ozone/docs/content/Concepts.md rename to hadoop-hdds/docs/content/Concepts.md diff --git a/hadoop-ozone/docs/content/Dozone.md b/hadoop-hdds/docs/content/Dozone.md similarity index 100% rename from hadoop-ozone/docs/content/Dozone.md rename to hadoop-hdds/docs/content/Dozone.md diff --git a/hadoop-ozone/docs/content/Freon.md b/hadoop-hdds/docs/content/Freon.md similarity index 100% rename from hadoop-ozone/docs/content/Freon.md rename to hadoop-hdds/docs/content/Freon.md diff --git a/hadoop-ozone/docs/content/Hdds.md b/hadoop-hdds/docs/content/Hdds.md similarity index 100% rename from hadoop-ozone/docs/content/Hdds.md rename to hadoop-hdds/docs/content/Hdds.md diff --git a/hadoop-ozone/docs/content/JavaApi.md b/hadoop-hdds/docs/content/JavaApi.md similarity index 100% rename from hadoop-ozone/docs/content/JavaApi.md rename to hadoop-hdds/docs/content/JavaApi.md diff --git a/hadoop-ozone/docs/content/KeyCommands.md b/hadoop-hdds/docs/content/KeyCommands.md similarity index 100% rename from hadoop-ozone/docs/content/KeyCommands.md rename to hadoop-hdds/docs/content/KeyCommands.md diff --git a/hadoop-ozone/docs/content/OzoneFS.md b/hadoop-hdds/docs/content/OzoneFS.md similarity index 100% rename from hadoop-ozone/docs/content/OzoneFS.md rename to hadoop-hdds/docs/content/OzoneFS.md diff --git a/hadoop-ozone/docs/content/OzoneManager.md b/hadoop-hdds/docs/content/OzoneManager.md similarity index 100% rename from hadoop-ozone/docs/content/OzoneManager.md rename to hadoop-hdds/docs/content/OzoneManager.md diff --git a/hadoop-ozone/docs/content/RealCluster.md b/hadoop-hdds/docs/content/RealCluster.md similarity index 100% rename from hadoop-ozone/docs/content/RealCluster.md rename to hadoop-hdds/docs/content/RealCluster.md diff --git a/hadoop-ozone/docs/content/Rest.md b/hadoop-hdds/docs/content/Rest.md similarity index 100% rename from hadoop-ozone/docs/content/Rest.md rename to hadoop-hdds/docs/content/Rest.md diff --git a/hadoop-ozone/docs/content/RunningViaDocker.md b/hadoop-hdds/docs/content/RunningViaDocker.md similarity index 100% rename from hadoop-ozone/docs/content/RunningViaDocker.md rename to hadoop-hdds/docs/content/RunningViaDocker.md diff --git a/hadoop-ozone/docs/content/RunningWithHDFS.md b/hadoop-hdds/docs/content/RunningWithHDFS.md similarity index 100% rename from hadoop-ozone/docs/content/RunningWithHDFS.md rename to hadoop-hdds/docs/content/RunningWithHDFS.md diff --git a/hadoop-ozone/docs/content/S3.md b/hadoop-hdds/docs/content/S3.md similarity index 100% rename from hadoop-ozone/docs/content/S3.md rename to hadoop-hdds/docs/content/S3.md diff --git a/hadoop-ozone/docs/content/SCMCLI.md b/hadoop-hdds/docs/content/SCMCLI.md similarity index 100% rename from hadoop-ozone/docs/content/SCMCLI.md rename to hadoop-hdds/docs/content/SCMCLI.md diff --git a/hadoop-ozone/docs/content/Settings.md b/hadoop-hdds/docs/content/Settings.md similarity index 100% rename from hadoop-ozone/docs/content/Settings.md rename to hadoop-hdds/docs/content/Settings.md diff --git a/hadoop-ozone/docs/content/VolumeCommands.md b/hadoop-hdds/docs/content/VolumeCommands.md similarity index 100% rename from hadoop-ozone/docs/content/VolumeCommands.md rename to hadoop-hdds/docs/content/VolumeCommands.md diff --git a/hadoop-ozone/docs/content/_index.md b/hadoop-hdds/docs/content/_index.md similarity index 99% rename from hadoop-ozone/docs/content/_index.md rename to hadoop-hdds/docs/content/_index.md index e297b182fd..356e8401fa 100644 --- a/hadoop-ozone/docs/content/_index.md +++ b/hadoop-hdds/docs/content/_index.md @@ -36,4 +36,3 @@ Ozone consists of volumes, buckets, and Keys. }}"> - diff --git a/hadoop-ozone/docs/dev-support/bin/generate-site.sh b/hadoop-hdds/docs/dev-support/bin/generate-site.sh similarity index 95% rename from hadoop-ozone/docs/dev-support/bin/generate-site.sh rename to hadoop-hdds/docs/dev-support/bin/generate-site.sh index 374e74b890..d8b5d48115 100755 --- a/hadoop-ozone/docs/dev-support/bin/generate-site.sh +++ b/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" "$@" diff --git a/hadoop-ozone/docs/pom.xml b/hadoop-hdds/docs/pom.xml similarity index 85% rename from hadoop-ozone/docs/pom.xml rename to hadoop-hdds/docs/pom.xml index bd26a200ed..43e6b197e5 100644 --- a/hadoop-ozone/docs/pom.xml +++ b/hadoop-hdds/docs/pom.xml @@ -19,13 +19,13 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 org.apache.hadoop - hadoop-ozone + hadoop-hdds 0.4.0-SNAPSHOT - hadoop-ozone-docs + hadoop-hdds-docs 0.4.0-SNAPSHOT - Apache Hadoop Ozone Documentation - Apache Hadoop Ozone Documentation + Apache Hadoop HDDS/Ozone Documentation + Apache Hadoop HDDS/Ozone Documentation jar @@ -56,11 +56,15 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> themes/ozonedoc/static/js/bootstrap.min.js themes/ozonedoc/static/js/jquery.min.js - themes/ozonedoc/static/css/bootstrap-theme.min.css + themes/ozonedoc/static/css/bootstrap-theme.min.css + themes/ozonedoc/static/css/bootstrap.min.css.map themes/ozonedoc/static/css/bootstrap.min.css - themes/ozonedoc/static/css/bootstrap-theme.min.css.map - themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg + themes/ozonedoc/static/css/bootstrap-theme.min.css.map + + + themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg + themes/ozonedoc/layouts/index.html themes/ozonedoc/theme.toml diff --git a/hadoop-ozone/docs/static/NOTES.md b/hadoop-hdds/docs/static/NOTES.md similarity index 100% rename from hadoop-ozone/docs/static/NOTES.md rename to hadoop-hdds/docs/static/NOTES.md diff --git a/hadoop-ozone/docs/static/OzoneOverview.png b/hadoop-hdds/docs/static/OzoneOverview.png similarity index 100% rename from hadoop-ozone/docs/static/OzoneOverview.png rename to hadoop-hdds/docs/static/OzoneOverview.png diff --git a/hadoop-ozone/docs/static/OzoneOverview.svg b/hadoop-hdds/docs/static/OzoneOverview.svg similarity index 100% rename from hadoop-ozone/docs/static/OzoneOverview.svg rename to hadoop-hdds/docs/static/OzoneOverview.svg diff --git a/hadoop-ozone/docs/static/SCMBlockDiagram.png b/hadoop-hdds/docs/static/SCMBlockDiagram.png similarity index 100% rename from hadoop-ozone/docs/static/SCMBlockDiagram.png rename to hadoop-hdds/docs/static/SCMBlockDiagram.png diff --git a/hadoop-ozone/docs/static/ozone-logo.png b/hadoop-hdds/docs/static/ozone-logo.png similarity index 100% rename from hadoop-ozone/docs/static/ozone-logo.png rename to hadoop-hdds/docs/static/ozone-logo.png diff --git a/hadoop-ozone/docs/themes/ozonedoc/layouts/_default/single.html b/hadoop-hdds/docs/themes/ozonedoc/layouts/_default/single.html similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/layouts/_default/single.html rename to hadoop-hdds/docs/themes/ozonedoc/layouts/_default/single.html diff --git a/hadoop-ozone/docs/themes/ozonedoc/layouts/index.html b/hadoop-hdds/docs/themes/ozonedoc/layouts/index.html similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/layouts/index.html rename to hadoop-hdds/docs/themes/ozonedoc/layouts/index.html diff --git a/hadoop-ozone/docs/themes/ozonedoc/layouts/partials/footer.html b/hadoop-hdds/docs/themes/ozonedoc/layouts/partials/footer.html similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/layouts/partials/footer.html rename to hadoop-hdds/docs/themes/ozonedoc/layouts/partials/footer.html diff --git a/hadoop-ozone/docs/themes/ozonedoc/layouts/partials/header.html b/hadoop-hdds/docs/themes/ozonedoc/layouts/partials/header.html similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/layouts/partials/header.html rename to hadoop-hdds/docs/themes/ozonedoc/layouts/partials/header.html diff --git a/hadoop-ozone/docs/themes/ozonedoc/layouts/partials/navbar.html b/hadoop-hdds/docs/themes/ozonedoc/layouts/partials/navbar.html similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/layouts/partials/navbar.html rename to hadoop-hdds/docs/themes/ozonedoc/layouts/partials/navbar.html diff --git a/hadoop-ozone/docs/themes/ozonedoc/layouts/partials/sidebar.html b/hadoop-hdds/docs/themes/ozonedoc/layouts/partials/sidebar.html similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/layouts/partials/sidebar.html rename to hadoop-hdds/docs/themes/ozonedoc/layouts/partials/sidebar.html diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/css/bootstrap-theme.min.css b/hadoop-hdds/docs/themes/ozonedoc/static/css/bootstrap-theme.min.css similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/css/bootstrap-theme.min.css rename to hadoop-hdds/docs/themes/ozonedoc/static/css/bootstrap-theme.min.css diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/css/bootstrap-theme.min.css.map b/hadoop-hdds/docs/themes/ozonedoc/static/css/bootstrap-theme.min.css.map similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/css/bootstrap-theme.min.css.map rename to hadoop-hdds/docs/themes/ozonedoc/static/css/bootstrap-theme.min.css.map diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/css/bootstrap.min.css b/hadoop-hdds/docs/themes/ozonedoc/static/css/bootstrap.min.css similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/css/bootstrap.min.css rename to hadoop-hdds/docs/themes/ozonedoc/static/css/bootstrap.min.css diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/css/bootstrap.min.css.map b/hadoop-hdds/docs/themes/ozonedoc/static/css/bootstrap.min.css.map similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/css/bootstrap.min.css.map rename to hadoop-hdds/docs/themes/ozonedoc/static/css/bootstrap.min.css.map diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/css/ozonedoc.css b/hadoop-hdds/docs/themes/ozonedoc/static/css/ozonedoc.css similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/css/ozonedoc.css rename to hadoop-hdds/docs/themes/ozonedoc/static/css/ozonedoc.css diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.eot b/hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.eot similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.eot rename to hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.eot diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg b/hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg similarity index 99% rename from hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg rename to hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg index 94fb5490a2..f155876e1b 100644 --- a/hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg +++ b/hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.svg @@ -285,4 +285,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.ttf b/hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.ttf similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.ttf rename to hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.ttf diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.woff b/hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.woff similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.woff rename to hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.woff diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.woff2 b/hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.woff2 similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.woff2 rename to hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-halflings-regular.woff2 diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/js/bootstrap.min.js b/hadoop-hdds/docs/themes/ozonedoc/static/js/bootstrap.min.js similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/js/bootstrap.min.js rename to hadoop-hdds/docs/themes/ozonedoc/static/js/bootstrap.min.js diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/js/jquery.min.js b/hadoop-hdds/docs/themes/ozonedoc/static/js/jquery.min.js similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/js/jquery.min.js rename to hadoop-hdds/docs/themes/ozonedoc/static/js/jquery.min.js diff --git a/hadoop-ozone/docs/themes/ozonedoc/static/js/ozonedoc.js b/hadoop-hdds/docs/themes/ozonedoc/static/js/ozonedoc.js similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/static/js/ozonedoc.js rename to hadoop-hdds/docs/themes/ozonedoc/static/js/ozonedoc.js diff --git a/hadoop-ozone/docs/themes/ozonedoc/theme.toml b/hadoop-hdds/docs/themes/ozonedoc/theme.toml similarity index 100% rename from hadoop-ozone/docs/themes/ozonedoc/theme.toml rename to hadoop-hdds/docs/themes/ozonedoc/theme.toml diff --git a/hadoop-hdds/pom.xml b/hadoop-hdds/pom.xml index a6b0d849e6..d4fa64e7d1 100644 --- a/hadoop-hdds/pom.xml +++ b/hadoop-hdds/pom.xml @@ -37,6 +37,7 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> container-service server-scm tools + docs @@ -106,6 +107,12 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> ${hdds.version} + + org.apache.hadoop + hadoop-hdds-docs + ${hdds.version} + + org.apache.hadoop hadoop-hdds-container-service diff --git a/hadoop-hdds/server-scm/pom.xml b/hadoop-hdds/server-scm/pom.xml index 5fcd2bbc43..7789c3278c 100644 --- a/hadoop-hdds/server-scm/pom.xml +++ b/hadoop-hdds/server-scm/pom.xml @@ -49,6 +49,11 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> hadoop-hdds-server-framework + + org.apache.hadoop + hadoop-hdds-docs + + org.apache.hadoop hadoop-hdds-container-service @@ -118,6 +123,13 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> webapps/static/**/*.* + + org.apache.hadoop + hadoop-hdds-docs + ${project.build.outputDirectory}/webapps/scm + + docs/**/*.* + true diff --git a/hadoop-ozone/dist/dev-support/bin/dist-layout-stitching b/hadoop-ozone/dist/dev-support/bin/dist-layout-stitching index 612ee541ac..109bed13d5 100755 --- a/hadoop-ozone/dist/dev-support/bin/dist-layout-stitching +++ b/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" . diff --git a/hadoop-ozone/dist/pom.xml b/hadoop-ozone/dist/pom.xml index b69b910f7c..f625cb1526 100644 --- a/hadoop-ozone/dist/pom.xml +++ b/hadoop-ozone/dist/pom.xml @@ -191,5 +191,9 @@ org.apache.hadoop hadoop-ozone-datanode + + org.apache.hadoop + hadoop-hdds-docs + diff --git a/hadoop-ozone/ozone-manager/pom.xml b/hadoop-ozone/ozone-manager/pom.xml index 76e3afbe7a..840d9c8502 100644 --- a/hadoop-ozone/ozone-manager/pom.xml +++ b/hadoop-ozone/ozone-manager/pom.xml @@ -40,6 +40,11 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> hadoop-ozone-client + + org.apache.hadoop + hadoop-hdds-docs + + org.bouncycastle bcprov-jdk15on @@ -75,6 +80,12 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> webapps/static/**/*.* + + org.apache.hadoop + hadoop-hdds-docs + ${project.build.outputDirectory}/webapps/ozoneManager + docs/**/*.* + true diff --git a/hadoop-ozone/pom.xml b/hadoop-ozone/pom.xml index 5bd64a8ccc..f020abefdf 100644 --- a/hadoop-ozone/pom.xml +++ b/hadoop-ozone/pom.xml @@ -51,7 +51,6 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> datanode s3gateway dist - docs @@ -132,6 +131,11 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> hadoop-hdds-server-scm ${hdds.version} + + org.apache.hadoop + hadoop-hdds-docs + ${hdds.version} + org.apache.hadoop hadoop-hdds-container-service