From aaf2497cfb6fdb89375ba289dcff30c09e9734ff Mon Sep 17 00:00:00 2001 From: Mike Bruin Date: Thu, 11 Jul 2024 13:50:35 -0400 Subject: [PATCH 01/11] NR-172722 added docs for manually installing the agent --- .../installation/manual-installation.mdx | 29 +++++++++++++++++++ src/nav/mobile-monitoring.yml | 2 ++ 2 files changed, 31 insertions(+) create mode 100644 src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx diff --git a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx new file mode 100644 index 00000000000..627a1cb2f40 --- /dev/null +++ b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx @@ -0,0 +1,29 @@ +--- +title: xcframework manual installation +metaDescription: How to instrument to your iOS applications by downloading the xcframework. +freshnessValidatedDate: never +--- + +We recommend that you use our [guided install](https://onenr.io/0qwLv87gkj5) to set up iOS monitoring. However, if you need to install the agent manually, follow the steps below to install the New Relic iOS agent by downloading the xcframework. + +## Manually add the iOS agent to your project + +Follow these steps to install an XCFramework into your Xcode project: + +1. Download the latest iOS agent from our [iOS agent release notes](/docs/release-notes/mobile-release-notes/ios-release-notes). +2. Navigate to where the iOS agent was downloaded and unzip it. +3. Add the iOS agent XCFramework to your project: + - Right-click on the **"Project Navigator"** area, which is the first tab in the left sidebar. + - Select **"Add Files to [YourProjectName]"**. + - Navigate to the location of the XCFramework on your disk. + - Select the XCFramework directory and click **"Add"**. + +4. Embed the iOS agent xcframework: + - Select your project in the Project Navigator to open the project and target settings. + - Click on the target to which you want to add the XCFramework. + - Go to the **"General"** tab. + - Scroll down to the **"Frameworks, Libraries, and Embedded Content"** section. + - Make sure the XCFramework is listed here. If it's not, click the **"+"** button and add it. + - For the XCFramework you just added, change the **"Embed"** option to **"Embed & Sign"**. + +By following these steps, you should have successfully added the iOS agent to your Xcode project. \ No newline at end of file diff --git a/src/nav/mobile-monitoring.yml b/src/nav/mobile-monitoring.yml index 1e6fe9eb090..7d9fcac2d9e 100644 --- a/src/nav/mobile-monitoring.yml +++ b/src/nav/mobile-monitoring.yml @@ -57,6 +57,8 @@ pages: path: /docs/mobile-monitoring/new-relic-mobile-ios/installation/cocoapods-installation - title: Swift package manager path: /docs/mobile-monitoring/new-relic-mobile-ios/installation/spm-installation + - title: Manually copy XCFramework + path: /docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-install - title: iOS compatibility and requirements path: /docs/mobile-monitoring/new-relic-mobile-ios/get-started/new-relic-ios-compatibility-requirements - title: iOS distributed tracing From 716791c48aceddbae17e4d7c8b00d6ad27fed3c1 Mon Sep 17 00:00:00 2001 From: Mike Bruin Date: Thu, 11 Jul 2024 15:04:39 -0400 Subject: [PATCH 02/11] Recommended fixes --- .../installation/manual-installation.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx index 627a1cb2f40..65637c8b1f2 100644 --- a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx +++ b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx @@ -13,17 +13,15 @@ Follow these steps to install an XCFramework into your Xcode project: 1. Download the latest iOS agent from our [iOS agent release notes](/docs/release-notes/mobile-release-notes/ios-release-notes). 2. Navigate to where the iOS agent was downloaded and unzip it. 3. Add the iOS agent XCFramework to your project: - - Right-click on the **"Project Navigator"** area, which is the first tab in the left sidebar. + - Right-click on the **"Project Navigator"** area. - Select **"Add Files to [YourProjectName]"**. - Navigate to the location of the XCFramework on your disk. - - Select the XCFramework directory and click **"Add"**. + - Select the NewRelic.xcframework directory and click **"Add"**. 4. Embed the iOS agent xcframework: - Select your project in the Project Navigator to open the project and target settings. - Click on the target to which you want to add the XCFramework. - Go to the **"General"** tab. - Scroll down to the **"Frameworks, Libraries, and Embedded Content"** section. - - Make sure the XCFramework is listed here. If it's not, click the **"+"** button and add it. - - For the XCFramework you just added, change the **"Embed"** option to **"Embed & Sign"**. + - Make sure the NewRelic.xcframework is listed here. If it's not, click the **"+"** button and add it. -By following these steps, you should have successfully added the iOS agent to your Xcode project. \ No newline at end of file From ac55f4c7d7f2988677a173d4db850dec0a7a25df Mon Sep 17 00:00:00 2001 From: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com> Date: Fri, 12 Jul 2024 11:09:20 -0700 Subject: [PATCH 03/11] Copyedits --- .../installation/manual-installation.mdx | 41 ++++++++++++------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx index 65637c8b1f2..6a7bc5d9179 100644 --- a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx +++ b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx @@ -1,6 +1,6 @@ --- -title: xcframework manual installation -metaDescription: How to instrument to your iOS applications by downloading the xcframework. +title: XCFramework manual installation +metaDescription: How to instrument to your iOS applications by downloading the XCFramework. freshnessValidatedDate: never --- @@ -10,18 +10,29 @@ We recommend that you use our [guided install](https://onenr.io/0qwLv87gkj5) to Follow these steps to install an XCFramework into your Xcode project: -1. Download the latest iOS agent from our [iOS agent release notes](/docs/release-notes/mobile-release-notes/ios-release-notes). -2. Navigate to where the iOS agent was downloaded and unzip it. -3. Add the iOS agent XCFramework to your project: - - Right-click on the **"Project Navigator"** area. - - Select **"Add Files to [YourProjectName]"**. - - Navigate to the location of the XCFramework on your disk. - - Select the NewRelic.xcframework directory and click **"Add"**. + + +Download the latest iOS agent from our [iOS agent release notes](/docs/release-notes/mobile-release-notes/ios-release-notes). + + +Navigate to where the iOS agent was downloaded and unzip it. + + +Add the iOS agent XCFramework to your project: + +1. Right-click on the **"roject Navigator** area. +2. Select **Add Files to [YourProjectName]`**. +3. Navigate to the location of the XCFramework on your disk. +4. Select the `NewRelic.xcframework` directory and click **Add**. + + +Embed the iOS agent XCFramework: +1. Select your project in the Project Navigator to open the project and target settings. +2. Click on the target to which you want to add the XCFramework. +3. Go to the **General** tab. +4. Scroll down to the **Frameworks, Libraries, and Embedded Content** section. +5. Make sure the `NewRelic.xcframework` is listed here. If it's not, click the **+** button and add it. + + -4. Embed the iOS agent xcframework: - - Select your project in the Project Navigator to open the project and target settings. - - Click on the target to which you want to add the XCFramework. - - Go to the **"General"** tab. - - Scroll down to the **"Frameworks, Libraries, and Embedded Content"** section. - - Make sure the NewRelic.xcframework is listed here. If it's not, click the **"+"** button and add it. From 2383a59c32e94e16a697b3690d8b9492e131eaa1 Mon Sep 17 00:00:00 2001 From: mbruin-NR <118208503+mbruin-NR@users.noreply.github.com> Date: Mon, 15 Jul 2024 09:25:21 -0400 Subject: [PATCH 04/11] Update manual-installation.mdx --- .../new-relic-mobile-ios/installation/manual-installation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx index 6a7bc5d9179..89bb82b32d9 100644 --- a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx +++ b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx @@ -21,7 +21,7 @@ Navigate to where the iOS agent was downloaded and unzip it. Add the iOS agent XCFramework to your project: 1. Right-click on the **"roject Navigator** area. -2. Select **Add Files to [YourProjectName]`**. +2. Select **Add Files to `[YourProjectName]`**. 3. Navigate to the location of the XCFramework on your disk. 4. Select the `NewRelic.xcframework` directory and click **Add**. From 4410df08b7bf51a6abf332fabeea1deb8931045a Mon Sep 17 00:00:00 2001 From: a-sassman Date: Tue, 16 Jul 2024 14:50:22 -0700 Subject: [PATCH 05/11] chore(mobile): rename the path, consolidate/clean up the steps --- .../installation/manual-installation.mdx | 38 ------------------- .../installation/xcframework-installation.mdx | 33 ++++++++++++++++ 2 files changed, 33 insertions(+), 38 deletions(-) delete mode 100644 src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx create mode 100644 src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx diff --git a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx deleted file mode 100644 index 89bb82b32d9..00000000000 --- a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: XCFramework manual installation -metaDescription: How to instrument to your iOS applications by downloading the XCFramework. -freshnessValidatedDate: never ---- - -We recommend that you use our [guided install](https://onenr.io/0qwLv87gkj5) to set up iOS monitoring. However, if you need to install the agent manually, follow the steps below to install the New Relic iOS agent by downloading the xcframework. - -## Manually add the iOS agent to your project - -Follow these steps to install an XCFramework into your Xcode project: - - - -Download the latest iOS agent from our [iOS agent release notes](/docs/release-notes/mobile-release-notes/ios-release-notes). - - -Navigate to where the iOS agent was downloaded and unzip it. - - -Add the iOS agent XCFramework to your project: - -1. Right-click on the **"roject Navigator** area. -2. Select **Add Files to `[YourProjectName]`**. -3. Navigate to the location of the XCFramework on your disk. -4. Select the `NewRelic.xcframework` directory and click **Add**. - - -Embed the iOS agent XCFramework: -1. Select your project in the Project Navigator to open the project and target settings. -2. Click on the target to which you want to add the XCFramework. -3. Go to the **General** tab. -4. Scroll down to the **Frameworks, Libraries, and Embedded Content** section. -5. Make sure the `NewRelic.xcframework` is listed here. If it's not, click the **+** button and add it. - - - - diff --git a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx new file mode 100644 index 00000000000..21ca49f8ef5 --- /dev/null +++ b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx @@ -0,0 +1,33 @@ +--- +title: XCFramework manual installation +metaDescription: How to instrument to your iOS applications by downloading the XCFramework. +freshnessValidatedDate: 2024-7-16 +--- + +We recommend that you use our [guided install](https://onenr.io/0qwLv87gkj5) to set up iOS monitoring. However, if you need to install the agent manually, follow the steps below to install the New Relic iOS agent by downloading the XCFramework. + +## Manually add the New Relic XCFramework to your project + + + +Download the latest iOS agent (XCFramework) from our [iOS agent release notes](/docs/release-notes/mobile-release-notes/ios-release-notes). + + +Navigate to where the iOS agent was downloaded and unzip it. + + In your Xcode project, add the unzipped agent: + +1. Right-click on your Project navigator and click **Add Files to `[YourProjectName]`**. +2. Select the `NewRelic.xcframework` directory and click **Add**. + + +Embed the iOS agent: +1. In the Project navigator, open your project and target settings. +2. Click on the target to which you want to add the agent. +3. Click the **General** tab. +4. Scroll down to the **Frameworks, Libraries, and Embedded Content** section. +5. Make sure `NewRelic.xcframework` is listed here. If it's not, click **+** button to add it. + + + + From 966dc556cde0c14932efd67eea0e3f47186792a7 Mon Sep 17 00:00:00 2001 From: ally sassman <42753584+ally-sassman@users.noreply.github.com> Date: Tue, 16 Jul 2024 14:53:36 -0700 Subject: [PATCH 06/11] fix(mobile): rephrase intro paragraph --- .../installation/xcframework-installation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx index 21ca49f8ef5..f917d87e0b7 100644 --- a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx +++ b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx @@ -4,7 +4,7 @@ metaDescription: How to instrument to your iOS applications by downloading the X freshnessValidatedDate: 2024-7-16 --- -We recommend that you use our [guided install](https://onenr.io/0qwLv87gkj5) to set up iOS monitoring. However, if you need to install the agent manually, follow the steps below to install the New Relic iOS agent by downloading the XCFramework. +We recommend that you use our [guided install](https://onenr.io/0qwLv87gkj5) to set up iOS monitoring. However, if you need to install the agent manually, follow the steps below to install the New Relic iOS agent (in an XCFramework package) and add it to your XCode project. ## Manually add the New Relic XCFramework to your project From a72860b307f8ce8dc85781f4dd78c6832e86ccfb Mon Sep 17 00:00:00 2001 From: ally sassman <42753584+ally-sassman@users.noreply.github.com> Date: Tue, 16 Jul 2024 14:54:38 -0700 Subject: [PATCH 07/11] fix(mobile): remove redundant header --- .../installation/xcframework-installation.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx index f917d87e0b7..4a8b15bfaa3 100644 --- a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx +++ b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx @@ -6,8 +6,6 @@ freshnessValidatedDate: 2024-7-16 We recommend that you use our [guided install](https://onenr.io/0qwLv87gkj5) to set up iOS monitoring. However, if you need to install the agent manually, follow the steps below to install the New Relic iOS agent (in an XCFramework package) and add it to your XCode project. -## Manually add the New Relic XCFramework to your project - Download the latest iOS agent (XCFramework) from our [iOS agent release notes](/docs/release-notes/mobile-release-notes/ios-release-notes). From 4eae5f02ec356ef3b033926aefe3056690fa47fd Mon Sep 17 00:00:00 2001 From: ally sassman <42753584+ally-sassman@users.noreply.github.com> Date: Tue, 16 Jul 2024 14:56:03 -0700 Subject: [PATCH 08/11] fix(mobile): replace agent with XCFramework --- .../installation/xcframework-installation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx index 4a8b15bfaa3..206b67f099d 100644 --- a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx +++ b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx @@ -13,7 +13,7 @@ Download the latest iOS agent (XCFramework) from our [iOS agent release notes](/ Navigate to where the iOS agent was downloaded and unzip it. - In your Xcode project, add the unzipped agent: + In your Xcode project, add the unzipped XCFramework: 1. Right-click on your Project navigator and click **Add Files to `[YourProjectName]`**. 2. Select the `NewRelic.xcframework` directory and click **Add**. From 4cfb48f37fe82354f9197c3eae3bb9546c8f55d9 Mon Sep 17 00:00:00 2001 From: mbruin-NR <118208503+mbruin-NR@users.noreply.github.com> Date: Wed, 17 Jul 2024 09:45:17 -0400 Subject: [PATCH 09/11] Update src/nav/mobile-monitoring.yml Co-authored-by: ally sassman <42753584+ally-sassman@users.noreply.github.com> --- src/nav/mobile-monitoring.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nav/mobile-monitoring.yml b/src/nav/mobile-monitoring.yml index 7d9fcac2d9e..7d2d28d9e45 100644 --- a/src/nav/mobile-monitoring.yml +++ b/src/nav/mobile-monitoring.yml @@ -57,7 +57,7 @@ pages: path: /docs/mobile-monitoring/new-relic-mobile-ios/installation/cocoapods-installation - title: Swift package manager path: /docs/mobile-monitoring/new-relic-mobile-ios/installation/spm-installation - - title: Manually copy XCFramework + - title: XCFramework manual installation path: /docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-install - title: iOS compatibility and requirements path: /docs/mobile-monitoring/new-relic-mobile-ios/get-started/new-relic-ios-compatibility-requirements From 525a4825eb69d38e9a661a0e86891d19cc1e42ae Mon Sep 17 00:00:00 2001 From: mbruin-NR <118208503+mbruin-NR@users.noreply.github.com> Date: Wed, 17 Jul 2024 09:45:25 -0400 Subject: [PATCH 10/11] Update src/nav/mobile-monitoring.yml Co-authored-by: ally sassman <42753584+ally-sassman@users.noreply.github.com> --- src/nav/mobile-monitoring.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nav/mobile-monitoring.yml b/src/nav/mobile-monitoring.yml index 7d2d28d9e45..c1f3ab1a3c7 100644 --- a/src/nav/mobile-monitoring.yml +++ b/src/nav/mobile-monitoring.yml @@ -58,7 +58,7 @@ pages: - title: Swift package manager path: /docs/mobile-monitoring/new-relic-mobile-ios/installation/spm-installation - title: XCFramework manual installation - path: /docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-install + path: /docs/mobile-monitoring/new-relic-mobile-ios/installation/manual-installation - title: iOS compatibility and requirements path: /docs/mobile-monitoring/new-relic-mobile-ios/get-started/new-relic-ios-compatibility-requirements - title: iOS distributed tracing From b9199c2f39f6490aca57c77f193a821fb22cd38e Mon Sep 17 00:00:00 2001 From: mbruin-NR <118208503+mbruin-NR@users.noreply.github.com> Date: Wed, 17 Jul 2024 10:24:03 -0400 Subject: [PATCH 11/11] Update xcframework-installation.mdx --- .../installation/xcframework-installation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx index 206b67f099d..46c2d5e151a 100644 --- a/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx +++ b/src/content/docs/mobile-monitoring/new-relic-mobile-ios/installation/xcframework-installation.mdx @@ -1,7 +1,7 @@ --- title: XCFramework manual installation metaDescription: How to instrument to your iOS applications by downloading the XCFramework. -freshnessValidatedDate: 2024-7-16 +freshnessValidatedDate: 2024-07-16 --- We recommend that you use our [guided install](https://onenr.io/0qwLv87gkj5) to set up iOS monitoring. However, if you need to install the agent manually, follow the steps below to install the New Relic iOS agent (in an XCFramework package) and add it to your XCode project.