From 051b0d6a7b13d3958d7126b0f2b662b4bdc182a9 Mon Sep 17 00:00:00 2001 From: Zijian Zhu Date: Fri, 7 Jul 2023 14:07:39 -0700 Subject: [PATCH] add Table of contents nav bar on right side of page --- docs/_includes/toc.html | 182 ++++++++++++++++++ docs/_layouts/global.html | 7 +- docs/en/Overview.md | 2 - docs/en/administration/Basic-Logging.md | 2 - docs/en/administration/Troubleshooting.md | 2 - docs/en/api/Java-API.md | 3 - docs/en/api/REST-API.md | 2 - docs/en/api/S3-API.md | 2 - docs/en/compute/Flink.md | 2 - docs/en/compute/Hadoop-MapReduce.md | 2 - docs/en/compute/Hive.md | 2 - docs/en/compute/Presto-Iceberg.md | 2 - docs/en/compute/Presto.md | 2 - docs/en/compute/Spark.md | 2 - docs/en/compute/Trino.md | 3 +- .../Building-Alluxio-From-Source.md | 2 - docs/en/contributor/Code-Conventions.md | 2 - .../Contributor-Getting-Started.md | 2 - docs/en/contributor/Contributor-Tools.md | 2 - .../contributor/Documentation-Conventions.md | 2 - docs/en/core-services/Caching.md | 2 - docs/en/core-services/Metadata-Caching.md | 2 - docs/en/deploy/Requirements.md | 2 - .../deploy/Running-Alluxio-On-a-HA-Cluster.md | 2 - docs/en/fuse-sdk/Advanced-Tuning.md | 2 - docs/en/fuse-sdk/FUSE-SDK-Dora-Quick-Start.md | 2 - docs/en/fuse-sdk/Local-Cache-Quick-Start.md | 2 - docs/en/fuse-sdk/Local-Cache.md | 3 - docs/en/fuse-sdk/Local-Data-Cache.md | 2 - docs/en/fuse-sdk/Local-Metadata-Cache.md | 2 - docs/en/fuse-sdk/Overview-Fuse-Sdk.md | 2 - docs/en/kubernetes/Metrics-On-Kubernetes.md | 2 - .../Running-Alluxio-On-Kubernetes.md | 2 - docs/en/operation/Configuration.md | 2 - docs/en/operation/Journal.md | 2 - docs/en/operation/Metrics-System.md | 2 - docs/en/operation/User-CLI.md | 2 - docs/en/overview/Getting-Started.md | 2 - docs/en/overview/Why-Dora.md | 2 - docs/en/presto-sdk/presto-sdk.md | 2 - docs/en/reference/Metrics-List.md | 2 - docs/en/reference/Properties-List.md | 2 - docs/en/ufs/Azure-Blob-Store.md | 2 - docs/en/ufs/Azure-Data-Lake-Gen2.md | 2 - docs/en/ufs/Azure-Data-Lake.md | 2 - docs/en/ufs/COS.md | 2 - docs/en/ufs/COSN.md | 2 - docs/en/ufs/CephFS.md | 2 - docs/en/ufs/CephObjectStorage.md | 2 - docs/en/ufs/GCS.md | 2 - docs/en/ufs/HDFS.md | 2 - docs/en/ufs/Minio.md | 2 - docs/en/ufs/NFS.md | 2 - docs/en/ufs/OBS.md | 2 - docs/en/ufs/OSS.md | 2 - docs/en/ufs/Qiniu-KODO.md | 2 - docs/en/ufs/S3.md | 2 - docs/en/ufs/Swift.md | 2 - 58 files changed, 189 insertions(+), 115 deletions(-) create mode 100644 docs/_includes/toc.html diff --git a/docs/_includes/toc.html b/docs/_includes/toc.html new file mode 100644 index 000000000000..3cff42f116f8 --- /dev/null +++ b/docs/_includes/toc.html @@ -0,0 +1,182 @@ +{% capture tocWorkspace %} + {% comment %} + Copyright (c) 2017 Vladimir "allejo" Jimenez + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + OTHER DEALINGS IN THE SOFTWARE. + {% endcomment %} + {% comment %} + Version 1.2.0 + https://github.com/allejo/jekyll-toc + + "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe + + Usage: + {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %} + + Parameters: + * html (string) - the HTML of compiled markdown generated by kramdown in Jekyll + + Optional Parameters: + * sanitize (bool) : false - when set to true, the headers will be stripped of any HTML in the TOC + * class (string) : '' - a CSS class assigned to the TOC + * id (string) : '' - an ID to assigned to the TOC + * h_min (int) : 1 - the minimum TOC header level to use; any header lower than this value will be ignored + * h_max (int) : 6 - the maximum TOC header level to use; any header greater than this value will be ignored + * ordered (bool) : false - when set to true, an ordered list will be outputted instead of an unordered list + * item_class (string) : '' - add custom class(es) for each list item; has support for '%level%' placeholder, which is the current heading level + * submenu_class (string) : '' - add custom class(es) for each child group of headings; has support for '%level%' placeholder which is the current "submenu" heading level + * base_url (string) : '' - add a base url to the TOC links for when your TOC is on another page than the actual content + * anchor_class (string) : '' - add custom class(es) for each anchor element + * skip_no_ids (bool) : false - skip headers that do not have an `id` attribute + + Output: + An ordered or unordered list representing the table of contents of a markdown block. This snippet will only + generate the table of contents and will NOT output the markdown given to it + {% endcomment %} + + {% capture newline %} + {% endcapture %} + {% assign newline = newline | rstrip %} + + {% capture deprecation_warnings %}{% endcapture %} + + {% if include.baseurl %} + {% capture deprecation_warnings %}{{ deprecation_warnings }}{{ newline }}{% endcapture %} + {% endif %} + + {% if include.skipNoIDs %} + {% capture deprecation_warnings %}{{ deprecation_warnings }}{{ newline }}{% endcapture %} + {% endif %} + + {% capture jekyll_toc %}{% endcapture %} + {% assign orderedList = include.ordered | default: false %} + {% assign baseURL = include.base_url | default: include.baseurl | default: '' %} + {% assign skipNoIDs = include.skip_no_ids | default: include.skipNoIDs | default: false %} + {% assign minHeader = include.h_min | default: 1 %} + {% assign maxHeader = include.h_max | default: 6 %} + {% assign nodes = include.html | strip | split: ' maxHeader %} + {% continue %} + {% endif %} + + {% assign _workspace = node | split: '' | first }}>{% endcapture %} + {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %} + + {% if include.item_class and include.item_class != blank %} + {% capture listItemClass %} class="{{ include.item_class | replace: '%level%', currLevel | split: '.' | join: ' ' }}"{% endcapture %} + {% endif %} + + {% if include.submenu_class and include.submenu_class != blank %} + {% assign subMenuLevel = currLevel | minus: 1 %} + {% capture subMenuClass %} class="{{ include.submenu_class | replace: '%level%', subMenuLevel | split: '.' | join: ' ' }}"{% endcapture %} + {% endif %} + + {% capture anchorBody %}{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}{% endcapture %} + + {% if htmlID %} + {% capture anchorAttributes %} href="{% if baseURL %}{{ baseURL }}{% endif %}#{{ htmlID }}"{% endcapture %} + + {% if include.anchor_class %} + {% capture anchorAttributes %}{{ anchorAttributes }} class="{{ include.anchor_class | split: '.' | join: ' ' }}"{% endcapture %} + {% endif %} + + {% capture listItem %}{{ anchorBody }}{% endcapture %} + {% elsif skipNoIDs == true %} + {% continue %} + {% else %} + {% capture listItem %}{{ anchorBody }}{% endcapture %} + {% endif %} + + {% if currLevel > lastLevel %} + {% capture jekyll_toc %}{{ jekyll_toc }}<{{ listModifier }}{{ subMenuClass }}>{% endcapture %} + {% elsif currLevel < lastLevel %} + {% assign repeatCount = lastLevel | minus: currLevel %} + + {% for i in (1..repeatCount) %} + {% capture jekyll_toc %}{{ jekyll_toc }}{% endcapture %} + {% endfor %} + + {% capture jekyll_toc %}{{ jekyll_toc }}{% endcapture %} + {% else %} + {% capture jekyll_toc %}{{ jekyll_toc }}{% endcapture %} + {% endif %} + + {% capture jekyll_toc %}{{ jekyll_toc }}{{ listItem }}{% endcapture %} + + {% assign lastLevel = currLevel %} + {% assign firstHeader = false %} + {% endfor %} + + {% assign repeatCount = minHeader | minus: 1 %} + {% assign repeatCount = lastLevel | minus: repeatCount %} + {% for i in (1..repeatCount) %} + {% capture jekyll_toc %}{{ jekyll_toc }}{% endcapture %} + {% endfor %} + + {% if jekyll_toc != '' %} + {% assign rootAttributes = '' %} + {% if include.class and include.class != blank %} + {% capture rootAttributes %} class="{{ include.class | split: '.' | join: ' ' }}"{% endcapture %} + {% endif %} + + {% if include.id and include.id != blank %} + {% capture rootAttributes %}{{ rootAttributes }} id="{{ include.id }}"{% endcapture %} + {% endif %} + + {% if rootAttributes %} + {% assign nodes = jekyll_toc | split: '>' %} + {% capture jekyll_toc %}<{{ listModifier }}{{ rootAttributes }}>{{ nodes | shift | join: '>' }}>{% endcapture %} + {% endif %} + {% endif %} +{% endcapture %}{% assign tocWorkspace = '' %}{{ deprecation_warnings }}{{ jekyll_toc -}} diff --git a/docs/_layouts/global.html b/docs/_layouts/global.html index ac5ad54b2986..626aea557891 100644 --- a/docs/_layouts/global.html +++ b/docs/_layouts/global.html @@ -73,10 +73,15 @@ -
+

