apache / apache/parquet-java

Broken links and formatting problems in Parquet documentation

未关闭
#2,104 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
Component: Parquet Priority: Trivial Type: bug
主要语言
Java
星标
3.1k
派生
1.6k
平均合并
3 天 12 小时
30 天内合并 PR
33

描述

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

贡献指南

这个仓库没有索引到贡献指南

调研方向

从 issue 中链接的 Parquet 文档页面开始,检查对 LogicalTypes.md 和 Encodings.md 的引用。检查 Types、Data Pages、Extensibility 和 Nested Encoding 部分,查找报告的 Markdown 渲染问题。链接能够正常工作,并且列表和下划线能够正确渲染,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
markdown
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。