cloudfoundry / cloudfoundry/cli

Documentation of https://cli.cloudfoundry.org/en-US/v8/ is outdated

Open
#3,416 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
1.9k
Forks
990
Avg merge
1d 7h
Merged PRs (30d)
8

Description

I think it should be useful to update https://cli.cloudfoundry.org/en-US/v8/ web site. Currently the latest update is 2021-09-16.
For example, there is a missing parameter for https://cli.cloudfoundry.org/en-US/v8/run-task.html (the -l parameter for log rate limit for tasks).

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 https://cli.cloudfoundry.org/en-US/v8/ site and compare its content with the current Cloud Foundry CLI commands, beginning with https://cli.cloudfoundry.org/en-US/v8/run-task.html. Update the outdated documentation, including the missing -l log rate limit parameter for tasks, and verify that the site reflects the latest command options.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.