diff --git a/docs/gatsby-config.js b/docs/gatsby-config.js index 1f8e79b72..e17ef35ea 100644 --- a/docs/gatsby-config.js +++ b/docs/gatsby-config.js @@ -8,8 +8,8 @@ module.exports = { options: { ...themeOptions, root: __dirname, - subtitle: 'Rover', - description: 'A guide to using rover', + subtitle: 'Rover CLI', + description: 'A guide to using Rover', githubRepo: 'apollographql/rover', sidebarCategories: { null: [ diff --git a/docs/source/index.mdx b/docs/source/index.mdx index 8b59a561a..4c7a44a27 100644 --- a/docs/source/index.mdx +++ b/docs/source/index.mdx @@ -8,19 +8,13 @@ import { Button } from '@apollo/space-kit/Button'; import { Link } from 'gatsby'; import { colors } from 'gatsby-theme-apollo-core'; -## Public Preview - > **Rover is in active, rapid development.** It should not be used in production projects. Rover commands are subject to breaking changes without notice. +> +> For details, see [Public preview](#public-preview). -Rover's public preview period is currently active! During this time, the Rover team will periodically release new beta versions of Rover for the public to test out, and give feedback on! During this period, the team plans to release new versions of Rover approximately every 2 weeks, with potential for small patches for critical bugs in-between. - -The documentation for Rover will include some commands that are still a work in progress, and thus can't be used. These commands will be noted as unreleased. If something is not noted as unreleased or a work in progress, you can assume **it should work**. If you experience issues using a command, _please_ [open an issue](https://github.com/apollographql/rover/issues/new) and let us know! - -During this period, we will not be accepting any public contributions to code, but **we welcome feedback or questions** in issues! - -## About Rover +**Rover** is a CLI for managing and maintaining data graphs with [Apollo Studio](https://www.apollographql.com/docs/studio/). It helps you safely push and pull GraphQL schemas (both federated and non-federated) from the Apollo schema registry. -Rover is a CLI for managing and maintaining data graphs with [Apollo Studio](https://www.apollographql.com/docs/studio/). 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. +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. Rover does _not_ currently provide client-specific features, such as code generation or client checks. For these features, continue using the [Apollo CLI](https://www.apollographql.com/docs/devtools/cli/). @@ -34,7 +28,15 @@ Rover does _not_ currently provide client-specific features, such as code genera

-## Feedback +## Public preview + +Rover's public preview period is currently active! Throughout this period, the Rover team will release new beta versions of Rover for the public to test out and provide feedback on. We plan to release a new version approximately every 2 weeks, with the possibility of critical bug patches in between. + +The documentation for Rover includes some commands that are still in development, and therefore can't be used yet. These commands are noted as unreleased. Unless a command is noted as unreleased in progress, you can assume **it should work**. If you experience issues using a command, _please_ [open an issue](https://github.com/apollographql/rover/issues/new) and let us know! + +During this period, we will not be accepting any public contributions to code, but [**we welcome feedback or questions**](#feedback)! + +### Feedback We'd love to hear your feedback on Rover if you try it out! To provide feedback, please [open an issue](https://github.com/apollographql/rover/issues).