Minor fixes (#29)

krazziekay · web-flow · commit 766602e00b80 · 2023-03-22T15:16:02.000+11:00
diff --git a/src/content/authentication.md b/src/content/authentication.md
@@ -105,7 +105,7 @@ and verify future requests e.g.
 Knowledge of JWT is a prerequisite. Check out the [Understanding JWT](https://developer.atlassian.com/cloud/bitbucket/understanding-jwt-for-apps/) 
 for apps page if you are unfamiliar with JWT.
 
-For more details on how to create a jwt token, see [Creating a JWT Token](https://developer.atlassian.com/cloud/bitbucket/understanding-jwt-for-apps/#creating-a-jwt-token).
+For more details on how to create a JWT token, see [Creating a JWT Token](https://developer.atlassian.com/cloud/bitbucket/understanding-jwt-for-apps/#creating-a-jwt-token).
 
 **Exposing a service**
 
@@ -136,9 +136,9 @@ called `connectIframeJWTMiddleware`, which decodes the JWT token from Jira, veri
 The tenant (Jira site) for each instance of the app is recognized based on this `clientKey`. Step by step, 
 `connectIframeJWTMiddleware` is responsible for:
 - injecting the Jira instance URL into the [iframe](./modules.md/#iframe) url
-- decoding jwt token without verification
+- decoding JWT token without verification
 - get the jira tenant associated with the url
-- tries to verify the jwt token
+- tries to verify the JWT token
 - verify the query string hash
 - save the jiraTenant to `res.locals` to be used later if all verifications pass
 
diff --git a/src/content/config.md b/src/content/config.md
@@ -7,12 +7,12 @@ app descriptor is:
 
 - `name`: the name of the Connect app
 - `description`: description for the Connect app
-- `key`: a unique key to identify your connect app. This key must be <= 64 characters
+- `key`: a unique key to identify your Connect app. This key must be <= 64 characters
 - `baseUrl`: The base url of the remote app, which is used for all communications back to the app instance. For this 
 sample app, this is the tunneled URL which is set in the `prestart.ts`
 - `vendor`: the vendor who is offering this Connect app
 - `authentication`: this defines the authentication type to use when signing requests between the host application 
-and the connect app. The supported types include `jwt`, `JWT`, `none`, `NONE`. We'll go into more detail around 
+and the Connect app. The supported types include `jwt`, `JWT`, `none`, `NONE`. We'll go into more detail around 
 authentication in **Auth with JWT and Storage**
 - `scopes`: sets the [scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-connect-apps/) requested 
 by the app
@@ -23,7 +23,7 @@ more detail in **Lifecycle Events**
 - `modules`: the list of modules this app provides.
   - `postInstallPage`: this is the first page where the user lands after clicking on the `Get Started` link after 
   installing the app. You can think of this page as the main index page for the app.
-  - `webhooks`: list of all the webhooks for the connect app. For this sample app, we've added some Jira webhooks 
+  - `webhooks`: list of all the webhooks for the Connect app. For this sample app, we've added some Jira webhooks 
   events. In our **Webhooks** page, we'll provide some webhook logs so you can get a better picture of what your app 
   will be listening to
   - `generalPages`: list of [pages/views](https://developer.atlassian.com/cloud/jira/software/modules/page/) within the app.
diff --git a/src/content/modules.md b/src/content/modules.md
@@ -39,9 +39,9 @@ Please refer to our documentation for information about [Opting in to cacheable
 ## Jira modules
 
 For Jira, there are 2 types of modules: 
-- **basic iFrames** these include [location-based modules](https://developer.atlassian.com/cloud/jira/platform/about-connect-modules-for-jira/#location-based-modules), 
-[new jira issue view modules](https://developer.atlassian.com/cloud/jira/platform/about-connect-modules-for-jira/#new-jira-issue-view-modules), 
-and [pages and dialogs](https://developer.atlassian.com/cloud/jira/platform/about-connect-modules-for-jira/#pages-and-dialogs.
+- **basic iframes**: these include [location-based modules](https://developer.atlassian.com/cloud/jira/platform/about-connect-modules-for-jira/#location-based-modules), 
+[new Jira issue view modules](https://developer.atlassian.com/cloud/jira/platform/about-connect-modules-for-jira/#new-jira-issue-view-modules), 
+and [pages and dialogs](https://developer.atlassian.com/cloud/jira/platform/about-connect-modules-for-jira/#pages-and-dialogs).
 - [**advanced modules**](https://developer.atlassian.com/cloud/jira/platform/about-connect-modules-for-jira/#advanced-ui-modules): 
 these allow you to extend specific Jira features such as the issue tab panel and dashboard
 items.
diff --git a/src/routes/atlassian-connect.ts b/src/routes/atlassian-connect.ts
@@ -11,17 +11,17 @@ export const connectDescriptorGet = async (_: Request, res: Response): Promise<v
 export const connectAppDescriptor = {
 
 	/**
-	 * Name of the connect app
+	 * Name of the Connect app
 	 */
 	name: "Atlassian Connect Sample Node App",
 
 	/**
-	 * Description for the connect app
+	 * Description for the Connect app
 	 */
 	description: "Atlassian Connect Sample Node App",
 
 	/**
-	 *  A unique key to identify your connect app. This key must be <= 64 characters.
+	 *  A unique key to identify your Connect app. This key must be <= 64 characters.
 	 */
 	key: envVars.APP_KEY,
 
@@ -33,19 +33,19 @@ export const connectAppDescriptor = {
 	baseUrl: envVars.APP_URL,
 
 	/**
-	 * The vendor who is offering this connect app.
+	 * The vendor who is offering this Connect app.
 	 */
 	vendor: {
-		name: "Node connect app sample",
+		name: "Node Connect app sample",
 		url: "https://github.com/atlassian/atlassian-connect-sample-app-node/"
 	},
 
 	/**
-	 * Defines the authentication type to use when signing requests between the host application and the connect app.
+	 * Defines the authentication type to use when signing requests between the host application and the Connect app.
 	 * Types include: `jwt`, `JWT`, `none`, `NONE`
 	 *
-	 * Pages defined in the connect app(by default) run within the iframe inside Jira,
-	 * Defining this authentication will pass the jwt token for each page running within the iframe.
+	 * Pages defined in the Connect app(by default) run within the iframe inside Jira,
+	 * Defining this authentication will pass the JWT token for each page running within the iframe.
 	 */
 	authentication: {
 		type: "jwt"
@@ -91,7 +91,7 @@ export const connectAppDescriptor = {
 		},
 
 		/**
-		 * List of all the webhooks for the connect app.
+		 * List of all the webhooks for the Connect app.
 		 * For this sample app, we've added some Jira webhooks events.
 		 *
 		 * https://developer.atlassian.com/cloud/jira/platform/webhooks/
diff --git a/src/views/layout.squirrelly b/src/views/layout.squirrelly
@@ -10,7 +10,7 @@
     <link rel="stylesheet" href="/public/css/sidebar.css" media="all">
     <link rel="stylesheet" href="/public/css/back-nav.css" media="all">
 
-    <!-- This script is needed for all the views in the connect app -->
+    <!-- This script is needed for all the views in the Connect app -->
     <script src="https://connect-cdn.atl-paas.net/all.js" data-options="sizeToParent:true" async></script>
 </head>
 
diff --git a/src/views/webhook-logs.squirrelly b/src/views/webhook-logs.squirrelly
@@ -18,12 +18,12 @@
         </div>
 
         <div class="logs-container">
-            {{@if(it.logs)}}
-            {{@each(it.logs) => log}}
-            <pre>{{log.message}} -----> {{log.data}}</pre>
-            {{/each}}
+            {{@if(it.logs.length)}}
+                {{@each(it.logs) => log}}
+                    <pre>{{log.message}} -----> {{log.data}}</pre>
+                {{/each}}
             {{#else}}
-            <pre>No logs yet!</pre>
+                <pre>No logs yet!</pre>
             {{/if}}
         </div>
     </div>
