[
https://issues.apache.org/jira/browse/FLINK-13517?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16902363#comment-16902363
]
Bowen Li commented on FLINK-13517:
----------------------------------
[~sjwiesman] thanks for your proposal. One problem is users now have to jump
three pages (catalog.md, overview.md, hive_compatibility.md) to setup and use
HiveCatalog, not very user friendly.
I like the idea of having a Hive multi-page section by offering rooms for
further break down Hive related doc as we add more Hive features in the future.
However, I hope we can keep complete instructions of HiveCatalog in one page. I
propose two options here:
1) move examples in catalog.md to its own page (e,g, catalog_examples.md) to
reduce size of catalog.md. I prefer this one
or 2)
{code:java}
Hive (This is now a section with multiple pages)
- overview.md (What is hive and why do we like it)
- metadata.md (or 'setup and metadata'. Because once the metadata part
fully works, the data part just works as a result without extra config or
dependencies. So setup is mainly about setup metadata part)
- cross link to catalogs
- lib/dep, versions, etc
- This has datatype mapping and other compatiblity related docs
- hive_compatibility.md
- ddl, dml, udf, source/sink, etc
- hive_example.md
{code}
The difference between the two options would be whether the metadata.md is on
its own under Hive section, or being part of catalog.md.
What do you think?
> Restructure Hive Catalog documentation
> --------------------------------------
>
> Key: FLINK-13517
> URL: https://issues.apache.org/jira/browse/FLINK-13517
> Project: Flink
> Issue Type: Improvement
> Components: Connectors / Hive, Documentation
> Reporter: Seth Wiesman
> Assignee: Seth Wiesman
> Priority: Major
> Labels: pull-request-available
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Hive documentation is currently spread across a number of pages and
> fragmented. In particular:
> 1) An example was added to getting-started/examples, however, this section is
> being removed
> 2) There is a dedicated page on hive integration but also a lot of hive
> specific information is on the catalog page
> We should
> 1) Inline the example into the hive integration page
> 2) Move the hive specific information on catalogs.md to hive_integration.md
> 3) Make catalogs.md be just about catalogs in general and link to the hive
> integration.
--
This message was sent by Atlassian JIRA
(v7.6.14#76016)
