WPB-20718: update multi-ingress deeplink doc

.github/workflows/build.yaml

@@ -32,8 +32,7 @@ jobs:
               CURRENT_BRANCH="${GITHUB_REF#refs/heads/}"
           fi
 
-          sed -i "s|url = https://github.com/wireapp/wire-server.git|url = ${CURRENT_REPO_URL}|g" .gitmodules
-          sed -i "s|branch = clean-wire-server-docs|branch = ${CURRENT_BRANCH}|g" .gitmodules
+          git config -f .gitmodules submodule.wire-server.branch ${CURRENT_BRANCH}
 
           cat .gitmodules
           make build

changelog.d/4-docs/update-multiingress-deeplink-docs

@@ -0,0 +1 @@
+Update multi-ingress deeplink documentation to have a better example

docs/README.md

@@ -44,15 +44,16 @@
 When a page needs to be moved because it's related to code changes:
 1. Add the page to `wire-server/docs` and merge it to the develop branch
 2. In `wire-docs`:
-   - Update the `wire-server` submodule to the latest commit
+   - Update the `wire-server` submodule (to the latest commit) and commit that change
    - Delete the original page from `wire-docs/src`
    - Create a relative symbolic link to the file in the `wire-server` module:
      ```
      cd src/developer/reference/
      rm example-file.svg
      ln -s ../../../wire-server/docs/src/developer/reference/example-file.svg example-file.svg
      ```
-3. Test with `make run` before creating a PR
+3. Commit new linked files before testing with `make run`
+4. Test with `make run` before creating a PR
 
 ## Creating New Files
 
@@ -61,7 +62,7 @@ When a page needs to be moved because it's related to code changes:
 2. Merge it into `wire-server:develop`
 3. To make it discoverable on docs.wire.com:
    - Update the navigation structure in [mkdocs.yml](https://github.com/wireapp/wire-docs/blob/main/mkdocs.yml#L9) or update the directory's README.md to include references to the new file, or add references to the new file from relevant existing pages
-   - Update the `wire-server` submodule reference in `wire-docs` if not done automatically
+   - Update the `wire-server` submodule reference in `wire-docs` (if not done automatically) and commit the change
    - Add references to the new file from relevant existing pages
    - Test with `make run` and create a PR to `wire-docs:main`
 
@@ -82,7 +83,8 @@ When a page needs to be moved because it's related to code changes:
 1. Identify all references to the file in `wire-docs` and `wire-server/docs`
 2. Remove all references and links from navigation (mkdocs.yml) and other pages
 3. Delete the file from its location
-4. Submit a PR to `wire-docs:main`
+4. Commit local deleted files before testing with `make run`
+5. Submit a PR to `wire-docs:main`
 
 ## Publishing Changes
 

docs/src/understand/associate/deeplink.md

@@ -128,12 +128,29 @@ Now both static files should become accessible at the backend domain under `/dee
 
 #### Host deeplinks for a multi ingress setup
 
-This configuration is necessary only when using a [Multi-Ingress Setup](../../developer/reference/config-options.md#multi-ingress-setup). To enable deeplink URLs on different domains configured under `nginx_conf.additional_external_env_domains`, use the following configuration:
+This configuration is necessary only when using a [Multi-Ingress Setup](../../developer/reference/config-options.md#multi-ingress-setup). To enable the deeplink for a default domain in the case of multi-ingress, the default config i.e. `nginx_conf.external_env_domain` and `nginx_conf.deeplink` should be kept. To enable deeplink URLs for rest of the domains configure the `nginx_conf.additional_external_env_domains` and `nginx_conf.multi_ingress_deeplink`. Example configuration:
 
 ```
 nginz:
   nginx_conf:
-    ...
+    external_env_domain: default.example.com
+    deeplink:
+      endpoints:
+        backendURL: "https://nginz-https.default.example.com"
+        backendWSURL: "https://nginz-ssl.default.example.com"
+        teamsURL: "https://teams.default.example.com"
+        accountsURL: "https://account.default.example.com"
+        blackListURL: "https://clientblacklist.default.example.com/prod"
+        websiteURL: "https://default.example.com"
+      apiProxy: # (optional)
+        host: "socks5.proxy.com"
+        port: 1080
+        needsAuthentication: true
+      title: "Example Backend"
+    additional_external_env_domains:
+      - red.example.com
+      - green.example.org      
+      - blue.example.net
     multi_ingress_deeplink:
       red.example.com:
         endpoints: