_config.yml 3.2 KB
Newer Older
1 2 3 4 5 6 7
# 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
8
#
9
# http://www.apache.org/licenses/LICENSE-2.0
10
#
11 12 13 14 15 16 17
# 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.

18 19 20 21 22 23 24
#------------------------------------------------------------------------------
# VARIABLES
#------------------------------------------------------------------------------
# Variables specified in this file can be used in the documentation via:
#     {{ site.CONFIG_KEY }}
#------------------------------------------------------------------------------

U
Ufuk Celebi 已提交
25 26 27 28
# This are the version referenced in the docs. Please only use these variables
# to reference a specific Flink version, because this is the only place where
# we change the version for the complete docs when forking of a release branch
# etc.
29 30
version: "1.4-SNAPSHOT"
version_short: "1.4" # Used for the top navbar w/o snapshot suffix
31
is_snapshot_version: true
32

33 34 35
# This suffix is appended to the Scala-dependent Maven artifact names
scala_version_suffix: "_2.10"

U
Ufuk Celebi 已提交
36 37 38 39 40
# Some commonly linked pages (this was more important to have as a variable
# during incubator; by now it should also be fine to hardcode these.)
website_url: "http://flink.apache.org"
jira_url: "https://issues.apache.org/jira/browse/FLINK"
github_url: "https://github.com/apache/flink"
41
download_url: "http://flink.apache.org/downloads.html"
42

43 44 45 46 47 48
# Flag whether this is the latest stable version or not. If not, a warning
# will be printed pointing to the docs of the latest stable version.
is_latest: true
is_stable: false

previous_docs:
49
  1.3: http://ci.apache.org/projects/flink/flink-docs-release-1.3
50
  1.2: http://ci.apache.org/projects/flink/flink-docs-release-1.2
51 52 53
  1.1: http://ci.apache.org/projects/flink/flink-docs-release-1.1
  1.0: http://ci.apache.org/projects/flink/flink-docs-release-1.0

54 55 56 57 58 59 60
#------------------------------------------------------------------------------
# BUILD CONFIG
#------------------------------------------------------------------------------
# These variables configure the jekyll build (./build_docs.sh). You don't need
# to change anything here.
#------------------------------------------------------------------------------

61 62 63
# Used in some documents to initialize arrays. Don't delete.
array: []

64 65 66 67 68
defaults:
  -
    scope:
      path: ""
    values:
U
Ufuk Celebi 已提交
69
      layout: plain
70
      nav-pos: 99999 # Move to end if no pos specified
71

72
markdown: KramdownPygments
73
highlighter: pygments
74 75

kramdown:
76 77 78
  input: GFM # GitHub syntax
  hard_wrap: false # Don't translate new lines to <br>s
  toc_levels: 1..3 # Include h1-h3 for ToC
79

80
host: 0.0.0.0
81

82
# please use a protocol relative URL here
83
baseurl: //ci.apache.org/projects/flink/flink-docs-release-1.3