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

Integrate docs with fly cli #4975

Open
kcmannem opened this issue Jan 7, 2020 · 2 comments
Open

Integrate docs with fly cli #4975

kcmannem opened this issue Jan 7, 2020 · 2 comments

Comments

@kcmannem
Copy link
Member

kcmannem commented Jan 7, 2020

Many times when I write pipelines, its quite easy to forget the different keys that take to construct steps in a plan or sometimes you just need an example. The obvious step is to open up the docs site and search for what you're looking for. This is a very slow process.

If we baked in something like a man subcommand for the various steps we can provide a faster experience to look up.

eg.
fly man get
fly man on_abort

or we could try a docs command that will launch the docs page with your search params evaluated.

eg.
fly docs image_resource would open up a new browser tab with a search performed for "image_resource" on concourse-ci.org

@stale
Copy link

stale bot commented Mar 7, 2020

Beep boop! This issue has been idle for long enough that it's time to check in and see if it's still important.

If it is, what is blocking it? Would anyone be interested in submitting a PR or continuing the discussion to help move things forward?

If no activity is observed within the next week, this issue will be exterminated closed, in accordance with our stale issue process.

@stale stale bot added the wontfix label Mar 7, 2020
@kcmannem
Copy link
Member Author

kcmannem commented Mar 8, 2020

no I still want this

@stale stale bot removed the wontfix label Mar 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant