[WIP] doc infra

.github/workflows/deploy-snapshot.sh

@@ -27,9 +27,10 @@ export GOOGLE_APPLICATION_CREDENTIALS=/tmp/google-credentials.json
 
 RESUME=""
 if echo ${VERSION} | grep SNAPSHOT >/dev/null && echo ${GITHUB_REPOSITORY} | grep O2-Czech-Republic >/dev/null; then
+  git submodule update
   TRY=0
   while [ $TRY -lt 3 ]; do
-    CMD="mvn deploy -DskipTests -Prelease-snapshot -Pallow-snapshots"
+    CMD="mvn deploy -DskipTests -Prelease-snapshot -Pallow-snapshots -Pwith-doc"
     if [ ! -z "${RESUME}" ]; then
       CMD="${CMD} $(echo $RESUME | sed "s/.\+\(-rf .\+\)/\1/")"
     fi

.github/workflows/snapshot.yml

@@ -30,6 +30,10 @@ jobs:
       uses: actions/setup-java@v1
       with:
         java-version: 1.8
+    - name: Setup Hugo
+      uses: peaceiris/actions-hugo@v2
+      with:
+        hugo-version: 'latest'
     - name: Deploy with Maven
       env:
         MAVEN_SETTINGS: ${{ secrets.MAVEN_SETTINGS }}

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/src/themes/book"]
+	path = docs/src/themes/book
+	url = https://github.com/alex-shpak/hugo-book

.travis.yml

@@ -9,6 +9,7 @@ addons:
   apt:
     packages:
       - realpath
+      - hugo
   sonarcloud:
     organization: datadriven
 
@@ -17,7 +18,7 @@ install: true
 before_script:
   - wget https://github.com/sormuras/bach/raw/master/install-jdk.sh
 script:
-  - mvn spotless:check -B -V && mvn install -B -V -Pallow-snapshots,with-coverage,travis -Dorg.slf4j.simpleLogger.log.org.apache.maven.plugins.shade=error || exit 1
+  - mvn spotless:check -B -V && mvn install -B -V -Pallow-snapshots,with-coverage,travis,with-doc -Dorg.slf4j.simpleLogger.log.org.apache.maven.plugins.shade=error || exit 1
   - export JAVA_HOME=$HOME/openjdk11
   - chmod u+x $TRAVIS_BUILD_DIR/install-jdk.sh
   - $TRAVIS_BUILD_DIR/install-jdk.sh --feature 11 --target $JAVA_HOME

docs/license-header-spotless.txt

@@ -0,0 +1 @@
+../license-header-spotless.txt

docs/license-header.txt

@@ -0,0 +1 @@
+../license-header.txt

docs/pom.xml

@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright 2017-2020 O2 Czech Republic, a.s.
+
+    Licensed 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">
+  <parent>
+    <artifactId>platform-parent</artifactId>
+    <groupId>cz.o2.proxima</groupId>
+    <version>0.5-SNAPSHOT</version>
+  </parent>
+  <modelVersion>4.0.0</modelVersion>
+
+  <artifactId>proxima-docs</artifactId>
+  <packaging>pom</packaging>
+
+  <name>${project.groupId}:${project.artifactId}</name>
+  <properties>
+    <proxima.doc.baseurl>https://proxima.datadriven.cz</proxima.doc.baseurl>
+    <maven.exec.version>3.0.0</maven.exec.version>
+  </properties>
+
+  <profiles>
+    <profile>
+      <id>with-doc</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>exec-maven-plugin</artifactId>
+            <version>${maven.exec.version}</version>
+            <executions>
+              <execution>
+                <id>build-doc</id>
+                <phase>package</phase>
+                <goals>
+                  <goal>exec</goal>
+                </goals>
+                <configuration>
+                  <executable>hugo</executable>
+                  <workingDirectory>${project.basedir}/src/</workingDirectory>
+                  <arguments>
+                    <argument>-b</argument>
+                    <argument>${proxima.doc.baseurl}</argument>
+                    <argument>-F</argument>
+                    <argument>-d</argument>
+                    <arguemnt>${project.build.directory}/public/</arguemnt>
+                    <argument>--buildDrafts</argument>
+                  </arguments>
+                </configuration>
+              </execution>
+              <execution>
+                <id>deploy-doc</id>
+                <phase>deploy</phase>
+                <goals>
+                  <goal>exec</goal>
+                </goals>
+                <configuration>
+                  <executable>hugo</executable>
+                  <workingDirectory>${project.basedir}/src/</workingDirectory>
+                  <arguments>
+                    <argument>deploy</argument>
+                  </arguments>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+</project>

docs/src/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+

docs/src/config.yaml

@@ -0,0 +1,63 @@
+#
+# Copyright 2017-2020 O2 Czech Republic, a.s.
+#
+# Licensed 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.
+#
+
+baseURL: https://proxima.datadriven.cz
+languageCode: en-us
+title: Proxima platform
+theme: book
+
+#googleAnalytics = "UA-XXXXXXXXX-X"
+
+# Needed for mermaid/katex shortcodes
+markup:
+  goldmark:
+    renderer:
+      unsafe: true
+  tableOfContents:
+    startLevel: 1
+
+languages:
+  en:
+    languageName: English
+    contentDir: content
+    weight: 1
+
+menu:
+    # before: []
+    after:
+        - name: "Github"
+          url: "https://github.com/datadrivencz/proxima-platform/"
+          weight: 10
+        - name: "Hugo Themes"
+          url: "https://themes.gohugo.io/hugo-book/"
+          weight: 20
+
+
+enableGitInfo: true
+params:
+    BookTheme: light
+    BookMenuBundle: /menu
+    BookRepo: https://github.com/datadrivencz/proxima-platform/
+    BookEditPath: edit/master/docs/src/content
+#    BookComments: false
+    BookPortableLinks: true
+    BookServiceWorker: true
+
+deployment:
+  order: [".jpg$", ".gif$", ".png$"]
+  targets:
+    - name: proxima-doc
+      URL: "gs://proxima-docs?prefix=proxima-docs/"

docs/src/content/_index.md

@@ -0,0 +1 @@
+# Proxima platform documentation (WIP)

docs/src/content/docs/index.md

@@ -0,0 +1,5 @@
+---
+headless: false
+draft: false
+---
+## TEST

docs/src/content/license.md

@@ -0,0 +1,19 @@
+---
+title: "License"
+date: 2020-10-25T13:46:22+01:00
+draft: true
+---
+**License**
+
+Licensed 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.
+

docs/src/content/menu/index.md

@@ -0,0 +1,8 @@
+---
+headless: true
+draft: false
+---
+- [Book Example]({{< relref "/" >}})
+  - [Page One]({{< relref "/" >}})
+  - [Page Two]({{< relref "/" >}})
+- [Blog]({{< relref "/" >}})

docs/src/public

@@ -0,0 +1 @@
+../target/public/