Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

map-route options documentation is wrong

オープン
#3,606 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
go
領域
cli, documentation

調査の方向性

issue でリンクされている map-route ドキュメントページと supporting-http2 ドキュメントページから始め、両者のフラグ名をここに示した cf map-route のヘルプ出力と比較します。ドキュメントのオプションを CLI に合わせて更新し、両方のページが同じコマンドと同じ HTTP/2 の動作を説明していることを確認します。

索引モデルが issue の本文から書いたものです。

説明

  • I reviewed open and closed github issues that may be related to my problem.
  • I tried updating to the latest version of the CF CLI to see if it fixed my problem.
  • I attempted to run the command with CF_TRACE=1 to help debug the issue.
  • I am reporting a bug that others will be able to reproduce.

Describe the bug and the command you saw an issue with
I wanted to set a route using cf map-routewith HTTP/2 enabled like it is described in the documentation.

What happened
An error occurred Incorrect Usage: unknown flag destination-protocol'. The help command for map-route` gave me those instructions:

NAME:
   map-route - Map a route to an app

USAGE:
   Map an HTTP route:
      cf map-route APP_NAME DOMAIN [--hostname HOSTNAME] [--path PATH] [--app-protocol PROTOCOL] [--option OPTION=VALUE]
   
   Map a TCP route:
      cf map-route APP_NAME DOMAIN [--port PORT] [--option OPTION=VALUE]

EXAMPLES:
   cf map-route my-app example.com                                                      # example.com
   cf map-route my-app example.com --hostname myhost                                    # myhost.example.com
   cf map-route my-app example.com --hostname myhost -o loadbalancing=least-connection  # myhost.example.com with a per-route option
   cf map-route my-app example.com --hostname myhost --path foo                         # myhost.example.com/foo
   cf map-route my-app example.com --hostname myhost --app-protocol http2               # myhost.example.com
   cf map-route my-app example.com --port 5000                                          # example.com:5000

OPTIONS:
   --hostname, -n      Hostname for the HTTP route (required for shared domains)
   --path              Path for the HTTP route
   --port              Port for the TCP route (default: random port)
   --app-protocol      [Beta flag, subject to change] Protocol for the route destination (default: http1). Only applied to HTTP routes
   --option, -o        Set the value of a per-route option

SEE ALSO:
   create-route, routes, unmap-route, update-route

I then tried using app-protocol instead which fixed the problem so no current blocker.

Expected behavior
I expect the cli help and the documentation to be aligned and that the description in the documentation is correct. Please correct the documentation.

Exact Steps To Reproduce
Steps to reproduce the behavior; include the exact CLI commands and verbose output:

  1. Run cf map-route <YOUR_APP> <YOUR_DOMAIN> --destination-protocol http2
  2. See error

Provide more context

Notes regarding V6 and V7 CLI support:

  • V6:
    • Minimum supported version of CF Deployment: v7.0.0 (CAPI Release: 1.74.0 (APIs 2.128.0 and 3.63.0))
    • Maximum supported version of CF Deployment: v13.4.0 (CAPI Release: 1.94.0 (APIs 2.149.0 and 3.84.0))
  • V7:
    • Minimum supported version of CF Deployment: v13.5.0 (CAPI Release: 1.95.0 (APIs 2.150.0 and 3.85.0))
主要言語
Go
スター
1.9k
フォーク
990
平均マージ
1日 7時間
マージ済み PR(30日)
8

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

cloudfoundry/cli のほかの issue

cloudfoundry/cli の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。