add documentation for Apps SDK #WPB-19997

.gitmodules

@@ -2,3 +2,8 @@
 	path = wire-server
 	url = https://github.com/wireapp/wire-server.git
 	branch = develop
+
+[submodule "wire-apps-jvm-sdk"]
+	path = wire-apps-jvm-sdk
+	url = https://github.com/wireapp/wire-apps-jvm-sdk.git
+	branch = main

build/build_versions.sh

@@ -71,7 +71,8 @@ git checkout ${CURRENT_TAG}
 
 # pull the submodule
 git submodule update --init --depth 1 wire-server
-
+git submodule update --init --depth 1 wire-apps-jvm-sdk
+
 # Check if tag exists in mike
 if [ -n "${existing_tags[$CURRENT_TAG]}" ]; then
     existing_commit="${existing_tags[$CURRENT_TAG]}"
@@ -91,6 +92,7 @@ else
 
 # deinit the submodule to avoid issues with the next iteration
 git submodule deinit -f wire-server
+git submodule deinit -f wire-apps-jvm-sdk
 
 # Set the default tag and create an alias to $CURRENT_TAG
 $mike set-default $CURRENT_TAG

build/prepare.sh

@@ -51,4 +51,4 @@ else
 fi
 
 echo "Syncing all the other files changes from ${ORIGINAL_DIR}/ to ${TEMP_DIR}, to work on uncommited changes, if any"
-rsync -a --exclude='/.git' --exclude="/wire-server" --exclude='wire-docs*.tar.gz' --exclude=".tmpdir" "${ORIGINAL_DIR}/" "$TEMP_DIR/"
+rsync -a --exclude='/.git' --exclude="/wire-server" --exclude="/wire-apps-jvm-sdk" --exclude='wire-docs*.tar.gz' --exclude=".tmpdir" "${ORIGINAL_DIR}/" "$TEMP_DIR/"

mkdocs.yml

@@ -98,6 +98,10 @@ nav:
         - Connection: developer/reference/user/connection.md
         - User Registration: developer/reference/user/registration.md
         - User Rich info: developer/reference/user/rich-info.md
+  - Apps SDK:
+      - Understanding Apps: integrations/README.md
+      - Creating An App: integrations/creating-an-app.md
+      - Permissions: integrations/permissions.md
   - Security Responses:
       - Overview: security-responses/README.md
       - "2023-01-19 - Security Advisory: HTML Injection in wire.com": security-responses/2023-01-19_html_injection.md

src/README.md

@@ -23,6 +23,7 @@ Release notes of `wire-server` can be found [here](https://github.com/wireapp/wi
 * [Administration](how-to/administrate/README.md)
 * [Reference](understand/README.md)
 * [Developers Notes](developer/README.md)
+* [Apps SDK](integrations/README.md)
 * [Security responses](security-responses/README.md)
 * [Release Notes](changelog/README.md)
 

src/integrations/README.md

@@ -0,0 +1 @@
+../../wire-apps-jvm-sdk/docs/src/README.md

src/integrations/creating-an-app.md

@@ -0,0 +1 @@
+../../wire-apps-jvm-sdk/docs/src/creating-an-app.md

src/integrations/images/create-app.png

@@ -0,0 +1 @@
+../../../wire-apps-jvm-sdk/docs/src/images/create-app.png

src/integrations/permissions.md

@@ -0,0 +1 @@
+../../wire-apps-jvm-sdk/docs/src/permissions.md