{{ page.title }}

{{ content }}
+
+
+ {% include toc.html html=content %} +
+
diff --git a/docs/en/Overview.md b/docs/en/Overview.md index 30b93ccf9f6b..6ae810794aa3 100644 --- a/docs/en/Overview.md +++ b/docs/en/Overview.md @@ -5,8 +5,6 @@ group: Overview priority: 1 --- -* Table of Contents -{:toc} ## What is Alluxio diff --git a/docs/en/administration/Basic-Logging.md b/docs/en/administration/Basic-Logging.md index 18c52ee94509..550764899d48 100644 --- a/docs/en/administration/Basic-Logging.md +++ b/docs/en/administration/Basic-Logging.md @@ -6,8 +6,6 @@ group: Administration priority: 2 --- -* Table of Contents -{:toc} ## Introduction diff --git a/docs/en/administration/Troubleshooting.md b/docs/en/administration/Troubleshooting.md index 1b07c28a59c8..ed300dcd61a8 100644 --- a/docs/en/administration/Troubleshooting.md +++ b/docs/en/administration/Troubleshooting.md @@ -6,8 +6,6 @@ group: Administration priority: 1 --- -* Table of Contents -{:toc} This page is a collection of high-level guides and tips regarding how to diagnose issues encountered in Alluxio. diff --git a/docs/en/api/Java-API.md b/docs/en/api/Java-API.md index 9b7ddcb5421d..6d6df0983977 100644 --- a/docs/en/api/Java-API.md +++ b/docs/en/api/Java-API.md @@ -25,9 +25,6 @@ By setting up an Alluxio Proxy, users can also interact with Alluxio through This is mainly for admin actions not supported by S3 API. For example, mount and unmount operations. The REST API is currently used for the Go and Python language bindings. -* Table of Contents -{:toc} - ## Java Client Alluxio provides access to data through a file system interface. Files in Alluxio offer write-once diff --git a/docs/en/api/REST-API.md b/docs/en/api/REST-API.md index 0c77293f409f..049c757955d2 100644 --- a/docs/en/api/REST-API.md +++ b/docs/en/api/REST-API.md @@ -9,8 +9,6 @@ priority: 2 While users should use [S3 API]({{ '/en/api/S3-API.html' | relativize_url }}) for data I/O operations, admins can interact with Alluxio through REST API for actions not supported by S3 API. For example, mount and unmount operations. -* Table of Contents -{:toc} ## REST API diff --git a/docs/en/api/S3-API.md b/docs/en/api/S3-API.md index a8b6ba658989..8da8fce8af57 100644 --- a/docs/en/api/S3-API.md +++ b/docs/en/api/S3-API.md @@ -6,8 +6,6 @@ group: Client APIs priority: 1 --- -* Table of Contents -{:toc} Alluxio supports a [RESTful API](https://docs.alluxio.io/os/restdoc/{{site.ALLUXIO_MAJOR_VERSION}}/proxy/index.html) that is compatible with the basic operations of the Amazon [S3 API](http://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html). diff --git a/docs/en/compute/Flink.md b/docs/en/compute/Flink.md index 332dffa85c91..b4b98f898fa6 100644 --- a/docs/en/compute/Flink.md +++ b/docs/en/compute/Flink.md @@ -6,8 +6,6 @@ group: Compute Integrations priority: 2 --- -* Table of Contents -{:toc} This guide describes how to get Alluxio running with [Apache Flink](http://flink.apache.org/), so that you can easily work with files stored in Alluxio. diff --git a/docs/en/compute/Hadoop-MapReduce.md b/docs/en/compute/Hadoop-MapReduce.md index d899b986ce7a..822be4045f3e 100644 --- a/docs/en/compute/Hadoop-MapReduce.md +++ b/docs/en/compute/Hadoop-MapReduce.md @@ -9,8 +9,6 @@ priority: 1 This guide describes how to configure Alluxio with Apache Hadoop MapReduce, so that your MapReduce programs can read+write data stored in Alluxio. -* Table of Contents -{:toc} ## Prerequisites diff --git a/docs/en/compute/Hive.md b/docs/en/compute/Hive.md index 010191470ef6..877204b10a7d 100644 --- a/docs/en/compute/Hive.md +++ b/docs/en/compute/Hive.md @@ -9,8 +9,6 @@ priority: 2 This guide describes how to run [Apache Hive](http://hive.apache.org/) with Alluxio, so that you can easily store Hive tables in Alluxio's tiered storage. -* Table of Contents -{:toc} ## Prerequisites diff --git a/docs/en/compute/Presto-Iceberg.md b/docs/en/compute/Presto-Iceberg.md index 516d457ef083..c051b20df41b 100644 --- a/docs/en/compute/Presto-Iceberg.md +++ b/docs/en/compute/Presto-Iceberg.md @@ -11,8 +11,6 @@ Presto has introduced support for [Iceberg tables](https://iceberg.apache.org/) This document describes how to use Presto to query Iceberg tables through Alluxio. This document is currently experimental, and the information provided here is subject to change. -* Table of Contents -{:toc} In order to use Presto to query an Iceberg table, make sure you have a working setup of Presto, Hive Metastore and Alluxio, and Presto can access data through Alluxio's filesystem interface. diff --git a/docs/en/compute/Presto.md b/docs/en/compute/Presto.md index 44c2038c8b7e..8c99a30dbc03 100644 --- a/docs/en/compute/Presto.md +++ b/docs/en/compute/Presto.md @@ -16,8 +16,6 @@ accessed data (e.g., tables commonly used) into Alluxio distributed storage. Co-locating Alluxio workers with Presto workers improves data locality and reduces the I/O access latency when other storage systems are remote or the network is slow or congested. -* Table of Contents -{:toc} ## Prerequisites diff --git a/docs/en/compute/Spark.md b/docs/en/compute/Spark.md index 55da33541185..8c085dcef6e5 100644 --- a/docs/en/compute/Spark.md +++ b/docs/en/compute/Spark.md @@ -9,8 +9,6 @@ priority: 0 This guide describes how to configure [Apache Spark](http://spark-project.org/) to access Alluxio. -* Table of Contents -{:toc} ## Overview diff --git a/docs/en/compute/Trino.md b/docs/en/compute/Trino.md index 727929407e17..8fb52d44e32e 100644 --- a/docs/en/compute/Trino.md +++ b/docs/en/compute/Trino.md @@ -16,8 +16,7 @@ accessed data (e.g., tables commonly used) into Alluxio distributed storage. Co-locating Alluxio workers with Trino workers improves data locality and reduces the I/O access latency when other storage systems are remote or the network is slow or congested. -* Table of Contents -{:toc} + ## Prerequisites diff --git a/docs/en/contributor/Building-Alluxio-From-Source.md b/docs/en/contributor/Building-Alluxio-From-Source.md index aa58fd843ee1..a7ae79aa9227 100644 --- a/docs/en/contributor/Building-Alluxio-From-Source.md +++ b/docs/en/contributor/Building-Alluxio-From-Source.md @@ -8,8 +8,6 @@ priority: 0 This guide describes how to clone the Alluxio repository, compile the source code, and run tests in your environment. -* Table of Contents -{:toc} ## Required Software diff --git a/docs/en/contributor/Code-Conventions.md b/docs/en/contributor/Code-Conventions.md index 17d93fb32d99..580d8635ead4 100644 --- a/docs/en/contributor/Code-Conventions.md +++ b/docs/en/contributor/Code-Conventions.md @@ -6,8 +6,6 @@ group: Contributor Resources priority: 2 --- -* Table of Contents -{:toc} First off, we thank you for your interest in the Alluxio open source project! We greatly appreciate any contribution; whether it be new features or bug fixes. diff --git a/docs/en/contributor/Contributor-Getting-Started.md b/docs/en/contributor/Contributor-Getting-Started.md index ce5f85000d24..b4c4cf33019a 100644 --- a/docs/en/contributor/Contributor-Getting-Started.md +++ b/docs/en/contributor/Contributor-Getting-Started.md @@ -10,8 +10,6 @@ We warmly welcome you to the Alluxio community. We are excited for your contribu engagement with our project! This guide aims to give you step by step instructions on how to get started becoming a contributor to the Alluxio open source project. -* Table of Contents -{:toc} ## Prerequisites diff --git a/docs/en/contributor/Contributor-Tools.md b/docs/en/contributor/Contributor-Tools.md index 77b448b419ca..d87f7f4319f8 100644 --- a/docs/en/contributor/Contributor-Tools.md +++ b/docs/en/contributor/Contributor-Tools.md @@ -6,8 +6,6 @@ group: Contributor Resources priority: 3 --- -* Table of Contents -{:toc} ## IDE diff --git a/docs/en/contributor/Documentation-Conventions.md b/docs/en/contributor/Documentation-Conventions.md index d6527001ae6e..b499bf5bb33f 100644 --- a/docs/en/contributor/Documentation-Conventions.md +++ b/docs/en/contributor/Documentation-Conventions.md @@ -6,8 +6,6 @@ group: Contributor Resources priority: 2 --- -* Table of Contents -{:toc} This documentation provides a writing style guide that portrays professionalism and efficiency in delivering technical content in Alluxio documentation. diff --git a/docs/en/core-services/Caching.md b/docs/en/core-services/Caching.md index 1cf4ebadb7b9..cd1121acced6 100644 --- a/docs/en/core-services/Caching.md +++ b/docs/en/core-services/Caching.md @@ -6,8 +6,6 @@ group: Core Services priority: 1 --- -* Table of Contents -{:toc} ## Alluxio Storage Overview diff --git a/docs/en/core-services/Metadata-Caching.md b/docs/en/core-services/Metadata-Caching.md index 5834a83b93d8..f48d93061ae1 100644 --- a/docs/en/core-services/Metadata-Caching.md +++ b/docs/en/core-services/Metadata-Caching.md @@ -6,8 +6,6 @@ group: Core Services priority: 2 --- -* Table of Contents - {:toc} In Dora, Alluxio caches metadata and data on workers. This document explains how the metadata is cached and how the metadata is invalidated and refreshed. Along with the metadata invalidation, the data that is associated with the metadata is also invalidated. diff --git a/docs/en/deploy/Requirements.md b/docs/en/deploy/Requirements.md index c90386284b21..b2885bd285e2 100644 --- a/docs/en/deploy/Requirements.md +++ b/docs/en/deploy/Requirements.md @@ -6,8 +6,6 @@ group: Install Alluxio priority: 9 --- -* Table of Contents -{:toc} ## General Requirements diff --git a/docs/en/deploy/Running-Alluxio-On-a-HA-Cluster.md b/docs/en/deploy/Running-Alluxio-On-a-HA-Cluster.md index c61945835cea..85f02c83ddc3 100644 --- a/docs/en/deploy/Running-Alluxio-On-a-HA-Cluster.md +++ b/docs/en/deploy/Running-Alluxio-On-a-HA-Cluster.md @@ -6,8 +6,6 @@ group: Install Alluxio priority: 3 --- -* Table of Contents -{:toc} ## Overview diff --git a/docs/en/fuse-sdk/Advanced-Tuning.md b/docs/en/fuse-sdk/Advanced-Tuning.md index 0653ebcf9367..db116fc22b0f 100644 --- a/docs/en/fuse-sdk/Advanced-Tuning.md +++ b/docs/en/fuse-sdk/Advanced-Tuning.md @@ -5,8 +5,6 @@ group: FUSE SDK priority: 6 --- -* Table of Contents - {:toc} ### Select Libfuse Version diff --git a/docs/en/fuse-sdk/FUSE-SDK-Dora-Quick-Start.md b/docs/en/fuse-sdk/FUSE-SDK-Dora-Quick-Start.md index cae8e7229935..ec93de82a007 100644 --- a/docs/en/fuse-sdk/FUSE-SDK-Dora-Quick-Start.md +++ b/docs/en/fuse-sdk/FUSE-SDK-Dora-Quick-Start.md @@ -5,8 +5,6 @@ group: FUSE SDK priority: 3 --- -* Table of Contents - {:toc} ![POSIX LOCAL CACHE]({{ '/img/posix-distributed-cache.png' | relativize_url }}) diff --git a/docs/en/fuse-sdk/Local-Cache-Quick-Start.md b/docs/en/fuse-sdk/Local-Cache-Quick-Start.md index a915bc9aa998..78d1186c0133 100644 --- a/docs/en/fuse-sdk/Local-Cache-Quick-Start.md +++ b/docs/en/fuse-sdk/Local-Cache-Quick-Start.md @@ -5,8 +5,6 @@ group: FUSE SDK priority: 2 --- -* Table of Contents - {:toc} ## Prerequisites diff --git a/docs/en/fuse-sdk/Local-Cache.md b/docs/en/fuse-sdk/Local-Cache.md index 1a37703a7c06..5dfb39222b5c 100644 --- a/docs/en/fuse-sdk/Local-Cache.md +++ b/docs/en/fuse-sdk/Local-Cache.md @@ -5,9 +5,6 @@ group: FUSE SDK priority: 4 --- -* Table of Contents - {:toc} - ## Local Cache When an application runs an operation against the local FUSE mount point, diff --git a/docs/en/fuse-sdk/Local-Data-Cache.md b/docs/en/fuse-sdk/Local-Data-Cache.md index 3bcf3130c6db..b461a472a02b 100644 --- a/docs/en/fuse-sdk/Local-Data-Cache.md +++ b/docs/en/fuse-sdk/Local-Data-Cache.md @@ -5,8 +5,6 @@ group: FUSE SDK priority: 6 --- -* Table of Contents - {:toc} ## Local Kernel Data Cache diff --git a/docs/en/fuse-sdk/Local-Metadata-Cache.md b/docs/en/fuse-sdk/Local-Metadata-Cache.md index 6b3afc1a5d2b..6cb23241e0d2 100644 --- a/docs/en/fuse-sdk/Local-Metadata-Cache.md +++ b/docs/en/fuse-sdk/Local-Metadata-Cache.md @@ -5,8 +5,6 @@ group: FUSE SDK priority: 5 --- -* Table of Contents - {:toc} # Local Metadata Cache diff --git a/docs/en/fuse-sdk/Overview-Fuse-Sdk.md b/docs/en/fuse-sdk/Overview-Fuse-Sdk.md index 0b54d2f635c1..7dcc037eb002 100644 --- a/docs/en/fuse-sdk/Overview-Fuse-Sdk.md +++ b/docs/en/fuse-sdk/Overview-Fuse-Sdk.md @@ -9,8 +9,6 @@ The Alluxio POSIX API is a feature that allows mounting training datasets in specific storage services (e.g. S3, HDFS) to the local filesystem and provides caching capabilities to speed up I/O access to frequently used data. -* Table of Contents - {:toc} ## Local Cache vs Distributed Cache diff --git a/docs/en/kubernetes/Metrics-On-Kubernetes.md b/docs/en/kubernetes/Metrics-On-Kubernetes.md index a5c5199646b0..8be741034eef 100644 --- a/docs/en/kubernetes/Metrics-On-Kubernetes.md +++ b/docs/en/kubernetes/Metrics-On-Kubernetes.md @@ -12,8 +12,6 @@ To deploy Alluxio on Kubernetes, refer to [Deploy Alluxio on Kubernetes]({{ '/en This documentation focus on how to configure and get metrics of different metrics sinks from Alluxio deployed on Kubernetes. -* Table of Contents -{:toc} ### HTTP JSON Sink diff --git a/docs/en/kubernetes/Running-Alluxio-On-Kubernetes.md b/docs/en/kubernetes/Running-Alluxio-On-Kubernetes.md index 6d9b28482c74..2679f468390a 100644 --- a/docs/en/kubernetes/Running-Alluxio-On-Kubernetes.md +++ b/docs/en/kubernetes/Running-Alluxio-On-Kubernetes.md @@ -13,8 +13,6 @@ a kubernetes extension for managing applications. We recommend using the operator to deploy Alluxio on Kubernetes. However, if some required permissions are missing, consider using helm chart instead. -* Table of Contents -{:toc} ## Prerequisites diff --git a/docs/en/operation/Configuration.md b/docs/en/operation/Configuration.md index 049840b07f1d..ba0268bd75d7 100644 --- a/docs/en/operation/Configuration.md +++ b/docs/en/operation/Configuration.md @@ -5,8 +5,6 @@ group: Operations priority: 0 --- -* Table of Contents -{:toc} An Alluxio cluster can be configured by setting the values of Alluxio [configuration properties]({{ '/en/reference/Properties-List.html' | relativize_url }}) within diff --git a/docs/en/operation/Journal.md b/docs/en/operation/Journal.md index f4b0ec5b56bb..5d34d613a726 100644 --- a/docs/en/operation/Journal.md +++ b/docs/en/operation/Journal.md @@ -6,8 +6,6 @@ group: Operations priority: 5 --- -* Table of Contents -{:toc} Alluxio keeps the history of all metadata related changes, such as creating files or renaming directories, in edit logs referred to as "journal". diff --git a/docs/en/operation/Metrics-System.md b/docs/en/operation/Metrics-System.md index 169f4869b0ac..957a85bc4517 100644 --- a/docs/en/operation/Metrics-System.md +++ b/docs/en/operation/Metrics-System.md @@ -6,8 +6,6 @@ group: Operations priority: 7 --- -* Table of Contents -{:toc} Metrics provide insight into what is going on in the cluster. They are an invaluable resource for monitoring and debugging. diff --git a/docs/en/operation/User-CLI.md b/docs/en/operation/User-CLI.md index d3ad3f0426f0..7b94a3ea4b09 100644 --- a/docs/en/operation/User-CLI.md +++ b/docs/en/operation/User-CLI.md @@ -6,8 +6,6 @@ group: Operations priority: 1 --- -* Table of Contents -{:toc} Alluxio's command line interface provides users with basic file system operations. You can invoke the following command line utility to get all the subcommands: diff --git a/docs/en/overview/Getting-Started.md b/docs/en/overview/Getting-Started.md index 8152817b0b34..8bbf093a71e7 100644 --- a/docs/en/overview/Getting-Started.md +++ b/docs/en/overview/Getting-Started.md @@ -5,8 +5,6 @@ group: Overview priority: 1 --- -* Table of Contents - {:toc} This quick start guide goes over how to run Alluxio on a local machine. The guide will cover the following tasks: diff --git a/docs/en/overview/Why-Dora.md b/docs/en/overview/Why-Dora.md index aabb6ff7a667..e2841fca49d6 100644 --- a/docs/en/overview/Why-Dora.md +++ b/docs/en/overview/Why-Dora.md @@ -5,8 +5,6 @@ group: Overview priority: 2 --- -* Table of Contents -{:toc} ## Challenges facing Alluxio 2.x diff --git a/docs/en/presto-sdk/presto-sdk.md b/docs/en/presto-sdk/presto-sdk.md index d902e32e5244..35f9a0379770 100644 --- a/docs/en/presto-sdk/presto-sdk.md +++ b/docs/en/presto-sdk/presto-sdk.md @@ -5,8 +5,6 @@ group: Presto SDK priority: 1 --- -* Table of Contents - {:toc} Presto provides an SDK way to combined with Alluxio. With the SDK, hot data that need to be scanned frequently diff --git a/docs/en/reference/Metrics-List.md b/docs/en/reference/Metrics-List.md index 4327c6b9a938..df56dff2345c 100644 --- a/docs/en/reference/Metrics-List.md +++ b/docs/en/reference/Metrics-List.md @@ -5,8 +5,6 @@ group: Reference priority: 1 --- -* Table of Contents -{:toc} There are two types of metrics in Alluxio, cluster-wide aggregated metrics, and per-process detailed metrics. diff --git a/docs/en/reference/Properties-List.md b/docs/en/reference/Properties-List.md index 750a8245511d..32c6ebab22de 100644 --- a/docs/en/reference/Properties-List.md +++ b/docs/en/reference/Properties-List.md @@ -5,8 +5,6 @@ group: Reference priority: 0 --- -* Table of Contents -{:toc} All Alluxio configuration settings fall into one of the six categories: [Common](#common-configuration) (shared by Master and Worker), diff --git a/docs/en/ufs/Azure-Blob-Store.md b/docs/en/ufs/Azure-Blob-Store.md index 795aa8ff50e1..21d809fa3723 100644 --- a/docs/en/ufs/Azure-Blob-Store.md +++ b/docs/en/ufs/Azure-Blob-Store.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 2 --- -* Table of Contents -{:toc} This guide describes how to configure Alluxio with [Azure Blob Store](https://azure.microsoft.com/en-in/services/storage/blobs/) as the under storage system. diff --git a/docs/en/ufs/Azure-Data-Lake-Gen2.md b/docs/en/ufs/Azure-Data-Lake-Gen2.md index 7f9c5002dc4f..71e3ac38a015 100644 --- a/docs/en/ufs/Azure-Data-Lake-Gen2.md +++ b/docs/en/ufs/Azure-Data-Lake-Gen2.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 2 --- -* Table of Contents -{:toc} This guide describes how to configure Alluxio with [Azure Data Lake Storage Gen2](https://docs.microsoft.com/en-in/azure/storage/blobs/data-lake-storage-introduction) as the under storage system. diff --git a/docs/en/ufs/Azure-Data-Lake.md b/docs/en/ufs/Azure-Data-Lake.md index 65296a5a9fac..85b5e8868fd7 100644 --- a/docs/en/ufs/Azure-Data-Lake.md +++ b/docs/en/ufs/Azure-Data-Lake.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 2 --- -* Table of Contents -{:toc} This guide describes how to configure Alluxio with [Azure Data Lake Storage Gen1](https://docs.microsoft.com/en-in/azure/data-lake-store/data-lake-store-overview) as the under storage system. diff --git a/docs/en/ufs/COS.md b/docs/en/ufs/COS.md index f5847535bec2..5267339b3558 100644 --- a/docs/en/ufs/COS.md +++ b/docs/en/ufs/COS.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 0 --- -* Table of Contents - {:toc} This guide describes the instructions to configure [COS](https://cloud.tencent.com/product/cos) as Alluxio's under storage system. diff --git a/docs/en/ufs/COSN.md b/docs/en/ufs/COSN.md index 1a135f2e3247..e863eaaff408 100644 --- a/docs/en/ufs/COSN.md +++ b/docs/en/ufs/COSN.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 5 --- -* Table of Contents -{:toc} This guide describes how to configure Alluxio with Tencent [COS](https://cloud.tencent.com/product/cos) (Cloud Object Storage) as the under storage system. Tencent Cloud Object Storage (COS) is a distributed storage service offered by Tencent Cloud for unstructured data and accessible via HTTP/HTTPS protocols. diff --git a/docs/en/ufs/CephFS.md b/docs/en/ufs/CephFS.md index 9fed0cde6052..7a5827cda69b 100644 --- a/docs/en/ufs/CephFS.md +++ b/docs/en/ufs/CephFS.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 11 --- -* Table of Contents -{:toc} This guide describes how to configure Alluxio with CephFS as the under storage system. Alluxio supports two different implementations of under storage system for [CephFS](https://docs.ceph.com/en/latest/cephfs/): diff --git a/docs/en/ufs/CephObjectStorage.md b/docs/en/ufs/CephObjectStorage.md index 240e9f51f2c1..ad11ed1ef1f2 100644 --- a/docs/en/ufs/CephObjectStorage.md +++ b/docs/en/ufs/CephObjectStorage.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 10 --- -* Table of Contents -{:toc} This guide describes how to configure Alluxio with Ceph Object Storage as the under storage system. Alluxio supports two different clients APIs to connect to [Ceph Object Storage](http://ceph.com/ceph-storage/object-storage/) diff --git a/docs/en/ufs/GCS.md b/docs/en/ufs/GCS.md index 124f36486ffa..4ab8109445b3 100644 --- a/docs/en/ufs/GCS.md +++ b/docs/en/ufs/GCS.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 2 --- -* Table of Contents -{:toc} This guide describes how to configure Alluxio with [Google Cloud Storage (GCS)](https://cloud.google.com/storage/) as the under storage system. diff --git a/docs/en/ufs/HDFS.md b/docs/en/ufs/HDFS.md index 603629071b91..391a65b962f1 100644 --- a/docs/en/ufs/HDFS.md +++ b/docs/en/ufs/HDFS.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 1 --- -* Table of Contents -{:toc} This guide describes the instructions to configure [HDFS](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html) diff --git a/docs/en/ufs/Minio.md b/docs/en/ufs/Minio.md index 3d2ace4d2788..396f1979c9e3 100644 --- a/docs/en/ufs/Minio.md +++ b/docs/en/ufs/Minio.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 10 --- -* Table of Contents -{:toc} This guide describes how to configure Alluxio with [MinIO](https://min.io/) as the under storage system. diff --git a/docs/en/ufs/NFS.md b/docs/en/ufs/NFS.md index 3a11f4227990..d361c55d35da 100644 --- a/docs/en/ufs/NFS.md +++ b/docs/en/ufs/NFS.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 10 --- -* Table of Contents -{:toc} This guide describes the instructions to configure [NFS](http://nfs.sourceforge.net) as Alluxio's under storage system. diff --git a/docs/en/ufs/OBS.md b/docs/en/ufs/OBS.md index 7409fdc5ffcd..8ba07d30df74 100644 --- a/docs/en/ufs/OBS.md +++ b/docs/en/ufs/OBS.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 0 --- -* Table of Contents - {:toc} This guide describes the instructions to configure [OBS](https://www.huaweicloud.com/product/obs) as Alluxio's under storage system. diff --git a/docs/en/ufs/OSS.md b/docs/en/ufs/OSS.md index b524eef68bd9..0d3cfbab8af0 100644 --- a/docs/en/ufs/OSS.md +++ b/docs/en/ufs/OSS.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 10 --- -* Table of Contents -{:toc} This guide describes how to configure [Aliyun OSS](https://intl.aliyun.com/product/oss) as Alluxio's under storage system. Object Storage Service (OSS) is a massive, secure and highly reliable cloud storage service provided by Aliyun. diff --git a/docs/en/ufs/Qiniu-KODO.md b/docs/en/ufs/Qiniu-KODO.md index 63ce288d194f..c11d4ae46374 100644 --- a/docs/en/ufs/Qiniu-KODO.md +++ b/docs/en/ufs/Qiniu-KODO.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 4 --- -* Table of Contents -{:toc} This guide describes how to configure Alluxio with [Qiniu Kodo](https://www.qiniu.com/products/kodo) as the under storage system. Qiniu Object Storage diff --git a/docs/en/ufs/S3.md b/docs/en/ufs/S3.md index 3caa1021e402..6978e08ee243 100644 --- a/docs/en/ufs/S3.md +++ b/docs/en/ufs/S3.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 0 --- -* Table of Contents -{:toc} This guide describes the instructions to configure [Amazon S3](https://aws.amazon.com/s3/) as Alluxio's under storage system. diff --git a/docs/en/ufs/Swift.md b/docs/en/ufs/Swift.md index 286c500a1780..6a93e96137f0 100644 --- a/docs/en/ufs/Swift.md +++ b/docs/en/ufs/Swift.md @@ -6,8 +6,6 @@ group: Storage Integrations priority: 10 --- -* Table of Contents -{:toc} This guide describes how to configure Alluxio with an under storage system supporting the [Swift API](http://docs.openstack.org/developer/swift/).