chore:fix4: add improvements documentation

Author: emmanueltd

example/azure-pipelines.yml

@@ -9,10 +9,6 @@ trigger:
 pr: none
 
 parameters:
-  - name: XAPIEMAIL
-    type: string
-    displayName: X-API-EMAIL
-    default: user@email.com
   - name: XAPIKEY
     type: string
     displayName: X-API-KEY
@@ -51,7 +47,6 @@ jobs:
     - ${{ if ne(variables['Build.Reason'],'manual') }}:
       - bash: |
            echo "##vso[task.setvariable variable=XAPIKEY]$(echo $(XAPIKEY_EXAMPLES))"
-           echo "##vso[task.setvariable variable=XAPIEMAIL]$(echo $(XAPIEMAIL_EXAMPLES))"
            echo "##vso[task.setvariable variable=BUILDINGID]$(echo $(BUILDING_ID_EXAMPLES))"
            echo "##vso[task.setvariable variable=DASHBOARD_URL]$(echo 'https://dashboard.situm.com')"
            echo "##vso[task.setvariable variable=BUILDNUMBER]$(echo $(Build.BuildNumber) | awk -F"." '{if ($2 < 10) print $1"0"$2; else print $1$2}')"
@@ -62,7 +57,6 @@ jobs:
     - ${{ if eq(variables['Build.Reason'],'manual') }}:
       - bash: |
            echo "##vso[task.setvariable variable=XAPIKEY]$(echo ${{parameters.XAPIKEY}})"
-           echo "##vso[task.setvariable variable=XAPIEMAIL]$(echo ${{ parameters.XAPIEMAIL}})"
            echo "##vso[task.setvariable variable=BUILDINGID]$(echo ${{ parameters.BUILDINGID}})"
            echo "##vso[task.setvariable variable=FLOORID]$(echo ${{ parameters.FLOORID}})"
            echo "##vso[task.setvariable variable=DASHBOARD_URL]$(echo ${{ parameters.DASHBOARD_URL }})"
@@ -74,7 +68,6 @@ jobs:
     - template: azure/common-steps.yaml
       parameters:
         XAPIKEY: $(XAPIKEY)
-        XAPIEMAIL: $(XAPIEMAIL)
         BUILDINGID: $(BUILDINGID)
         FLOORID: $(FLOORID)
         DASHBOARD_URL: $(DASHBOARD_URL)
@@ -85,7 +78,6 @@ jobs:
         DASHBOARD_URL: $(DASHBOARD_URL)
         system: $(ubuntuVersion)
         BUILDINGID: $(BUILDINGID)
-        XAPIEMAIL: $(XAPIEMAIL)
         BUILDNUMBER: $(BUILDNUMBER)
     - ${{ if ne(variables['Build.Reason'],'manual') }}:
       - template: azure-templates/teams-notifier.yml@sys_kubernetes_templates
@@ -107,7 +99,6 @@ jobs:
     - ${{ if ne(variables['Build.Reason'],'manual') }}:
       - bash: |
            echo "##vso[task.setvariable variable=XAPIKEY]$(echo $(XAPIKEY_EXAMPLES))"
-           echo "##vso[task.setvariable variable=XAPIEMAIL]$(echo $(XAPIEMAIL_EXAMPLES))"
            echo "##vso[task.setvariable variable=BUILDINGID]$(echo $(BUILDING_ID_EXAMPLES))"
            echo "##vso[task.setvariable variable=DASHBOARD_URL]$(echo 'https://dashboard.situm.com')"
            echo "##vso[task.setvariable variable=BUILDNUMBER]$(echo $(Build.BuildNumber) | awk -F"." '{if ($2 < 10) print $1"0"$2; else print $1$2}')"
@@ -118,7 +109,6 @@ jobs:
     - ${{ if eq(variables['Build.Reason'],'manual') }}:
       - bash: |
            echo "##vso[task.setvariable variable=XAPIKEY]$(echo ${{parameters.XAPIKEY}})"
