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

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#26,614 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
72/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
docker, markdown
Bereich
content, documentation

Rechercherichtung

Lies content/manuals/desktop/features/wasm.md und prüfe, wie der Deprecation-Hinweis zu den Abschnitten zu Einrichtung, Beispielen, Tutorial und Fehlerbehebung passt. Lege anhand der aktuellen Informationen des Projekts eine klare Richtung für die Seite fest, zum Beispiel, indem du Nutzungshinweise reduzierst oder Migrationshinweise ergänzt. Erledigt ist die Aufgabe, wenn die Seite den Lesern konsistente Hinweise zum Status von Wasm und zum weiteren Vorgehen gibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
Markdown
Sterne
4.7k
Forks
8.5k
Ø Merge
2 T. 10 Std.
Gemergte PRs (30 T.)
139

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus docker/docs

Alle Issues in docker/docs

Ähnliche Issues

Weitere Issues zu Content

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.