Skip to content
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

Recategorize Rover docs slightly #414

Merged
merged 2 commits into from
Apr 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions docs/gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,20 @@ module.exports = {
sidebarCategories: {
null: [
'index',
],
'Setup': [
'getting-started',
'configuring',
'ci-cd',
'essentials',
'privacy',
'contributing',
],
'Usage': [
'essentials',
'Base Commands': [
'graphs',
],
'Federation Commands': [
'subgraphs',
'supergraphs',
'graphs',
],
'Community': [
'contributing',
]
},
},
},
Expand Down
4 changes: 2 additions & 2 deletions docs/source/ci-cd.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
8 changes: 4 additions & 4 deletions docs/source/graphs.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/subgraphs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Working with subgraphs'
sidebar_title: 'Subgraphs (federated)'
sidebar_title: 'subgraph'
description: 'in a federated architecture'
---

Expand Down Expand Up @@ -189,7 +189,7 @@ If you're running a subgraph that hasn't been deployed yet or isn't using manage
</tbody>
</table>

## Checking subgraph changes
## Checking subgraph schema changes

> Schema checks require a [paid plan](https://www.apollographql.com/pricing).

Expand Down
2 changes: 1 addition & 1 deletion docs/source/supergraphs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Working with supergraphs'
sidebar_title: 'Supergraphs (federated)'
sidebar_title: 'supergraph'
description: 'in a federated architecture'
---

Expand Down