[
https://issues.apache.org/jira/browse/FLINK-13517?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16901353#comment-16901353
]
Seth Wiesman edited comment on FLINK-13517 at 8/6/19 6:36 PM:
--------------------------------------------------------------
[~phoenixjiangnan]
I definitely understand the concern. From my point of view I fear catalog.md
will become bloated if we add others in the future, such as one based on a
kafka schema registry for streaming tables. So how about this:
Catalog
* Introduce users to catalogs as a concept
* Cover catalog functionality
* List the provided catalogs and a high level description of what they do /
why you might use them
** Generic InMemory
** Hive
*** Explain that you can use Hive as metadata storage without understanding
operability and link to setup instructions
*** The hive description will include a link to the hive page and clearly
explain that you should read the hive docs to understand data mappings and so on
** Custom
* The examples at the bottom will not be hive specific, but just use an
imaginary `CustomCatalog`
Hive
* This is now a section with multiple pages
* overview.md
** What is hive and why do we like it
** setup (cross link to catalogs)
* hive_compatibility.md
** This has datatype mapping and other compatiblity related docs
* hive_example.md
** Move the hive specific example here
was (Author: sjwiesman):
[~phoenixjiangnan]
I definitely understand the concern. From my point of view I fear catalog.md
will become bloated if we add others in the future, such as one based on a
kafka schema registry for streaming tables. So how about this:
Catalog
* Introduce users to catalogs as a concept
* Cover catalog functionality
* List the provided catalogs and a high level description of what they do
** Generic InMemory
** Hive
*** Explain that you can use Hive as metadata storage without understanding
operability and link to setup instructions
*** The hive description will include a link to the hive page and clearly
explain that you should read the hive docs to understand data mappings and so on
** Custom
* The examples at the bottom will not be hive specific, but just use an
imaginary `CustomCatalog`
Hive
* This is now a section with multiple pages
* overview.md
** What is hive and why do we like it
** setup (cross link to catalogs)
* hive_compatibility.md
** This has datatype mapping and other compatiblity related docs
* hive_example.md
** Move the hive specific example here
> 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)
