concourse / concourse/docs

Fly CLI docs are incomplete

Open
#520 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
HTML
Stars
57
Forks
165
Avg merge
1m
Merged PRs (30d)
2

Description

Describe the bug

I was reading the concourse book and found it referencing a command called fly execute. I wanted to learn more about this, so I navigated to the The Fly CLI section of the docs, which didn't list it.

I downloaded fly and ran it, and found there is a MUCH LONGER list of commands here than are listed in the docs. Is there a different place I should be looking for these commands, or are the docs just missing a lot of info?

Reproduction steps

Open the The Fly CLI section of the docs.

Expected behavior

I expect all the CLI commands to be listed on the "The Fly CLI" page within the docs.

Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “The Fly CLI” page linked in the issue and compare its command list with the commands shown by the downloaded fly executable, including fly execute. Update the documentation so the CLI commands are represented on that page, then verify that the documented list matches the tool.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.