-           echo "##vso[task.setvariable variable=XAPIEMAIL]$(echo ${{ parameters.XAPIEMAIL}})"
            echo "##vso[task.setvariable variable=BUILDINGID]$(echo ${{ parameters.BUILDINGID}})"
            echo "##vso[task.setvariable variable=FLOORID]$(echo ${{ parameters.FLOORID}})"
            echo "##vso[task.setvariable variable=DASHBOARD_URL]$(echo ${{ parameters.DASHBOARD_URL }})"
@@ -137,7 +127,6 @@ jobs:
     - template: azure/common-steps.yaml
       parameters:
         XAPIKEY: $(XAPIKEY)
-        XAPIEMAIL: $(XAPIEMAIL)
         BUILDINGID: $(BUILDINGID)
         FLOORID: $(FLOORID)
         DASHBOARD_URL: $(DASHBOARD_URL)
@@ -148,7 +137,6 @@ jobs:
       parameters:
         DASHBOARD_URL: $(DASHBOARD_URL)
         system: $(macOSVersion)
-        XAPIEMAIL: $(XAPIEMAIL)
         BUILDINGID: $(BUILDINGID)
         BUILDNUMBER: $(BUILDNUMBER)
 

example/azure/build-examples.yaml

@@ -3,8 +3,6 @@ parameters:
     type: string
   - name: DASHBOARD_URL
     type: string
-  - name: XAPIEMAIL
-    type: string
   - name: BUILDINGID
     type: string
   - name: BUILDNUMBER
@@ -54,7 +52,7 @@ steps:
           gem install fastlane
 
           dashboard=$(echo ${{ parameters.DASHBOARD_URL }} | awk -F"/" '{print $3}')
-          export WHATS_NEW="Plugin version: $(pluginVersion), USER: ${{parameters.XAPIEMAIL}}, BUILDINGID: ${{ parameters.BUILDINGID }}, DASHBOARD_URL: $dashboard"
+          export WHATS_NEW="Plugin version: $(pluginVersion), BUILDINGID: ${{ parameters.BUILDINGID }}, DASHBOARD_URL: $dashboard"
           export BUILDNUMBER=${{ parameters.BUILDNUMBER }}
           echo -e "\n[+] Setting variables to deploy:"
           echo -e "\t[+] Set WHATS_NEW: $WHATS_NEW"

example/azure/common-steps.yaml

@@ -1,8 +1,6 @@
 parameters:
   - name: system
     type: string
-  - name: XAPIEMAIL
-    type: string
   - name: XAPIKEY
     type: string
   - name: BUILDINGID
@@ -48,14 +46,12 @@ steps:
       echo "##vso[task.setvariable variable=pluginVersion]$(echo $pluginVersion)"
 
       echo -e "\n[+] Variables to set:"
-      echo -e "\t[+] X-API-EMAIL: ${{ parameters.XAPIEMAIL }}"
       echo -e "\t[+] BUILDINGID: ${{ parameters.BUILDINGID }}"
       echo -e "\t[+] FLOORID: ${{ parameters.FLOORID }}"
       echo -e "\t[+] DASHBOARD_URL: ${{ parameters.DASHBOARD_URL }}"
       echo -e "\t[+] BUILDNUMBER: ${{ parameters.BUILDNUMBER }}"
       echo -e "\t[+] Plugin Version used: $pluginVersion"
 
-      echo "export const SITUM_EMAIL = '${{ parameters.XAPIEMAIL }}';" > example/src/situm.tsx
       echo "export const SITUM_API_KEY = '${{ parameters.XAPIKEY }}';" >> example/src/situm.tsx
       echo "export const BUILDING_IDENTIFIER = '${{ parameters.BUILDINGID }}';" >> example/src/situm.tsx
       echo "export const SITUM_DASHBOARD_URL = '${{ parameters.DASHBOARD_URL }}';"  >> example/src/situm.tsx

example/src/situm.tsx

@@ -12,7 +12,7 @@ export const REMOTE_IDENTIFIER = '';
 export const LANGUAGE = '';
 
 // A String parameter that allows you to specify which domain will be displayed inside our webview.
-export const SITUM_DASHBOARD_URL = 'https://dashboard.situm.com';
+export const API_DOMAIN = 'https://dashboard.situm.com';
 
 // Supporting documentation
 `