Document
/
mkdocs.yml

site_name: OpenCloudOS Documentation
repo_url: https://gitee.com/opencloudos/Document
edit_uri: edit/master/docs/
copyright: Copyright &copy; 2023 OpenCloudOS

theme:
  name: material
  static_templates:
    - 404.html

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: zh
  features:
    # - announce.dismiss
    #- content.action.edit
    #- content.action.view
    #- content.code.annotate
    #- content.tabs.link
    #- content.tooltips
    # - header.autohide #自动隐藏
    # - navigation.expand # 打开Tab时左侧目录全部展开
    # - navigation.indexes #启用节索引页后，可以将文档直接附加到节
    # - navigation.instant  #自动隐藏
    # - navigation.prune
    # - navigation.sections #启用部分后，顶级部分在边栏中呈现为1220px以上视口的组，但在移动设备上保持原样
    # - navigation.tabs  #顶级部分将呈现在上面视口标题下方的菜单层中，但在移动设备上保持原样
    # - navigation.tabs.sticky  # 启用粘性选项卡后，导航选项卡将锁定在标题下方，并在向下滚动时始终保持可见
    #- navigation.top  # 返回顶部的按钮 在上滑时出现
    #- navigation.expand # 打开Tab时左侧目录全部展开
    #- content.tabs.link
    #- navigation.tracking  #地址栏中的 URL 将自动更新为在目录中突出显示的活动锚点
    #- search.highlight
    #- search.share
    #- search.suggest
    #- toc.follow
    # - toc.integrate

    # - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate

  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.png
  logo: assets/logo.svg
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

# Extensions
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html

