Release docs #389
Merged
Release docs #389
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
EverlastingBugstopper
approved these changes
Mar 29, 2021
docs/source/supergraphs.md
Outdated
| [data core]: https://apollo-specs.github.io/#def-data-core | ||
| [referencing specifications]: https://apollo-specs.github.io/core/draft/pre-0#core__Using | ||
|
|
||
| Currently, supergraph schemas are in preview, and can't be directly consumed by anything. In the future, a supergraph schema document will be consumable by [apollo gateway](https://www.apollographql.com/docs/federation/gateway/), providing all the information needed to execute operations against a supergraph. |
There was a problem hiding this comment.
Suggested change
| Currently, supergraph schemas are in preview, and can't be directly consumed by anything. In the future, a supergraph schema document will be consumable by [apollo gateway](https://www.apollographql.com/docs/federation/gateway/), providing all the information needed to execute operations against a supergraph. | |
| Currently, supergraph schemas are in preview, and can't be directly consumed by anything. In the future, a supergraph schema document will be consumable by [Apollo gateway](https://www.apollographql.com/docs/federation/gateway/), providing all the information needed to execute operations against a supergraph. |
docs/source/supergraphs.md
Outdated
| Rover's `supergraph compose` command provides all the tools you need to compose a supergraph's schema locally. | ||
|
|
||
| ```bash | ||
| rover supergraph compose --config ./subgraphs.yaml |
There was a problem hiding this comment.
Suggested change
| rover supergraph compose --config ./subgraphs.yaml | |
| rover supergraph compose --config ./supergraph.yaml |
docs/source/supergraphs.md
Outdated
|
|
||
| The config format that `supergraph compose` expects is a slim YAML file, containing a list of subgraphs, their public facing urls to route requests to, and where Rover can find their schemas. | ||
|
|
||
| Currently, **only federated SDL files are accepted for schema sources**. If you don't have a schema file for a subgraph, you can pipe the output of [`subgraph introspect`](./subgraphs#fetching-via-enhanced-introspection) to a file (see [using stdout](./essentials#using-stdout) for more). |
There was a problem hiding this comment.
You could also reasonably pipe rover subgraph fetch to a file if a subgraph already exists in the registry
docs/source/supergraphs.md
Outdated
| films: | ||
| routing_url: https://films.example.com | ||
| schema: | ||
| file: ./good-films.graphql |
There was a problem hiding this comment.
Suggested change
| file: ./good-films.graphql | |
| file: ./films.graphql |
docs/source/supergraphs.md
Outdated
| people: | ||
| routing_url: https://people.example.com | ||
| schema: | ||
| file: ./good-people.graphql |
There was a problem hiding this comment.
Suggested change
| file: ./good-people.graphql | |
| file: ./people.graphql |
JakeDawkins
commented
Mar 30, 2021
| @@ -8,21 +8,28 @@ module.exports = { | |||
| options: { | |||
| ...themeOptions, | |||
| root: __dirname, | |||
| subtitle: 'Rover CLI', | |||
| subtitle: 'Rover CLI (Preview)', | |||
There was a problem hiding this comment.
Should we drop the CLI in the name or do you think that adds clarity @StephenBarlow?
There was a problem hiding this comment.
I think we should keep "CLI" for the time being, until Rover has better name recognition via full release. Will be especially helpful in the docset switcher
| the result of a command, whether that be SDL output, checks errors, or | ||
| composition errors. | ||
| ```mermaid | ||
| graph BT; |
docs/source/supergraphs.md
Outdated
| gateway --- serviceA & serviceB & serviceC; | ||
| ``` | ||
|
|
||
| Rover commands that interact with subgraphs begin with `rover supergraph`. These commands primarily deal with composition of a **supergraph schema** that adheres to the [supergraph schema specification](https://apollo-specs.github.io/core/draft/pre-0). |
There was a problem hiding this comment.
Suggested change
| Rover commands that interact with subgraphs begin with `rover supergraph`. These commands primarily deal with composition of a **supergraph schema** that adheres to the [supergraph schema specification](https://apollo-specs.github.io/core/draft/pre-0). | |
| Rover commands that interact with supergraphs begin with `rover supergraph`. These commands primarily deal with composition of a **supergraph schema** that adheres to the [supergraph schema specification](https://apollo-specs.github.io/core/draft/pre-0). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Todo:
graph introspectsubgraph introspectsupergraph compose