ARC-2061 changing all references from sample to example (#34)

Author: mboudreau

README.md

@@ -1,9 +1,9 @@
-# [WIP] atlassian-connect-sample-app-node
+# [WIP] Atlassian Connect example app - Node edition
 
 > **_NOTE:_**  This repository is in progress and is not ready yet.
 
 ## About
-This repository contains a [Express](https://expressjs.com/en/4x/api.html) starter for building an [Atlassian Connect app](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/).
+This repository contains an example [Express](https://expressjs.com/en/4x/api.html) server for building an [Atlassian Connect app](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/).
 This app is aimed to help you to easily add your integration in Jira.
 
 ## Table of Contents

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@atlassian/atlassian-connect-sample-app-node",
+  "name": "@atlassian/node-connect-example",
   "version": "1.0.0",
-  "repository": "[email protected]:atlassian/atlassian-connect-sample-app-node.git",
+  "repository": "[email protected]:atlassian/atlassian-connect-example-app-node.git",
   "license": "MIT",
   "private": false,
   "scripts": {

src/content/authentication.md

@@ -131,7 +131,7 @@ which also provides a comprehensive list of claims supported by Atlassian produc
 
 ### Atlassian JWT libraries
 
-In this sample app, we use the [atlassian-jwt](https://www.npmjs.com/package/atlassian-jwt) library to create a middleware 
+In this example app, we use the [atlassian-jwt](https://www.npmjs.com/package/atlassian-jwt) library to create a middleware 
 called `connectIframeJWTMiddleware`, which decodes the JWT token from Jira, verifies it and sets the `clientKey` in `res.locals`.
 The tenant (Jira site) for each instance of the app is recognized based on this `clientKey`. Step by step, 
 `connectIframeJWTMiddleware` is responsible for:

src/content/config.md

@@ -1,15 +1,15 @@
 # Atlassian Connect JSON
 
 When you create a Connect app you'll need to include an app descriptor JSON file. This is what you'll use to
-provide information to Atlassian about your application, also known as an add-on. In this sample app you'll find 
+provide information to Atlassian about your application, also known as an add-on. In this example app you'll find 
 the configuration for this in src/config/index.ts which is what we are rendering below. Included in this project's 
 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
-- `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`
+- `baseUrl`: The base url of the remote app, which is used for all communications back to the app instance. For this
+  example 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 
@@ -23,14 +23,14 @@ more detail in **Lifecycle Events**
 - `modules`: extensions for the parts of Jira.
   - `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 example 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.
     - `url`: the url to retrieve the content from. This must be relative to your app's baseUrl.
     - `key`: a key to identify this module. The key is used to generate the url to your add-on's module e.g.
     The node app URL `https://<TUNNELED_URL>/config` is now mapped to 
-    `https://<JIRAHOST_INSTANCE>/plugins/servlet/ac/com.atlassian.sample-app-node/acn-config`
+    `https://<JIRAHOST_INSTANCE>/plugins/servlet/ac/com.example.node-connect-app/acn-config`
     - `location`: defines the location in the application interface where the page's link should appear. For finding 
     locations, please use the linked web fragment finders for 
     [Jira](https://marketplace.atlassian.com/apps/1211656/web-fragment-finder?hosting=cloud&tab=overview)

src/content/connect-js.md

@@ -37,7 +37,7 @@ Once this has been added you'll be able to access the following features:
 - Request—make an XMLHttpRequest to the host product
 - User—obtain the user's Atlassian account ID, time zone, and locale
 
-In this sample app you'll see that in our views, we're using the navigator feature to navigate from one page to the next:
+In this example app you'll see that in our views, we're using the navigator feature to navigate from one page to the next:
 
 ```
 document.getElementById('homePage').addEventListener('click', () => {

src/content/introduction.md

@@ -1,9 +1,9 @@
 # Introduction
 
-Welcome to the Node.js Connect sample app! This sample app has been built to help you and your team get up-and-running faster
+Welcome to the Atlassian Connect Node.js example app! This has been built to help you and your team get up-and-running faster
 by providing examples of the key features, functionality and things you'll need to create a
 [Connect](https://developer.atlassian.com/cloud/bitbucket/faqs/#:~:text=Atlassian%20Connect%20is%20a%20distributed,wherever%2C%20whenever%2C%20and%20however)
-app. In this sample app you'll find information about the following:
+app. In this example app you'll find information about the following:
 
 - [**Atlassian Connect JSON**](/acn-config): what it is, an example of an Atlassian Connect JSON file, and a link to where you can get more information
 - [**Lifecycle Events**](/acn-lifecycle-events): outline of what lifecycle events are supported, an example of how to use them, and a link to documentation

src/env.ts

@@ -19,6 +19,6 @@ if (!variables?.NGROK_AUTHTOKEN) {
 }
 
 export const envVars: EnvVars = {
-	APP_KEY: "com.atlassian.sample-app-node",
+	APP_KEY: "com.example.node-connect-app",
 	...variables
 } as EnvVars;

src/routes/atlassian-connect.ts

@@ -13,31 +13,31 @@ export const connectAppDescriptor = {
 	/**
 	 * Name of the Connect app
 	 */
-	name: "Atlassian Connect Sample Node App",
+	name: "Atlassian Connect Example Node App",
 
 	/**
 	 * Description for the Connect app
 	 */
-	description: "Atlassian Connect Sample Node App",
+	description: "Atlassian Connect Example Node App",
 
 	/**
 	 *  A unique key to identify your Connect app. This key must be <= 64 characters.
 	 */
 	key: envVars.APP_KEY,
 
 	/**
-	 * The base url of the remote app, which is used for all communications back to the app instance.
+	 * The base url of the server, which is used for all communications between Connect and the app.
 	 *
-	 * For this sample app, this is the tunneled URL which is set in the `prestart.ts`
+	 * The tunneled URL which is set in the `prestart.ts`
 	 */
 	baseUrl: envVars.APP_URL,
 
 	/**
 	 * The vendor who is offering this Connect app.
 	 */
 	vendor: {
-		name: "Node Connect app sample",
-		url: "https://github.com/atlassian/atlassian-connect-sample-app-node/"
+		name: "Atlassian",
+		url: "https://atlassian.com"
 	},
 
 	/**
@@ -93,7 +93,7 @@ export const connectAppDescriptor = {
 
 		/**
 		 * List of all the webhooks for the Connect app.
-		 * For this sample app, we've added some Jira webhooks events.
+		 * For this example, we've added some Jira webhooks events.
 		 *
 		 * https://developer.atlassian.com/cloud/jira/platform/webhooks/
 		 */
@@ -122,7 +122,7 @@ export const connectAppDescriptor = {
 				key: "addon-web-section",
 				location: "admin_plugins_menu",
 				name: {
-					value: "Connect Sample Node App"
+					value: "Node Connect Example App"
 				}
 			}
 		],
@@ -144,7 +144,7 @@ export const connectAppDescriptor = {
 				 * The url is generated as a combination of your add-on key and module key.
 				 *
 				 * For instance:
-				 * The node app URL `https://<TUNNELED_URL>/config` is now mapped to `https://<JIRAHOST_INSTANCE>/plugins/servlet/ac/com.atlassian.sample-app-node/acn-config`
+				 * The node app URL `https://<TUNNELED_URL>/config` is now mapped to `https://<JIRAHOST_INSTANCE>/plugins/servlet/ac/com.example.node-connect-app/acn-config`
 				 */
 				key: "acn-config",