Skip to content

Commit

Permalink
docs: Update 'Install the Apollo Frameworks' Xcode SPM section (#2905)
Browse files Browse the repository at this point in the history
  • Loading branch information
calvincestari committed Mar 27, 2023
1 parent 5ae7c16 commit 59e0f11
Show file tree
Hide file tree
Showing 21 changed files with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/shared/spm-xcode-installation-panel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ If using Swift Package Manager within an Xcode project or workspace, use the Xco

Go to **File > Add Packages...**

<img class="screenshot" src="../source/screenshot/spm_packages_add_package.jpg" alt="Adding an SPM package" width="300" />
<img class="screenshot" src="../source/screenshot/spm_packages_add_package.png" alt="Adding an SPM package" width="560" />

</ExpansionPanelListItem>
<ExpansionPanelListItem>

In the dialog that appears, paste the URL of the Apollo iOS GitHub repo (`https://github.com/apollographql/apollo-ios.git`) into the search bar, then select the `apollo-ios` package that appears:

<img class="screenshot" src="../source/screenshot/spm_packages_dialog.jpg" alt="Pasting the Apollo iOS GitHub URL" />
<img class="screenshot" src="../source/screenshot/spm_packages_dialog.png" alt="Pasting the Apollo iOS GitHub URL" width="1035" />

</ExpansionPanelListItem>
<ExpansionPanelListItem>
Expand All @@ -28,9 +28,11 @@ Select which version you want to use ([see version history](https://github.com/a

Select which packages you want to use. If you're getting started, we recommend selecting just the main `Apollo` library for now. You can always add other packages later if you need them.

<img class="screenshot" src="../source/screenshot/spm_select_package.jpg" alt="Selecting Apollo iOS packages" />
<img class="screenshot" src="../source/screenshot/spm_select_package.png" alt="Selecting Apollo iOS packages" width="1035" />

> **Note:** Do **not** select the `Apollo-Dynamic` target. This target is only for projects that link to Apollo iOS. Most projects do not need to do this.
> **Notes:**
> 1. Do not select the `Apollo-Dynamic` product unless your project is configured to use dynamic linking of the Apollo iOS framework. Most projects do not need to link to this product.
> 2. **Do not select the `apollo-ios-cli` package.** This product is the CLI executable for code generation. If you link it to your project as a dependency it **will** cause build errors.
Then, click **Add Package**.

Expand Down
Binary file removed docs/source/screenshot/codegen_success.png
Binary file not shown.
Binary file removed docs/source/screenshot/graphiql_docs_tab.png
Binary file not shown.
Binary file removed docs/source/screenshot/graphiql_empty.png
Binary file not shown.
Binary file removed docs/source/screenshot/graphiql_query.png
Binary file not shown.
Binary file removed docs/source/screenshot/graphql_file_launchlist.png
Binary file not shown.
Binary file removed docs/source/screenshot/input_output_files.png
Binary file not shown.
Binary file removed docs/source/screenshot/new_run_script_phase.png
Binary file not shown.
Binary file removed docs/source/screenshot/schema_download_success.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/source/screenshot/spm_packages_add_package.jpg
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/screenshot/spm_packages_dialog.jpg
Binary file not shown.
Binary file added docs/source/screenshot/spm_packages_dialog.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/screenshot/spm_packages_setting.png
Binary file not shown.
Binary file removed docs/source/screenshot/spm_paste_url.png
Binary file not shown.
Binary file removed docs/source/screenshot/spm_select_package.jpg
Binary file not shown.
Binary file modified docs/source/screenshot/spm_select_package.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/screenshot/spm_select_version.png
Binary file not shown.
Binary file removed docs/source/screenshot/spm_version_change.png
Binary file not shown.
Binary file removed docs/source/screenshot/would_like_to_access.png
Binary file not shown.

0 comments on commit 59e0f11

Please sign in to comment.