| commit | 6356efb0cfbe139f3d2199181c4d8e9bc48d2cda | [log] [tgz] |
|---|---|---|
| author | AndrewElvis <andrewelvis98@gmail.com> | Fri Jun 30 14:07:04 2023 +0800 |
| committer | Danny Cranmer <dannycranmer@apache.org> | Mon Apr 15 14:31:36 2024 +0100 |
| tree | a33ec0442dc000c2a10dc5150daf48fc987b0761 | |
| parent | 7f3fe9aedfd6c84408c7473ad9fb88a3cfa8ee16 [diff] |
Update flink-operations.md 修正错字
This repository contains the Flink project website: https://flink.apache.org/.
You can find instructions for contributing to this repository here: https://flink.apache.org/how-to-contribute/improve-website/
The Flink documentation uses Hugo to generate HTML files. More specifically, it uses the extended version of Hugo with Sass/SCSS support.
To build the documentation, you can install Hugo locally or use a Docker image.
The built site is served at http://localhost:1313/.
$ ./docker-build.sh
Make sure you have installed Hugo on your system.
$ ./build.sh
The site can be viewed at http://localhost:1313/
You must have Hugo installed on your system.
The website needs to be rebuilt before being merged into the asf-site branch.
You can execute the following command to rebuild non-incrementally:
./docker-build.sh build
./build.sh build
This will generate the static HTML files in the content folder, which are used to serve out the project website.
The documentation pages are written in Markdown. It is possible to use GitHub flavored syntax and intermix plain html.
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. The default layout is plain (found in _layouts).
--- title: "Title of the Page" --- --- title: "Title of the Page" <-- Title rendered in the side nave weight: 1 <-- Weight controls the ordering of pages in the side nav. aliases: <-- Alias to setup redirect from removed page to this one - /alias/to/removed/page.html ---
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 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 ---
Flink uses shortcodes to add custom functionality to its documentation markdown.