nav:
  - 首页: index.md

  - 版本说明:
    - OpenCloudOS 版本介绍: release/oc_intro.md
    - OpenCloudOS v8.8发行说明: release/v8.8.md
    - OpenCloudOS v8.6发行说明: release/v8.6.md
    - OpenCloudOS v9.0发行说明: release/v9.0.md
    - OpenCloudOS v9.2发行说明: release/v9.2.md
    - OpenCloudOS Stream发行说明: release/ocs.md

  - 下载:
    - ISO: download/iso.md
    - 镜像源: download/mirrors.md

  - 用户指南:
    - OpenCloudOS 8 用户文档:
      - 快速入门: OC8/install/V8_install.md
      - 基础配置: OC8/guide/config.md
      - 系统管理: OC8/guide/sysadmin.md
      - 内核更新: OC8/guide/update.md
      - 系统状态监控: OC8/guide/monitor.md
      - 安全加固: OC8/guide/security.md
      - 存储管理:
        - 文件系统: OC8/storage/file_system.md
        - 逻辑卷管理: OC8/storage/configuring_and_managing_logical_volumes.md
        - 可用的存储选项: OC8/storage/managing_storage_devices.md
      - 网络管理:
        - 网络使用指南: OC8/network/Network_guide.md

    - OpenCloudOS 9/Stream 用户文档:
      - 快速入门: OC9/install/V9_install.md
      - 安装启动指南:
          - 使用Anaconda_ISO镜像安装: OCS/Install_Guide/ocs-Anaconda-ISO.md
          - 使用虚拟机镜像安装: OCS/Install_Guide/ocs-cvm.md
          - 使用容器镜像安装: OCS/Install_Guide/ocs-docker.md
          - 桌面安装: OCS/Install_Guide/ocs-desktop.md
          - 系统引导管理: OCS/Install_Guide/ocs-system-guide.md
          - UEFI引导启动项管理: OCS/Install_Guide/ocs-UEFI.md
          - initramfs制作: OCS/Install_Guide/ocs-initramfs.md
          - plymouth(系统启动动画): OCS/Install_Guide/ocs-plymouth.md
          - 安全启动: OCS/Install_Guide/ocs-secure-boot.md

      - 系统管理指南:
          - 本地化管理: OCS/AdministratorGuide/Local_Management.md
          - 用户管理: OCS/AdministratorGuide/User_Management.md
          - 软件包管理: OCS/AdministratorGuide/Software_Management.md
          - 日志管理: OCS/AdministratorGuide/Log_Management.md
          - 系统和服务管理:
            - systemd工具使用及服务管理: OCS/AdministratorGuide/System_Service_Management/Systemd_guide.md
            - dbus机制和使用: OCS/AdministratorGuide/System_Service_Management/Dbus_guide.md
            - udev机制和使用: OCS/AdministratorGuide/System_Service_Management/Udev_guide.md
          - 资源控制管理:
            - cgroup使用: OCS/AdministratorGuide/Resource_Control_Management/cgroup_guide.md

      - 网络管理指南:
          - 网络配置指南: OCS/Network_Guide/Network_config.md
          - 网络诊断指南: OCS/Network_Guide/Network_Diagnosis.md
          - OpenSSH使用指南: OCS/Network_Guide/OpenSSH_guide.md
          - DHCP服务配置指南: OCS/Network_Guide/DHCP_config.md
          - NTP配置指南: OCS/Network_Guide/NTP_config.md
          - 邮件服务使用指南: OCS/Network_Guide/Email_guide.md

      - 存储和文件系统管理指南:
          - 磁盘和分区管理: OCS/Storage_Filesystem_Administration_Guide/Diskpart_management.md
          - 文件系统管理: OCS/Storage_Filesystem_Administration_Guide/FileSystem_Management.md
          - 逻辑卷管理: OCS/Storage_Filesystem_Administration_Guide/Logical_volume_management.md
          - RAID 管理: OCS/Storage_Filesystem_Administration_Guide/RAID_Management.md
          - 网络存储管理: OCS/Storage_Filesystem_Administration_Guide/Network_storage_management.md

      - 开发与调测指南:
          - GCC开发指南: OCS/DevelopGuide/GCC_guide.md
          - LLVM/Clang: OCS/DevelopGuide/LLVM_Clang_guide.md
          - GO开发指南: OCS/DevelopGuide/GO_guide.md
          - RUST开发指南: OCS/DevelopGuide/RUST_guide.md
          - Python开发指南: OCS/DevelopGuide/Python_guide.md
          - Perl开发指南: OCS/DevelopGuide/Perl_guide.md
          - Java开发指南: OCS/DevelopGuide/Java_guide.md
          - dotnet开发指南: OCS/DevelopGuide/Dotnet_guide.md
          - Luajit开发指南: OCS/DevelopGuide/Luajit_guide.md
          - QT开发指南: OCS/DevelopGuide/QT_guide.md
          - Glibc可调参数使用指南: OCS/DevelopGuide/Glibc_pram_guide.md
          - kdump/crash: OCS/DevelopGuide/Kdump_crash_guide.md
          - 用户态coredump: OCS/DevelopGuide/User_coredump_guide.md
          - ftrace: OCS/DevelopGuide/Ftrace_guide.md
          - perf使用指南: OCS/DevelopGuide/Perf_guide.md
          - eBPF及工具bcc和bpftrace: OCS/DevelopGuide/Ebpf_guide.md

      - 容器和虚拟化指南:
          - 容器用户指南: OCS/Virtualization_and_Containers_Guide/Docker_guide.md
          - 虚拟化用户指南: OCS/Virtualization_and_Containers_Guide/Virtualization_userguide.md
          - OpenStack Wallaby 版本部署指南: OCS/Virtualization_and_Containers_Guide/OpenStack_UserGuide.md
          - OpenStack Zed 版本部署指南: OCS/Virtualization_and_Containers_Guide/OpenStack_Zed_UserGuide.md
          - Kubernetes部署指南: OCS/Virtualization_and_Containers_Guide/Kubernetes_UserGuide.md

      - 典型应用部署:
          - MySQL服务器搭建指南: OCS/Typical_Application_Deployment/MySQL_guide.md
          - MariaDB服务器搭建指南: OCS/Typical_Application_Deployment/MariaDB_guide.md
          - PostgreSQL服务器搭建指南: OCS/Typical_Application_Deployment/PostgreSQL_guide.md
          - SQLite使用指南: OCS/Typical_Application_Deployment/SQLite_guide.md
          - HA(PCS)部署文档: OCS/Typical_Application_Deployment/HAPCS_guide.md
          - Hadoop使用指南: OCS/Typical_Application_Deployment/Hadoop_guide.md

  - 生态认证:
    - 生态认证流程: adaptation/adaptation_process.md
    - 硬件测试用例: adaptation/testcase.md
    - 认证兼容列表:
      - 硬件兼容列表: adaptation/adaptation_hw.md
      - 商业软件兼容列表: adaptation/adaptation_sw.md
      - 开源软件兼容列表: adaptation/adaptation_oss.md
    - 适配FAQ: adaptation/adaptation_FAQ.md

  - CentOS停服专区:
    - CentOS停服专区: centos_migrate/migrate_relative.md
    - CentOS8迁移到OpenCloudOS8: centos_migrate/migrate.md
    - CentOS7迁移到OpenCloudOS8: centos_migrate/migrate_CentOS7_to_OC8.md
    - CentOS7迁移到OpenCloudOS7: centos_migrate/migrate_CentOS7_to_OC7.md

  - 常见问题: faq.md
  - 测试:
    - 一、项目管理: tcase/proj.md
    - 二、用例管理:
      - 编写用例: tcase/case_create.md
      - 提取用例: tcase/case_extract.md
      - 导入用例: tcase/case_import.md
      - 用例集: tcase/case_set.md
    - 三、执行环境:
      - 新增节点: tcase/node.md
      - 新增集群: tcase/cluster.md
    - 四、任务管理:
      - 创建任务: tcase/task_create.md
      - 执行任务: tcase/task_execute.md

  - 参与贡献:
    - 如何参与文档贡献: contribution/how-to.md
    - 如何参与代码贡献:
      - OpenCloudOS Stream 上游版本贡献指南: contribution/how-to-contribute-stream.md
      - OpenCloudOS 社区版本贡献指南: contribution/how-to-contribute-oc.md
      - OpenCloudOS 社区软件包管理原则: contribution/software-package-management-principles.md
      - OpenCloudOS 社区软件包打包指导: contribution/software-packaging-guide.md
      - OpenCloudOS CI门禁问题排查手册: contribution/ci-troubleshooting.md
      - OpenCloudOS Stream 工具 —— ocspkg: contribution/ocspkg-installation.md

    - 文档库格式手册: contribution/docs-format-guide.md
    - 内核开发指南: contribution/kernel-develop-guide.md
    - 贡献许可协议: contribution/contribution-agreement.md

plugins:
  - search
  - i18n:
      default_language: zh
      material_alternate: true
      languages:
        zh:
          name: 中文
        en:
          name: English
      nav_translations:
        en:
          首页: Home
          版本说明: Releases
          下载: Download
          使用说明: How to Use
          用户指南: Guide
          生态认证: Adaptation
          生态认证流程: Adaptation Process
          硬件测试用例: Test Case
          认证兼容列表: Adaptation Lists
          硬件兼容列表: Hardware Adaptation
          商业软件兼容列表: Commercial Software Adaptation
          开源软件兼容列表: OpenSouce Software Adaptation
          适配FAQ: Adaptation FAQ
          CentOS停服专区: About CentOS End-of-Life
          CentOS迁移OpenCloudOS: Migrate from CentOS
          常见问题: FAQ
          测试: Test
          参与贡献: Contributing
          如何贡献: How to contribute
          内核开发指南: Kernel Development Guide
          贡献许可协议: Contribution License Agreement
          文档库格式手册: Documentation format guide