apache / apache/parquet-java

Broken links and formatting problems in Parquet documentation

Offen
#2,104 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Component: Parquet Priority: Trivial Type: bug
Vorherrschende Sprache
Java
Sterne
3.1k
Forks
1.6k
Ø Merge
3 T. 12 Std.
Gemergte PRs (30 T.)
33

Beschreibung

The links to LogicalTypes.md and Encodings.md in [the Parquet documentation](http://parquet.apache.org/documentation/latest/) are broken. That page also has what appear to be some Markdown formatting issues:
- multiple lists are rendering incorrectly: the list of types under the "Types" header, the list of data under the "Data Pages" header, and the list of extension points under the "Extensibility" header
- some underscores that should be escaped are instead rendering as italics - see the last line under the "Nested Encoding" header

**Reporter**: [Roland Crosby](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=rolandcrosby)

**Note**: *This issue was originally created as [PARQUET-1161](https://issues.apache.org/jira/browse/PARQUET-1161). Please see the [migration documentation](https://issues.apache.org/jira/browse/PARQUET-2502) for further details.*

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne mit der im Issue verlinkten Parquet-Dokumentationsseite und prüfe die Verweise auf LogicalTypes.md und Encodings.md. Überprüfe die Abschnitte Types, Data Pages, Extensibility und Nested Encoding auf die gemeldeten Probleme bei der Markdown-Darstellung. Als erledigt gilt die Aufgabe, wenn die Links funktionieren und die Listen sowie Unterstriche korrekt dargestellt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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