-
Notifications
You must be signed in to change notification settings - Fork 269
[do not merge] PR for docs CICD test #3271
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
✅ Docs preview readyThe preview is ready to be viewed. View the preview File Changes 0 new, 14 changed, 0 removed
Build ID: d898f6174b898714d9562e1e URL: https://www.apollographql.com/docs/deploy-preview/d898f6174b898714d9562e1e |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pull request has 2 style issues. Please review the changes and make the necessary adjustments.
--- | ||
|
||
In Apollo Federation, _composition_ is the process of combining a set of subgraph schemas into a supergraph schema: | ||
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sentence is grammatically incorrect and unclear. It should state what schema composition is.
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema: | |
Schema composition is the process of combining a set of subgraph schemas into a supergraph schema. |
</CodeColumns> | ||
|
||
One subgraph defines `Event.timestamp` as a `String`, and the other defines it as an `Int`. Composition doesn't know which type to use, so it fails. | ||
One subgraph defines `Event.timestamp` as a `String`, and the other defines it as an `Int`. Composition doesn't know which type to use, so it fails. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HTML code tags (<code>
) should be replaced with Markdown's backticks (`) for inline code snippets to ensure consistent formatting across the documentation site.
One subgraph defines `Event.timestamp` as a `String`, and the other defines it as an `Int`. Composition doesn't know which type to use, so it fails. | |
One subgraph defines `Event.timestamp` as a `String`, and the other defines it as an `Int`. Composition doesn't know which type to use, so it fails. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AI Style Review Summary
The documentation has undergone extensive formatting and consistency improvements. Numerous leading spaces were removed from various elements including code blocks, headings, HTML tags, and notes to ensure proper rendering and alignment. Indentation within Mermaid diagrams and YAML code blocks was adjusted to maintain consistency, primarily to a 2-space standard. Grammatical clarity was enhanced by rephrasing an incomplete sentence and replacing 'But' with 'However' for a more formal tone. For inline code snippets, <code>
tags were replaced with backticks to align with standard Markdown practices and style guide preferences, improving overall code block rendering and readability. Additionally, 'of the' was removed from a phrase for conciseness.
The pull request has 67 style issues. Please review the changes and make the necessary adjustments.
If you encounter any issues with this AI review, please reach out to Developer Experience Marketing for assistance.
--- | ||
|
||
In Apollo Federation, _composition_ is the process of combining a set of subgraph schemas into a supergraph schema: | ||
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sentence is grammatically incomplete and unclear. It should state what 'is the process' refers to. Rephrased to clarify and improve readability.
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema: | |
Schema composition is the process of combining a set of subgraph schemas into a supergraph schema in Apollo Federation: |
composition -- "(Composition succeeds)" --> supergraph; | ||
class composition tertiary; | ||
``` | ||
```mermaid |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure proper code block rendering and consistency.
```mermaid | |
```mermaid |
class composition tertiary; | ||
``` | ||
```mermaid | ||
graph TB; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure proper code block rendering and consistency.
graph TB; | |
graph TB; |
``` | ||
```mermaid | ||
graph TB; | ||
serviceA[Subgraph<br/>schema<br/>A]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
serviceA[Subgraph<br/>schema<br/>A]; | |
serviceA[Subgraph<br/>schema<br/>A]; |
```mermaid | ||
graph TB; | ||
serviceA[Subgraph<br/>schema<br/>A]; | ||
serviceB[Subgraph<br/>schema<br/>B]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
serviceB[Subgraph<br/>schema<br/>B]; | |
serviceB[Subgraph<br/>schema<br/>B]; |
<Note> | ||
|
||
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). | ||
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces for consistency within the note.
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). | |
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). |
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). | ||
|
||
</Note> | ||
</Note> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure proper rendering of the HTML tag and consistency.
</Note> | |
</Note> |
</Note> | ||
|
||
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. | ||
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replaced 'But' with 'However' to maintain a more formal and professional tone in technical documentation.
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. | |
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. However, that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. |
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. | ||
|
||
## Next steps | ||
## Next steps |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure proper heading rendering and consistency.
## Next steps | |
## Next steps |
## Next steps | ||
|
||
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart) | ||
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces for consistency.
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart) | |
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AI Style Review Summary
This pull request includes numerous formatting corrections, primarily by removing leading spaces to ensure correct rendering of code blocks, headings, content, admonitions, HTML tags, and shortcodes. Grammatical and stylistic improvements were also made, such as rephrasing a sentence for clarity, replacing 'of the' for conciseness, using backticks for inline code for consistency with Markdown, replacing 'take a look at' with 'consider' for conciseness, capitalizing 'Federation' for product reference, and replacing 'But that' with 'This' for better flow.
The pull request has 67 style issues. Please review the changes and make the necessary adjustments.
If you encounter any issues with this AI review, please reach out to Developer Experience Marketing for assistance.
--- | ||
|
||
In Apollo Federation, _composition_ is the process of combining a set of subgraph schemas into a supergraph schema: | ||
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sentence is grammatically incorrect and missing a subject. Rephrased for clarity and proper sentence structure.
In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema: | |
Schema composition is the process of combining a set of subgraph schemas into a supergraph schema in Apollo Federation. |
composition -- "(Composition succeeds)" --> supergraph; | ||
class composition tertiary; | ||
``` | ||
```mermaid |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure the code block is correctly rendered.
```mermaid | |
```mermaid |
class composition tertiary; | ||
``` | ||
```mermaid | ||
graph TB; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure the code block is correctly rendered.
graph TB; | |
graph TB; |
``` | ||
```mermaid | ||
graph TB; | ||
serviceA[Subgraph<br/>schema<br/>A]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure the code block is correctly rendered.
serviceA[Subgraph<br/>schema<br/>A]; | |
serviceA[Subgraph<br/>schema<br/>A]; |
```mermaid | ||
graph TB; | ||
serviceA[Subgraph<br/>schema<br/>A]; | ||
serviceB[Subgraph<br/>schema<br/>B]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure the code block is correctly rendered.
serviceB[Subgraph<br/>schema<br/>B]; | |
serviceB[Subgraph<br/>schema<br/>B]; |
<Note> | ||
|
||
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). | ||
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure the content is correctly rendered.
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). | |
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). |
For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). | ||
|
||
</Note> | ||
</Note> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure the admonition is correctly rendered.
</Note> | |
</Note> |
</Note> | ||
|
||
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. | ||
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Capitalize "Federation" as it refers to the product. Replace "But that" with "This" for better flow and conciseness, avoiding the slightly informal tone.
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. | |
Breaking composition is a helpful feature of Federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. This conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. |
Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. | ||
|
||
## Next steps | ||
## Next steps |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure the heading is correctly rendered.
## Next steps | |
## Next steps |
## Next steps | ||
|
||
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart) | ||
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove leading spaces to ensure the content is correctly rendered.
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart) | |
Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart) |
No description provided.