Suggestions for the migration docs #2718
Conversation
👷 Deploy request for apollo-ios-docs pending review.Visit the deploys page to approve it
|
| #### Separating cache mutations from network operations |
There was a problem hiding this comment.
The reason this entire this is using ">" is because it's a shared note that we are including in multiple places, but it's intended to be a callout. It's a section that gives some usage suggestions and design notes, but it's not directly related to the function of the articles in which it is included.
By not using the ">" it renders as it's own sub heading in the articles, rather than a callout box. And I don't think that looks right.
@rkoron007 @calvincestari @bignimbus Opinions on this? Here is a link to where it is rendered so you can see what it looks like.
There was a problem hiding this comment.
I think these notes are important enough to be rendered differently. So if there isn't another way to have them distinct from the text above I think using > is what we'll have to use.
There was a problem hiding this comment.
@trevorblades one more for your input please.
| > This is an important decision that must be made prior to configuring code generation. To determine the right option for your project, check our our [project configuration documentation](/project-configuration). | ||
| - `${MySchemaName}` provides a name for the namespace of your generated schema files. | ||
| - `${ModuleType}` configures how your generated schema types are included in your project. | ||
| > This is a crucial decision to make **before configuring code generation**. To determine the right option for your project, see [Project Configuration](../project-configuration). |
There was a problem hiding this comment.
Is this relative path going to work correctly from all places? This is a shared mdx component, and it's used from pages at different paths. Not sure if the link gets resolved relative to the path of the shared component, or the path of the page it is included in? @trevorblades would probably know.
If relative won't work here, the correct solution I think is [Project Configuration](ios/project-configuration).
But that isn't future proof once this isn't the latest docs version anymore haha.
There was a problem hiding this comment.
I believe it is relative to the page that includes it. @trevorblades can you confirm that for us please?
There was a problem hiding this comment.
Thanks for the editing @rkoron007, this looks great! I've added my comments where appropriate.
| #### Separating cache mutations from network operations |
There was a problem hiding this comment.
I think these notes are important enough to be rendered differently. So if there isn't another way to have them distinct from the text above I think using > is what we'll have to use.
Co-authored-by: Anthony Miller <anthonymdev@gmail.com>
|
Ignore the CI failure in Codegen CLI Integration Tests, this PR hasn't been rebased to include #2715. |
docs/source/migrations/1.0.mdx
Outdated
| To begin your migration to Apollo iOS 1.0 you'll need to: | ||
| To migrate to Apollo iOS 1.0, you'll do the following: | ||
| 1. [Update your Apollo iOS dependency](#1-update-to-apollo-ios-10) | ||
| 2. [Setup code generation](#2-setup-code-generation) |
There was a problem hiding this comment.
changing the title means this link needs to change to `#2-set-up-code-generation
No description provided.