From 45a1fed367840ac75fe1bd04f36367712fdc0f3f Mon Sep 17 00:00:00 2001 From: Stephen Barlow Date: Wed, 31 Mar 2021 13:37:29 -0700 Subject: [PATCH 1/2] Incorporate feedback from @ndintenfass --- docs/gatsby-config.js | 8 +++++--- docs/source/graphs.md | 8 ++++---- docs/source/subgraphs.md | 2 +- docs/source/supergraphs.md | 2 +- 4 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/gatsby-config.js b/docs/gatsby-config.js index 40a3c6dbb..0b6ad2c83 100644 --- a/docs/gatsby-config.js +++ b/docs/gatsby-config.js @@ -14,6 +14,7 @@ module.exports = { sidebarCategories: { null: [ 'index', + 'essentials', ], 'Setup': [ 'getting-started', @@ -21,11 +22,12 @@ module.exports = { 'ci-cd', 'privacy', ], - 'Usage': [ - 'essentials', + 'Base Commands': [ + 'graphs', + ], + 'Federation Commands': [ 'subgraphs', 'supergraphs', - 'graphs', ], 'Community': [ 'contributing', diff --git a/docs/source/graphs.md b/docs/source/graphs.md index 8a1a4339c..d5f084a0f 100644 --- a/docs/source/graphs.md +++ b/docs/source/graphs.md @@ -1,10 +1,10 @@ --- -title: 'Working with non-federated graphs' -sidebar_title: 'Non-federated graphs' -description: '(Graphs represented by a monolithic GraphQL server)' +title: 'Working with graphs' +sidebar_title: 'graph' +description: 'Publish and retrieve your API schema' --- -> This article applies only to non-federated graphs. When working with a federated graph, see [Working with subgraphs](./subgraphs). +> These commands are for graphs that do _not_ use [federation](https://www.apollographql.com/docs/federation/). When working with a federated graph, instead use the [`subgraph` comamand](./subgraphs). ## Fetching a schema diff --git a/docs/source/subgraphs.md b/docs/source/subgraphs.md index 847731ace..3e03c0fb4 100644 --- a/docs/source/subgraphs.md +++ b/docs/source/subgraphs.md @@ -1,6 +1,6 @@ --- title: 'Working with subgraphs' -sidebar_title: 'Subgraphs (federated)' +sidebar_title: 'subgraph' description: 'in a federated architecture' --- diff --git a/docs/source/supergraphs.md b/docs/source/supergraphs.md index 80beaa16d..64afb1d10 100644 --- a/docs/source/supergraphs.md +++ b/docs/source/supergraphs.md @@ -1,6 +1,6 @@ --- title: 'Working with supergraphs' -sidebar_title: 'Supergraphs (federated)' +sidebar_title: 'supergraph' description: 'in a federated architecture' --- From 7c55fad4e10889e59838280427dff96fdbfec821 Mon Sep 17 00:00:00 2001 From: Stephen Barlow Date: Wed, 31 Mar 2021 17:08:57 -0700 Subject: [PATCH 2/2] Incorporate additional feedback --- docs/gatsby-config.js | 8 ++------ docs/source/ci-cd.md | 4 ++-- docs/source/index.mdx | 2 +- docs/source/subgraphs.md | 2 +- 4 files changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/gatsby-config.js b/docs/gatsby-config.js index 0b6ad2c83..2e2ff5933 100644 --- a/docs/gatsby-config.js +++ b/docs/gatsby-config.js @@ -14,13 +14,12 @@ module.exports = { sidebarCategories: { null: [ 'index', - 'essentials', - ], - 'Setup': [ 'getting-started', 'configuring', 'ci-cd', + 'essentials', 'privacy', + 'contributing', ], 'Base Commands': [ 'graphs', @@ -29,9 +28,6 @@ module.exports = { 'subgraphs', 'supergraphs', ], - 'Community': [ - 'contributing', - ] }, }, }, diff --git a/docs/source/ci-cd.md b/docs/source/ci-cd.md index fad43532a..ea3a2877f 100644 --- a/docs/source/ci-cd.md +++ b/docs/source/ci-cd.md @@ -1,9 +1,9 @@ --- -title: "Setting up CI/CD workflows with Rover" +title: "Using Rover in CI/CD" sidebar_title: "CI/CD" --- -You can use the Rover CLI in any CI/CD environment that uses any supported operating system (Linux, MacOS, or Windows). +You can use Rover in any CI/CD environment that uses a Rover-supported operating system (Linux, MacOS, or Windows). Most commonly, this is to run [schema checks](https://www.apollographql.com/docs/studio/schema-checks/) with [`rover graph check`](./graphs/#checking-schema-changes) or [`rover subgraph check`](./subgraphs/#checking-subgraph-schema-changes). Rover can be installed like many other CLI tools, but the installation method varies depending on which provider you're using. We've included instructions for two of the most common CI/CD providers, [CircleCI](https://circleci.com/) and [GitHub Actions](https://github.com/features/actions). diff --git a/docs/source/index.mdx b/docs/source/index.mdx index 9a2649f8e..cc9e6101e 100644 --- a/docs/source/index.mdx +++ b/docs/source/index.mdx @@ -12,7 +12,7 @@ import { colors } from 'gatsby-theme-apollo-core'; > > For details, see [Public preview](#public-preview). -**Rover** is a CLI for managing and maintaining data graphs with [Apollo Studio](https://www.apollographql.com/docs/studio/). It helps you safely publish and fetch GraphQL schemas (both [federated](./subgraphs/) and [non-federated](./graphs/)) from the Apollo schema registry. +**Rover** is a CLI for managing and maintaining data graphs with [Apollo Studio](https://www.apollographql.com/docs/studio/). It helps you safely publish and fetch GraphQL schemas (both [monolithic](./graphs/) and [federated](./subgraphs/)) from the Apollo schema registry. Upon full release, Rover will replace the existing [Apollo CLI](https://www.apollographql.com/docs/devtools/cli/) as the primary command-line tool for communicating with Studio. diff --git a/docs/source/subgraphs.md b/docs/source/subgraphs.md index 3e03c0fb4..9b810632b 100644 --- a/docs/source/subgraphs.md +++ b/docs/source/subgraphs.md @@ -189,7 +189,7 @@ If you're running a subgraph that hasn't been deployed yet or isn't using manage -## Checking subgraph changes +## Checking subgraph schema changes > Schema checks require a [paid plan](https://www.apollographql.com/pricing).