From 3ac63b9779ad7c9cbbc4df60b882f1c7474c90e1 Mon Sep 17 00:00:00 2001 From: Dhiogo Brustolin Date: Thu, 10 Oct 2024 09:15:08 +0200 Subject: [PATCH 1/5] add direct install --- .../apple/common/install/direct-install.mdx | 18 ++++++++++++++++++ docs/platforms/apple/common/install/index.mdx | 9 +++++++++ 2 files changed, 27 insertions(+) create mode 100644 docs/platforms/apple/common/install/direct-install.mdx diff --git a/docs/platforms/apple/common/install/direct-install.mdx b/docs/platforms/apple/common/install/direct-install.mdx new file mode 100644 index 00000000000000..b41fab8b53195c --- /dev/null +++ b/docs/platforms/apple/common/install/direct-install.mdx @@ -0,0 +1,18 @@ +--- +title: Direct Install +description: "Integrate Sentry into your Xcode project by using our pre-compiled frameworks." +--- + +To integrate Sentry into your Xcode project, follow these steps: + +1. Download the latest version of the SDK from the Sentry Cocoa [Releases page](https://github.com/getsentry/sentry-cocoa/releases). +2. Each release contains the following four framework options: + - Sentry-Dynamic.xcframework.zip: Dynamic framework + - Sentry.xcframework.zip: Static framework + - SentrySwiftUI.xcframework.zip: Framework with SwiftUI support + - Sentry-WithoutUIKitOrAppKit.xcframework.zip: Framework without UIKit or AppKit linking and related features + +### Usage Guidelines: + + • Use `Sentry-Dynamic`, `Sentry` (Static), or `Sentry-WithoutUIKitOrAppKit` independently. Only one of these should be included in your project at a time. + • If you're using `SentrySwiftUI`, it must be combined with `Sentry-Dynamic`. \ No newline at end of file diff --git a/docs/platforms/apple/common/install/index.mdx b/docs/platforms/apple/common/install/index.mdx index 9a9d3429e9a979..e5f3e0c6dd4931 100644 --- a/docs/platforms/apple/common/install/index.mdx +++ b/docs/platforms/apple/common/install/index.mdx @@ -4,4 +4,13 @@ sidebar_order: 1 description: "All the installation methods for the Apple platform." --- +We recommend installing the SDK through our [Sentry Wizard](https://github.com/getsentry/sentry-wizard) by running the following command inside your project directory: + +```bash +brew install getsentry/tools/sentry-wizard && sentry-wizard -i ios +``` + +This will patch your project and configure the SDK. You'll only need to patch the project once, then you'll be able to add the patched files to your version control system. +If you prefer, you can choose one of the alternative methods below. + From 9ad9d69df2435e3e24c040994cca29b5ec8566f5 Mon Sep 17 00:00:00 2001 From: Dhiogo Brustolin Date: Thu, 10 Oct 2024 10:52:16 +0200 Subject: [PATCH 2/5] Apply suggestions from code review Co-authored-by: Philipp Hofmann --- docs/platforms/apple/common/install/direct-install.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/platforms/apple/common/install/direct-install.mdx b/docs/platforms/apple/common/install/direct-install.mdx index b41fab8b53195c..2a44b201775b85 100644 --- a/docs/platforms/apple/common/install/direct-install.mdx +++ b/docs/platforms/apple/common/install/direct-install.mdx @@ -1,5 +1,5 @@ --- -title: Direct Install +title: Manual Install description: "Integrate Sentry into your Xcode project by using our pre-compiled frameworks." --- @@ -10,8 +10,8 @@ To integrate Sentry into your Xcode project, follow these steps: - Sentry-Dynamic.xcframework.zip: Dynamic framework - Sentry.xcframework.zip: Static framework - SentrySwiftUI.xcframework.zip: Framework with SwiftUI support - - Sentry-WithoutUIKitOrAppKit.xcframework.zip: Framework without UIKit or AppKit linking and related features - + - Sentry-WithoutUIKitOrAppKit.xcframework.zip: Static framework without UIKit or AppKit linking and related features +3. Import chosen framework into your Xcode project target. ### Usage Guidelines: • Use `Sentry-Dynamic`, `Sentry` (Static), or `Sentry-WithoutUIKitOrAppKit` independently. Only one of these should be included in your project at a time. From 5dbcbceb5c83024772e045b4f491efeff5b29825 Mon Sep 17 00:00:00 2001 From: Dhiogo Brustolin Date: Fri, 11 Oct 2024 09:23:54 +0200 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: Philipp Hofmann --- docs/platforms/apple/common/install/direct-install.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/platforms/apple/common/install/direct-install.mdx b/docs/platforms/apple/common/install/direct-install.mdx index 2a44b201775b85..63d471f67a684f 100644 --- a/docs/platforms/apple/common/install/direct-install.mdx +++ b/docs/platforms/apple/common/install/direct-install.mdx @@ -9,10 +9,11 @@ To integrate Sentry into your Xcode project, follow these steps: 2. Each release contains the following four framework options: - Sentry-Dynamic.xcframework.zip: Dynamic framework - Sentry.xcframework.zip: Static framework - - SentrySwiftUI.xcframework.zip: Framework with SwiftUI support + - SentrySwiftUI.xcframework.zip: Static Framework with SwiftUI support - Sentry-WithoutUIKitOrAppKit.xcframework.zip: Static framework without UIKit or AppKit linking and related features 3. Import chosen framework into your Xcode project target. + ### Usage Guidelines: - • Use `Sentry-Dynamic`, `Sentry` (Static), or `Sentry-WithoutUIKitOrAppKit` independently. Only one of these should be included in your project at a time. + • Use `Sentry-Dynamic`, `Sentry`, or `Sentry-WithoutUIKitOrAppKit` independently. Only one of these should be included in your project at a time. • If you're using `SentrySwiftUI`, it must be combined with `Sentry-Dynamic`. \ No newline at end of file From 2d3cd57a8e27bd27a6f88518aefa0adc3421d2d2 Mon Sep 17 00:00:00 2001 From: Dhiogo Brustolin Date: Fri, 11 Oct 2024 09:24:09 +0200 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Philipp Hofmann --- docs/platforms/apple/common/install/direct-install.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/apple/common/install/direct-install.mdx b/docs/platforms/apple/common/install/direct-install.mdx index 63d471f67a684f..d2278cc5eac068 100644 --- a/docs/platforms/apple/common/install/direct-install.mdx +++ b/docs/platforms/apple/common/install/direct-install.mdx @@ -11,7 +11,7 @@ To integrate Sentry into your Xcode project, follow these steps: - Sentry.xcframework.zip: Static framework - SentrySwiftUI.xcframework.zip: Static Framework with SwiftUI support - Sentry-WithoutUIKitOrAppKit.xcframework.zip: Static framework without UIKit or AppKit linking and related features -3. Import chosen framework into your Xcode project target. +3. Import the chosen framework into your Xcode project target. ### Usage Guidelines: From 7ea8e2ada645fae8df267013c3ada625bd511973 Mon Sep 17 00:00:00 2001 From: Dhiogo Brustolin Date: Fri, 11 Oct 2024 09:26:32 +0200 Subject: [PATCH 5/5] rename --- .../common/install/{direct-install.mdx => manual-install.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/platforms/apple/common/install/{direct-install.mdx => manual-install.mdx} (100%) diff --git a/docs/platforms/apple/common/install/direct-install.mdx b/docs/platforms/apple/common/install/manual-install.mdx similarity index 100% rename from docs/platforms/apple/common/install/direct-install.mdx rename to docs/platforms/apple/common/install/manual-install.mdx