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

RFC: rover docs go #308

Closed
EverlastingBugstopper opened this issue Feb 24, 2021 · 3 comments · Fixed by #314
Closed

RFC: rover docs go #308

EverlastingBugstopper opened this issue Feb 24, 2021 · 3 comments · Fixed by #314
Labels
feature 🎉 new commands, flags, functionality, and improved error messages

Comments

@EverlastingBugstopper
Copy link
Contributor

EverlastingBugstopper commented Feb 24, 2021

I think it would be super nice to let folks open the browser to go to important docs links right from Rover!

Proposed usage:

$ rover docs --help
rover-docs 0.0.1
Interact with Rover's documentation

USAGE:
    rover docs [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -l, --log <log-level>     [default: info]  [possible values: error, warn, info,
                             debug, trace]

SUBCOMMANDS:
    open       Opens a documentation page in your browser
$ rover docs open --help
rover-docs-open 0.0.1
Opens a documentation page in your browser

USAGE:
    rover docs open [OPTIONS] <doc>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -l, --log <log-level>            [default: info]  [possible values: error, warn, info,
                                    debug, trace]
        --profile <profile-name>    Name of configuration profile to use [default: default]

ARGS:
    <doc>    
             [default: docs]    [possible values: docs, start, api-keys, contributing]
$ rover docs open
Would you like to open https://go.apollo.dev/r/docs in your browser? [y/N]
@EverlastingBugstopper EverlastingBugstopper added the feature 🎉 new commands, flags, functionality, and improved error messages label Feb 24, 2021
@EverlastingBugstopper
Copy link
Contributor Author

while i'm thinking about it, i wonder if we should be sending users to old docs if they have an old version. our docs solution allows us to tag individual versions of the docs and view them separately, i wonder if our go.apollo.dev redirects should take a version query parameter or something and link folks to the proper version instead of just latest.

@JakeDawkins
Copy link
Contributor

JakeDawkins commented Feb 24, 2021

Maybe instead of rover docs go, we could go rover docs open? I think I like that better

I was actually thinking about a command that we could add (I'll rfc separately), that'd open a graph/subgraph in studio, and I think rover graph open would sound more clear. If we had separate commands to open web browsers, I'd think their verbs should match

@EverlastingBugstopper
Copy link
Contributor Author

I've updated the top level comment to be rover docs open - i think that sounds better too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature 🎉 new commands, flags, functionality, and improved error messages
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants