8bd5ac0b99
### What changes were proposed in this pull request? Add navigation for `REST API` document. ### Why are the changes needed? `REST API` document does not have any navigation, which is better to add navigation to guide REST API. <img width="1438" alt="image" src="https://github.com/user-attachments/assets/b5b3a14a-38d4-4769-bffb-3acd571d5dbb"> ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? No. Closes #2775 from SteNicholas/navigate-rest-api. Authored-by: SteNicholas <programgeek@163.com> Signed-off-by: mingji <fengmingxiao.fmx@alibaba-inc.com>
102 lines
3.3 KiB
YAML
102 lines
3.3 KiB
YAML
#
|
|
# 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.
|
|
#
|
|
|
|
site_name: Apache Celeborn™
|
|
repo_name: apache/celeborn
|
|
repo_url: https://gitbox.apache.org/repos/asf/celeborn.git
|
|
|
|
plugins:
|
|
- search
|
|
- macros
|
|
- include-markdown:
|
|
opening_tag: "{!"
|
|
closing_tag: "!}"
|
|
|
|
theme:
|
|
font: false
|
|
name: material
|
|
language: en
|
|
logo: assets/logo/celeborn-1.svg
|
|
favicon: assets/logo/celeborn-2.svg
|
|
features:
|
|
- navigation.indexes
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.top
|
|
- navigation.tracking
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- md_in_html
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
|
|
copyright: >
|
|
<br>
|
|
Copyright © 2022-2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
|
|
<a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy<a/><br>
|
|
<br>
|
|
Apache Celeborn™, Apache, and the Apache feather logo are trademarks or registered trademarks of The Apache Software Foundation.<br>
|
|
<br>
|
|
Please visit <a href="https://www.apache.org/">Apache Software Foundation</a> for more details.<br>
|
|
<br>
|
|
|
|
nav:
|
|
- QuickStart: README.md
|
|
- Deployment:
|
|
- Overview: deploy.md
|
|
- Kubernetes: deploy_on_k8s.md
|
|
- Monitoring:
|
|
- Overview: monitoring.md
|
|
- Rest API: restapi.md
|
|
- Security: security.md
|
|
- Quota Management: quota_management.md
|
|
- Upgrading: upgrading.md
|
|
- Decommissioning: decommissioning.md
|
|
- Ratis Shell: celeborn_ratis_shell.md
|
|
- Cluster Planning: cluster_planning.md
|
|
- Configuration: configuration/index.md
|
|
- Migration Guide: migration.md
|
|
- Developers Doc:
|
|
- Overview: developers/overview.md
|
|
- Master:
|
|
- Overview: developers/master.md
|
|
- Slots Allocation: developers/slotsallocation.md
|
|
- Worker:
|
|
- Overview: developers/worker.md
|
|
- Storage: developers/storage.md
|
|
- Traffic Control: developers/trafficcontrol.md
|
|
- JVM Profiler: developers/jvmprofiler.md
|
|
- Client:
|
|
- Overview: developers/client.md
|
|
- LifecycleManager: developers/lifecyclemanager.md
|
|
- ShuffleClient: developers/shuffleclient.md
|
|
- Configuration: developers/configuration.md
|
|
- Fault Tolerant: developers/faulttolerant.md
|
|
- Worker Exclusion: developers/workerexclusion.md
|
|
- Integrating Celeborn: developers/integrate.md
|
|
- SBT Build: developers/sbt.md
|
|
- Gluten Support: developers/glutensupport.md
|
|
- Helm Charts: developers/helm-charts.md
|