[docs-scanner] Wasm documentation scope conflicts with deprecation status

オープン 初心者向け
#26,614 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
docker, markdown

調査の方向性

content/manuals/desktop/features/wasm.md を読み、非推奨の通知がセットアップ、例、チュートリアル、トラブルシューティングの各セクションとどのように整合しているかを確認してください。プロジェクトの現在の情報に基づいて、使用手順を減らす、または移行ガイダンスを追加するなど、ページの明確な方向性を決めてください。ページが Wasm の状況と読者が取るべき対応について、一貫した案内を提供できれば完了です。

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

説明

File: content/manuals/desktop/features/wasm.md

Issue

The page opens with a clear deprecation notice:

Wasm workloads are deprecated and will be removed in a future Docker Desktop release. This feature is no longer actively maintained.

However, the rest of the page provides extensive, detailed instructions for enabling and using Wasm workloads, including:

  • Complete setup instructions ("Turn on Wasm workloads")
  • Multiple usage examples with docker run and Docker Compose
  • A multi-service application tutorial with step-by-step instructions
  • Building and pushing Wasm modules
  • Detailed troubleshooting section
Why this matters

A reader encountering this page faces conflicting signals:

  1. The deprecation notice suggests they should not invest time in this feature
  2. The comprehensive documentation (setup, examples, tutorials, troubleshooting) suggests this is a fully-supported feature worth learning

This creates confusion about whether users should:

  • Ignore the feature entirely (suggested by deprecation)
  • Learn and use it (suggested by the extensive documentation)
  • Migrate away from it (not addressed)
Suggested fix

Given the deprecation status, consider one of these approaches:

Option 1: Minimal documentation

  • Keep only the deprecation notice and basic description
  • Remove detailed setup, usage examples, and troubleshooting
  • Add a brief note about what users should use instead (if applicable)

Option 2: Migration-focused documentation

  • Keep the deprecation notice prominent
  • Add a section explaining migration path or alternatives
  • Reduce the emphasis on setup/usage and increase emphasis on "if you're currently using this, here's what to do"

Option 3: Clarify the timeline

  • If the feature will remain available for a significant period, clarify this in the deprecation notice
  • Example: "Wasm workloads are deprecated and will be removed in Docker Desktop 5.0 (estimated Q2 2025). This feature is no longer actively maintained but remains available for existing users."

The current approach of "deprecated but here's how to use it extensively" sends mixed messages to readers.


Found by nightly documentation quality scanner

主要言語
Markdown
スター
4.7k
フォーク
8.5k
平均マージ
2日 10時間
マージ済み PR(30日)
139

環境構築

はじめの一歩

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

docker/docs のほかの issue

docker/docs の issue をすべて見る

似ている issue

Content の issue をもっと見る

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

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