Bug - outdated code examples for v5 docs

Offen
#4,960 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
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
javascript, react
Bereich
documentation

Rechercherichtung

Beginne mit der im Issue verlinkten Typeahead-Seite der archivierten v5-Select-Komponente und vergleiche ihr Beispiel mit den Breaking Changes in patternfly-react PR 11249. Aktualisiere das veraltete Beispiel, sodass es mit der neuesten Version funktioniert, überprüfe anschließend das gerenderte Dokumentationsbeispiel und prüfe, ob andere v5-Beispiele dasselbe Problem haben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Describe the problem
Code examples on the v5 documentation page are outdated despite the fact the the page claims to show the state for 5.4.2
It seems all docs are outdated but for me the problem was with Select component. Breaking changes added in https://github.com/patternfly/patternfly-react/pull/11249 are missing . Without those changes the example is no longer working properly (starting from 5.4.11).

Expected behavior
The example code should work properly on the newest version.

Screenshots

image


Jira Issue: PF-3691

Vorherrschende Sprache
JavaScript
Sterne
74
Forks
149
Ø Merge
1 T. 9 Std.
Gemergte PRs (30 T.)
13

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 patternfly/patternfly-org

Alle Issues in patternfly/patternfly-org

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

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