You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2022/03/20 06:33:36 UTC

[GitHub] [flink-table-store] JingsongLi opened a new pull request #53: [FLINK-26744] Init document for table store and introduce quickstart

JingsongLi opened a new pull request #53:
URL: https://github.com/apache/flink-table-store/pull/53


   - Just like other sub project of Apache Flink, table store should build docs like Flink ML and Flink Stateful Functions.
   - Introduce index page and quickstart page.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink-table-store] LadyForest commented on a change in pull request #53: [FLINK-26744] Init document for table store and introduce quickstart

Posted by GitBox <gi...@apache.org>.
LadyForest commented on a change in pull request #53:
URL: https://github.com/apache/flink-table-store/pull/53#discussion_r834485025



##########
File path: docs/README.md
##########
@@ -0,0 +1,93 @@
+This README gives an overview of how to build and contribute to the
+documentation of Flink Table Store.
+
+The documentation is included with the source of Flink Table Store in order to ensure
+that you always have docs corresponding to your checked-out version.
+
+# Requirements
+
+### Build the site locally
+
+Make sure you have installed
+[Hugo](https://gohugo.io/getting-started/installing/) on your system.
+
+From this directory:
+
+  * Fetch the theme submodule
+	```sh
+	git submodule update --init --recursive
+	```
+  * Start local server
+	```sh
+	hugo -b "" serve
+	```
+
+The site can be viewed at http://localhost:1313/
+
+# Contribute
+
+## Markdown
+
+The documentation pages are written in
+[Markdown](http://daringfireball.net/projects/markdown/syntax). It is possible
+to use [GitHub flavored
+syntax](http://github.github.com/github-flavored-markdown) and intermix plain
+html.
+
+## Front matter
+
+In addition to Markdown, every page contains a Jekyll front matter, which
+specifies the title of the page and the layout to use. The title is used as the
+top-level heading for the page.
+
+    ---
+    title: "Title of the Page"
+    ---
+
+    ---
+    title: "Title of the Page" <-- Title rendered in the side nav
+    weight: 1 <-- Weight controls the ordering of pages in the side nav
+    type: docs <-- required
+    aliases:  <-- Alias to setup redirect from removed page to this one
+      - /alias/to/removed/page.html
+    ---
+
+## Structure
+
+### Page
+
+#### Headings
+
+All documents are structured with headings. From these headings, you can
+automatically generate a page table of contents (see below).
+
+```
+# Level-1 Heading  <- Used for the title of the page 
+## Level-2 Heading <- Start with this one for content
+### Level-3 heading
+#### Level-4 heading
+##### Level-5 heading
+```
+
+Please stick to the "logical order" when using the headlines, e.g. start with
+level-2 headings and use level-3 headings for subsections, etc. Don't use a
+different ordering, because you don't like how a headline looks.
+
+#### Table of Contents
+
+Table of contents are added automatically to every page, based on heading levels
+2 - 4. The ToC can be omitted by adding the following to the front matter of
+the page:
+
+    ---
+    bookToc: false
+    ---
+
+### ShortCodes 
+
+Flink uses [shortcodes](https://gohugo.io/content-management/shortcodes/) to add

Review comment:
       Haha, do you forget to replace this? `Flink Table Store uses...`




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink-table-store] JingsongLi merged pull request #53: [FLINK-26744] Init document for table store and introduce quickstart

Posted by GitBox <gi...@apache.org>.
JingsongLi merged pull request #53:
URL: https://github.com/apache/flink-table-store/pull/53


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink-table-store] JingsongLi commented on a change in pull request #53: [FLINK-26744] Init document for table store and introduce quickstart

Posted by GitBox <gi...@apache.org>.
JingsongLi commented on a change in pull request #53:
URL: https://github.com/apache/flink-table-store/pull/53#discussion_r834908686



##########
File path: docs/content/_index.md
##########
@@ -0,0 +1,57 @@
+---
+title: Apache Flink Table Store
+type: docs
+bookToc: false
+---
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Apache Flink Table Store
+
+Flink Table Store is a unified streaming and batch store for building dynamic
+tables on Apache Flink. It is designed to be the best connector to Flink as
+the storage for streaming warehouse. It uses a full Log-Structured Merge-Tree
+(LSM) structure for high speed and large amount of data update & query capability.
+
+The Table Store supports the following usage:
+- **Streaming Insert**: Write changelog streams, including cdc from database and streams from Flink Sink.

Review comment:
       Let's remove `from Flink Sink`




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink-table-store] LadyForest commented on a change in pull request #53: [FLINK-26744] Init document for table store and introduce quickstart

Posted by GitBox <gi...@apache.org>.
LadyForest commented on a change in pull request #53:
URL: https://github.com/apache/flink-table-store/pull/53#discussion_r834489664



##########
File path: docs/content/_index.md
##########
@@ -0,0 +1,57 @@
+---
+title: Apache Flink Table Store
+type: docs
+bookToc: false
+---
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Apache Flink Table Store
+
+Flink Table Store is a unified streaming and batch store for building dynamic
+tables on Apache Flink. It is designed to be the best connector to Flink as
+the storage for streaming warehouse. It uses a full Log-Structured Merge-Tree
+(LSM) structure for high speed and large amount of data update & query capability.
+
+The Table Store supports the following usage:

Review comment:
       Nit: `Flink Table Store supports...` is fine




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org