apache / apache/parquet-java

Broken links and formatting problems in Parquet documentation

Open
#2,104 0 comments 0 reactions 0 assignees View on GitHub
Component: Parquet Priority: Trivial Type: bug
Dominant language
Java
Stars
3.1k
Forks
1.6k
Avg merge
3d 12h
Merged PRs (30d)
33

Description

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.*

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Parquet documentation page linked in the issue and inspect the references to LogicalTypes.md and Encodings.md. Review the Types, Data Pages, Extensibility, and Nested Encoding sections for the reported Markdown rendering problems. Done means the links work and the lists and underscores render correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.