mkdocs.yml

site_name: "CodeScoring Documentation"
site_description: "Открытая документация CodeScoring: установка, руководство пользователя, changelog."
site_url: "https://docs.codescoring.ru"

theme:
  name: material
  custom_dir: overrides
  language: ru
  logo: assets/codescoring_logo.png
  favicon: assets/favicon/favicon-32x32.png
  features:
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.sections
    - navigation.icons
    - navigation.indexes
    - content.code.copy
    - content.code.select
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to dark mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/toggle-switch
        name: Switch to system preference
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/toggle-switch-off
        name: Switch to light mode

plugins:
  - search
  - i18n:
      languages:
        ru: "Русский"
        en: "English"
      default_language: 'ru'
      no_translation:
        ru: "Эта страница еще не переведена на русский язык."
        en: "This page has not yet been translated to English."
      translate_nav:
        en:
          home: "Home"
          begin: "Home"
          functionality: "Functionality"
          functional-characteristics: "Functional characteristics"
          integration-stages: "Integration stages"
          supported-package-managers: "Supported ecosystems and analysis methods"
          standards: "Standards compliance"
          admin-guide: "Administrator guide"
          installation: "On-premise installation and maintenance"
          hardware: "Installation requirements"
          installation-methods: "Installation Methods"
          installation-docker: "Installation in Docker"
          external-database: "External database in Docker"
          installation-kubernetes: "Installation in Kubernetes"
          maintenance: "Maintenance"
          update: "Updating the system in Docker"
          postgres-upgrade-compose: "Upgrading PostgreSQL in Docker"
          backup: "Backup"
          proxy: "Proxy usage"
          ssl: "Self signed SSL certificates"
          postgresql-tls: "Connecting to PostgreSQL/PgBouncer using TLS"
          analysis-ignore-paths: "Analysis paths and exceptions"
          scripts: "Scripts for platform managing"
          troubleshooting: "Troubleshooting"
          variables-extended: "Installation variables"
          containers-description: "Main services"
          setup: "Platform setup"
          user-management: "Access management"
          activation: "Activating system"
          user-profile: "Configuring user profile"
          proprietors: "Creating proprietors"
          groups: "Creating user groups"
          project-groups: "Organizing project groups"
          users: "Managing user accounts"
          ldap: "Setting up LDAP"
          oidc: "Setting up OpenID Connect"
          project-setup: "Project setup"
          vcs: "Connecting to VCS"
          project-control: "Managing projects"
          ignores: "Ignoring policies"
          launch-analysis: "Configuring and launching analysis"
          export-results: "Exporting analysis results"
          advanced-setup: "Advanced setup"
          notifications: "Setting up notifications"
          audit-log: "Working with audit log"
          metrics: "Collecting metrics"
          webhooks: "Setting up webhooks"
          api: "Working with API"
          author-audit: "Calculating number of authors"
          admin-guide-intro: "Admin guide"
          user-guide: "User guide"
          general: "General"
          general-intro: "General"
          policies: "Security policies"
          policies-settings: "Managing policies"
          policies-results: "Policy results"
          artifact-plugins: "Plugins for repositories"
          repo-managers: "Connecting a repository manager"
          registries: "Connecting a container registry"
          osa-update: "Updating component data"
          platform-analysis: "Analysis in the platform"
          sca-general: "General description"
          sca-dependencies: "Overviewing dependencies"
          vulnerabilities: "Working with vulnerabilities"
          launch-analysis: "Launching a scan"
          scan-history: "Tracking scan history"
          export-results: "Exporting analysis results"
          sca: "CodeScoring.SCA"
          osa: "CodeScoring.OSA"
          osa-general: "General description"
          nexus-osa: "Plugin for Nexus"
          jfrog-osa: "Plugin for JFrog"
          sfera-osa: "Plugin for Sfera"
          osa-policies: "Configuring OSA policies"
          osa-components: "Working with OSA components"
          platform-osa: "Working with OSA in the platform"
          osa-proxy: "OSA Proxy"
          osa-proxy-general: "Overview"
          osa-proxy-protocols: "Supported protocols"
          osa-proxy-config: "Service configuration"
          osa-proxy-caching-config: "Redis and сaching сonfiguration"
          osa-proxy-base64: "Base64 URL configuration"
          osa-proxy-installation: "Service deployment"
          osa-proxy-maven-config: "Maven configuration"
          osa-proxy-npm-config: "npm configuration"
          osa-proxy-nuget-config: "NuGet configuration"
          osa-proxy-pypi-config: "PyPI configuration"
          osa-proxy-go-config: "GO configuration"
          osa-proxy-debian-config: "Debian configuration"
          osa-proxy-docker-config: "Docker configuration"
          osa-proxy-apk-config: "Alpine (APK) configuration"
          osa-proxy-rpm-config: "RPM configuration"
          osa-proxy-metrics: "Metrics"
          ide: "IDE integrations"
          ide-general: "General description"
          vscode-sca: "VS Code plugin"
          intellij-sca: "IntelliJ plugin"
          agent: "CLI agent Johnny"
          agent-general: "General description"
          agent-config: "Using configuration file"
          agent-variables: "Setting environment variables"
          agent-scan: "Scan command"
          agent-scan-dir: "Scanning a directory"
          agent-scan-file: "Scanning a file"
          agent-scan-archive: "Scanning archives"
          agent-scan-docker: "Scanning container images"
          agent-scan-build: "Scanning a C/C++ build"
          agent-scan-bom: "Scanning a SBOM"
          agent-scan-technology: "Scanning a technology"
          agent-scan-secrets: "Scanning for secrets"
          agent-reachability: "Using reachability analysis"
          agent-sign-verify-bom: "Signing and verifying a SBOM"
          agent-launch-docker: "Launching in Docker"
          agent-gitlab-ci: "Integrating into Gitlab CI"
          agent-jenkins: "Integrating into Jenkins Pipeline"
          agent-gitflic-ci: "Integrating into GitFlic CI"
          agent-save-results: "Saving scan results"
          agent-export: "Exporting scan results"
          agent-resolve: "Resolving dependencies"
          dependencies: "Working with dependencies"
          dependencies-general: "General description"
          dependencies-java: "Java"
          dependencies-scala: "Scala"
          dependencies-go: "Go"
          dependencies-js: "JavaScript"
          dependencies-dotnet: ".NET"
          dependencies-php: "PHP"
          dependencies-python: "Python"
          dependencies-ruby: "Ruby"
          feeds: "Data feeds"
          feeds-general: "General description"
          feeds-protestware: "Working with protestware feed"
          feeds-kaspersky: "Using Kaspersky OSS Threats Data Feed"
          feeds-oss-index: "Integrating OSS Index"
          secrets: "CodeScoring.Secrets"
          secrets-configuration: "Configuration"
          secrets-general: "General description"
          secrets-setup: "Setting up engine configuration"
          secrets-vcs: "Configuring VCS project for secret search"
          secrets-model: "Managing ML Model"
          secrets-usage: "Secrets analysis"
          secrets-launch: "Launching secret search"
          secrets-cli: "Searching secrets in CLI projects"
          secrets-findings: "Working with findings"
          tqi: "CodeScoring.TQI"
          tqi-analysis-group: "Project analysis"
          tqi-general: "General description"
          tqi-analysis: "Launching TQI analysis"
          tqi-results: "Viewing analysis results"
          tqi-advanced: "Advanced features"
          tqi-authors: "Author analysis"
          tqi-authors-profiles: "Building author profiles"
          tqi-clones: "Tracking code clones"
          tqi-metrics: "Calculating technical debt metrics"
          changelog: "Changelog"
          on-premise-changelog: "CodeScoring on-premise"
          jfrog-changelog: "Plugin for JFrog"
          sfera-changelog: "Plugin for Sfera"
          johnny-changelog: "CLI agent Johnny"
          nexus-changelog: "Nexus OSA"
          vscode-changelog: "VS Code plugin"
          intellij-changelog: "IntelliJ plugin"
          proxy-changelog: "OSA Proxy service"

        ru:
          home: "Главная"
          begin: "Главная"
          functionality: "Функциональность"
          functional-characteristics: "Функциональные характеристики"
          integration-stages: "Этапы интеграции"
          supported-package-managers: "Поддерживаемые экосистемы и способы анализа"
          standards: "Соответствие стандартам"
          admin-guide: "Руководство администратора"
          installation: "Установка и эксплуатация"
          hardware: "Требования к установке"
          installation-methods: "Варианты установки"
          installation-docker: "Установка системы в Docker"
          external-database: "Работа со внешней СУБД в Docker"
          installation-kubernetes: "Работа системы в Kubernetes"
          maintenance: "Обслуживание"
          update: "Обновление системы в Docker"
          postgres-upgrade-compose: "Обновление PostgreSQL в Docker"
          backup: "Резервное копирование"
          proxy: "Работа через прокси"
          ssl: "Самоподписанные SSL сертификаты"
          postgresql-tls: "Подключение к PostgreSQL/PgBouncer с использованием TLS"
          analysis-ignore-paths: "Пути анализа и исключения"
          scripts: "Скрипты для управления инсталляцией"
          variables-extended: "Переменные установки"
          containers-description: "Основные службы" 
          troubleshooting: "Диагностика неполадок"
          setup: "Настройка платформы"
          user-management: "Управление доступом"
          activation: "Активация системы"
          user-profile: "Настройка профиля пользователя"
          proprietors: "Создание подразделений"
          groups: "Создание групп пользователей"
          project-groups: "Организация групп проектов"
          users: "Управление учетными записями"
          ldap: "Настройка LDAP"
          oidc: "Настройка OpenID Connect"
          project-setup: "Настройка проектов"
          vcs: "Подключение системы контроля версий"
          project-control: "Управление проектами"
          ignores: "Игнорирование политик"
          launch-analysis: "Настройка и запуск анализа"
          export-results: "Выгрузка результатов анализа"
          advanced-setup: "Расширенная настройка"
          notifications: "Настройка уведомлений"
          audit-log: "Работа с аудит-логом"
          metrics: "Сбор метрик"
          webhooks: "Подключение вебхуков"
          api: "Работа с API"
          author-audit: "Аудит количества авторов"
          admin-guide-intro: "Руководство администратора"
          user-guide: "Руководство пользователя"
          general: "Общее"
          general-intro: "Общее"
          policies: "Политики безопасности"
          policies-settings: "Настройка политик"
          policies-results: "Результаты работы политик"
          artifact-plugins: "Плагины для хранилищ"
          repo-managers: "Подключение менеджера репозиториев"
          registries: "Подключение реестра с образами"
          osa-update: "Обновление данных о компонентах"
          sca: "CodeScoring.SCA"
          sca-general: "Общее описание"
          sca-dependencies: "Обзор зависимостей"
          platform-analysis: "Анализ в платформе"
          vulnerabilities: "Работа с уязвимостями"
          launch-analysis: "Запуск сканирования"
          scan-history: "Отслеживание истории сканирований"
          osa: "CodeScoring.OSA"
          osa-general: "Общее описание"
          nexus-osa: "Плагин для Nexus"
          jfrog-osa: "Плагин для JFrog"
          sfera-osa: "Плагин для Сфера"
          osa-policies: "Настройка политик OSA"
          osa-components: "Работа с компонентами OSA"
          platform-osa: "Работа с OSA в платформе"
          osa-proxy: "Сервис OSA Proxy"
          osa-proxy-general: "Общее описание"
          osa-proxy-protocols: "Поддерживаемые протоколы"
          osa-proxy-config: "Настройка сервиса"
          osa-proxy-caching-config: "Настройка Redis и кэширования"
          osa-proxy-base64: "Настройка Base64 URL"
          osa-proxy-installation: "Установка сервиса"
          osa-proxy-maven-config: "Настройка Maven"
          osa-proxy-npm-config: "Настройка NPM"
          osa-proxy-nuget-config: "Настройка NuGet"
          osa-proxy-pypi-config: "Настройка PyPI"
          osa-proxy-go-config: "Настройка GO"
          osa-proxy-debian-config: "Настройка Debian"
          osa-proxy-docker-config: "Настройка Docker"
          osa-proxy-apk-config: "Настройка Alpine (APK)"
          osa-proxy-rpm-config: "Настройка RPM"
          osa-proxy-metrics: "Метрики"
          ide: "Интеграция с IDE"
          ide-general: "Общее описание"
          vscode-sca: "Плагин для VS Code"
          intellij-sca: "Плагин для IntelliJ"
          agent: "Консольный агент Johnny"
          agent-general: "Общее описание"
          agent-config: "Настройка через конфигурационный файл"
          agent-variables: "Настройка через переменные окружения"
          agent-scan: "Команда сканирования"
          agent-scan-dir: "Сканирование директории"
          agent-scan-file: "Сканирование файла"
          agent-scan-archive: "Сканирование архивов"
          agent-scan-docker: "Сканирование контейнерных образов"
          agent-scan-build: "Сканирование сборки C/C++"
          agent-scan-bom: "Сканирование SBOM"
          agent-scan-technology: "Сканирование технологии"
          agent-scan-secrets: "Сканирование на наличие секретов"
          agent-reachability: "Анализ достижимости уязвимостей"
          agent-sign-verify-bom: "Подпись и верификация SBOM"
          agent-launch-docker: "Запуск с помощью Docker"
          agent-gitlab-ci: "Добавление в Gitlab CI"
          agent-jenkins: "Добавление в Jenkins"
          agent-gitflic-ci: "Добавление в GitFlic CI"
          agent-save-results: "Сохранение результатов сканирования"
          agent-export: "Экспорт результатов сканирования"
          agent-resolve: "Разрешение зависимостей в окружении сборки"
          dependencies: "Работа с зависимостями"
          dependencies-general: "Общее описание"
          dependencies-java: "Java"
          dependencies-scala: "Scala"
          dependencies-go: "Go"
          dependencies-js: "JavaScript"
          dependencies-dotnet: ".NET"
          dependencies-php: "PHP"
          dependencies-python: "Python"
          dependencies-ruby: "Ruby"
          feeds: "Потоки данных"
          feeds-general: "Общее описание"
          feeds-protestware: "Работа с фидом protestware"
          feeds-kaspersky: "Использование Kaspersky OSS Threats Data Feed"
          feeds-oss-index: "Интеграция OSS Index"
          secrets: "CodeScoring.Secrets"
          secrets-configuration: "Настройка"
          secrets-general: "Общее описание"
          secrets-setup: "Создание конфигурации для поиска секретов"
          secrets-vcs: "Настройка VCS проекта для работы с секретами"
          secrets-model: "Управление ML моделью"
          secrets-usage: "Анализ секретов"
          secrets-launch: "Запуск поиска секретов"
          secrets-cli: "Поиск секретов в CLI проектах"
          secrets-findings: "Работа с найденными секретами"
          tqi: "CodeScoring.TQI"
          tqi-analysis-group: "Анализ проектов"
          tqi-general: "Общее описание"
          tqi-analysis: "Запуск TQI анализа"
          tqi-results: "Просмотр результатов анализа"
          tqi-advanced: "Расширенные возможности"
          tqi-authors: "Анализ авторов"
          tqi-authors-profiles: "Построение профилей авторов"
          tqi-clones: "Отслеживание дубликатов кода"
          tqi-metrics: "Расчет метрик технического долга"
          changelog: "Changelog"
          on-premise-changelog: "CodeScoring on-premise"
          jfrog-changelog: "Плагин для JFrog"
          sfera-changelog: "Плагин для Сфера"
          johnny-changelog: "Консольный агент Johnny"
          nexus-changelog: "Плагин для Nexus"
          vscode-changelog: "Плагин для VS Code"
          intellij-changelog: "Плагин для IntelliJ"
          proxy-changelog: "OSA Proxy"
  - print-site:
      exclude:
        - index.md
        - changelog/*
  - llmstxt:
      markdown_description: "Открытая документация CodeScoring: установка, руководство пользователя, changelog."
      sections:
        Главная:
          - index.md: "Главная страница документации"
        Функциональность:
          - functionality.md: "Функциональные характеристики"
          - integration-stages.md: "Этапы интеграции"
          - supported-package-managers.md: "Поддерживаемые экосистемы"
        Установка и эксплуатация:
          - on-premise/server-requirements.md: "Аппаратные требования"
          - on-premise/installation.md: "Установка в Docker"
          - on-premise/*.md
        Руководство пользователя:
          - on-premise/how-to/*.md
          - osa/*.md
          - osa-proxy/*.md
          - sca/*.md
          - agent/*.md
          - ide/*.md
          - dependencies/*.md
          - feeds/*.md
          - secrets/*.md
          - tqi/*.md
        Changelog:
          - changelog/*.md
      autoclean: true

nav:
  - begin: index.md
  - begin: index.en.md
  - functionality:
    - functional-characteristics: functionality.md
    - functional-characteristics: functionality.en.md
    - integration-stages: integration-stages.md
    - integration-stages: integration-stages.en.md
    - supported-package-managers: supported-package-managers.md
    - supported-package-managers: supported-package-managers.en.md
    - standards: standards.md
    - standards: standards.en.md
  - admin-guide:
    - admin-guide-intro: admin-guide.md
    - admin-guide-intro: admin-guide.en.md
    - installation:
      - hardware: on-premise/server-requirements.md
      - hardware: on-premise/server-requirements.en.md
      - installation-methods:
        - installation-docker: on-premise/installation.md
        - installation-docker: on-premise/installation.en.md
        - external-database: on-premise/external-database.md
        - external-database: on-premise/external-database.en.md
        - installation-kubernetes: on-premise/installation-in-k8s.md
        - installation-kubernetes: on-premise/installation-in-k8s.en.md
      - maintenance:
        - update: on-premise/update.md
        - update: on-premise/update.en.md
        - postgres-upgrade-compose: on-premise/postgres-upgrade-compose.en.md
        - postgres-upgrade-compose: on-premise/postgres-upgrade-compose.md
        - backup: on-premise/backup.md
        - backup: on-premise/backup.en.md
        - proxy: on-premise/proxy.md
        - proxy: on-premise/proxy.en.md
        - ssl: on-premise/self-signed-ssl.md
        - ssl: on-premise/self-signed-ssl.en.md
        - postgresql-tls: on-premise/postgresql-tls.md
        - postgresql-tls: on-premise/postgresql-tls.en.md
        - analysis-ignore-paths: on-premise/analysis-ignore-paths.md
        - analysis-ignore-paths: on-premise/analysis-ignore-paths.en.md
        - scripts: on-premise/scripts.md
        - scripts: on-premise/scripts.en.md
        - variables-extended: on-premise/variables-extended.md
        - variables-extended: on-premise/variables-extended.en.md
        - containers-description: on-premise/containers-description.md
        - containers-description: on-premise/containers-description.en.md
        - troubleshooting: on-premise/troubleshooting.md
        - troubleshooting: on-premise/troubleshooting.en.md
    - setup:
      - activation: on-premise/how-to/activation.md
      - activation: on-premise/how-to/activation.en.md
      - author-audit: on-premise/how-to/author-audit.md
      - author-audit: on-premise/how-to/author-audit.en.md
      - user-management:
        - users: on-premise/how-to/users.md
        - users: on-premise/how-to/users.en.md
        - groups: on-premise/how-to/groups.md
        - groups: on-premise/how-to/groups.en.md
        - ldap: on-premise/how-to/ldap-settings.md
        - ldap: on-premise/how-to/ldap-settings.en.md
        - oidc: on-premise/how-to/oidc.md
        - oidc: on-premise/how-to/oidc.en.md
  - user-guide:
    - user-guide.md
    - user-guide.en.md
    - general:
      - general-intro: on-premise/how-to/general/index.md
      - general-intro: on-premise/how-to/general/index.en.md
      - user-profile: on-premise/how-to/user-profile.md
      - user-profile: on-premise/how-to/user-profile.en.md
      - policies:
        - policies-settings: on-premise/how-to/policies.md
        - policies-settings: on-premise/how-to/policies.en.md
        - ignores: on-premise/how-to/ignores.md
        - ignores: on-premise/how-to/ignores.en.md
        - policies-results: on-premise/how-to/policy-results.md
        - policies-results: on-premise/how-to/policy-results.en.md
      - project-setup:
        - vcs: on-premise/how-to/vcs-git.md
        - vcs: on-premise/how-to/vcs-git.en.md
        - project-control: on-premise/how-to/projects.md
        - project-control: on-premise/how-to/projects.en.md
      - advanced-setup:
        - proprietors: on-premise/how-to/proprietors.md
        - proprietors: on-premise/how-to/proprietors.en.md
        - notifications: on-premise/how-to/notifications.md
        - notifications: on-premise/how-to/notifications.en.md
        - audit-log: on-premise/how-to/audit-log.md
        - audit-log: on-premise/how-to/audit-log.en.md
        - metrics: on-premise/how-to/metrics.md
        - metrics: on-premise/how-to/metrics.en.md
        - webhooks: on-premise/how-to/webhooks.md
        - webhooks: on-premise/how-to/webhooks.en.md
        - api: on-premise/how-to/api.md
        - api: on-premise/how-to/api.en.md
      - feeds:
        - feeds-general: feeds/index.md
        - feeds-general: feeds/index.en.md
        - feeds-protestware: feeds/protestware.md
        - feeds-protestware: feeds/protestware.en.md
        - feeds-kaspersky: feeds/kaspersky.md
        - feeds-kaspersky: feeds/kaspersky.en.md
        - feeds-oss-index: feeds/oss-index.md
        - feeds-oss-index: feeds/oss-index.en.md
    - osa:
      - osa-general: osa/index.md
      - osa-general: osa/index.en.md
      - artifact-plugins:
        - nexus-osa: osa/nexus_osa.md
        - nexus-osa: osa/nexus_osa.en.md
        - jfrog-osa: osa/jfrog_osa.md
        - jfrog-osa: osa/jfrog_osa.en.md
        - sfera-osa: osa/sfera_osa.md
        - sfera-osa: osa/sfera_osa.en.md
      - platform-osa:
        - repo-managers: osa/repo-managers.md
        - repo-managers: osa/repo-managers.en.md
        - registries: osa/registries.md
        - registries: osa/registries.en.md
        - osa-policies: osa/osa-policies.md
        - osa-policies: osa/osa-policies.en.md
        - osa-components: osa/components.md
        - osa-components: osa/components.en.md
        - osa-update: osa/update.md
        - osa-update: osa/update.en.md
      - osa-proxy:
        - osa-proxy-general: osa-proxy/index.md
        - osa-proxy-general: osa-proxy/index.en.md
        - osa-proxy-installation: osa-proxy/installation.md
        - osa-proxy-installation: osa-proxy/installation.en.md
        - osa-proxy-config: osa-proxy/config.md
        - osa-proxy-config: osa-proxy/config.en.md
        - osa-proxy-caching-config: osa-proxy/config-caching.md
        - osa-proxy-caching-config: osa-proxy/config-caching.en.md
        - osa-proxy-protocols: osa-proxy/protocols.md
        - osa-proxy-protocols: osa-proxy/protocols.en.md
        - osa-proxy-metrics: osa-proxy/metrics.md
        - osa-proxy-metrics: osa-proxy/metrics.en.md
        - osa-proxy-base64: osa-proxy/base64-url.md
        - osa-proxy-base64: osa-proxy/base64-url.en.md
        - osa-proxy-maven-config: osa-proxy/config-maven.md
        - osa-proxy-maven-config: osa-proxy/config-maven.en.md
        - osa-proxy-npm-config: osa-proxy/config-npm.md
        - osa-proxy-npm-config: osa-proxy/config-npm.en.md
        - osa-proxy-nuget-config: osa-proxy/config-nuget.md
        - osa-proxy-nuget-config: osa-proxy/config-nuget.en.md
        - osa-proxy-pypi-config: osa-proxy/config-pypi.md
        - osa-proxy-pypi-config: osa-proxy/config-pypi.en.md
        - osa-proxy-go-config: osa-proxy/config-go.md
        - osa-proxy-go-config: osa-proxy/config-go.en.md
        - osa-proxy-debian-config: osa-proxy/config-debian.md
        - osa-proxy-debian-config: osa-proxy/config-debian.en.md
        - osa-proxy-docker-config: osa-proxy/config-docker.md
        - osa-proxy-docker-config: osa-proxy/config-docker.en.md
        - osa-proxy-apk-config: osa-proxy/config-apk.md
        - osa-proxy-apk-config: osa-proxy/config-apk.en.md
        - osa-proxy-rpm-config: osa-proxy/config-rpm.md
        - osa-proxy-rpm-config: osa-proxy/config-rpm.en.md
    - sca:
      - sca-general: sca/index.md
      - sca-general: sca/index.en.md
      - platform-analysis:
        - launch-analysis: sca/launch-analysis.md
        - launch-analysis: sca/launch-analysis.en.md
        - sca-dependencies: sca/sca-dependencies.md
        - sca-dependencies: sca/sca-dependencies.en.md
        - vulnerabilities: sca/vulnerabilities.md
        - vulnerabilities: sca/vulnerabilities.en.md
        - scan-history: sca/scan-history.md
        - scan-history: sca/scan-history.en.md
        - export-results: sca/export-results.md
        - export-results: sca/export-results.en.md
        - project-groups: sca/project-groups.md
        - project-groups: sca/project-groups.en.md
      - agent:
        - agent-general: agent/index.md
        - agent-general: agent/index.en.md
        - agent-config: agent/config.md
        - agent-config: agent/config.en.md
        - agent-variables: agent/env-variables.md
        - agent-variables: agent/env-variables.en.md
        - agent-scan: agent/scan.md
        - agent-scan: agent/scan.en.md
        - agent-scan-dir: agent/scan-dir.md
        - agent-scan-dir: agent/scan-dir.en.md
        - agent-scan-file: agent/scan-file.md
        - agent-scan-file: agent/scan-file.en.md
        - agent-scan-archive: agent/scan-archive.md
        - agent-scan-archive: agent/scan-archive.en.md
        - agent-scan-docker: agent/scan-docker.md
        - agent-scan-docker: agent/scan-docker.en.md
        - agent-scan-build: agent/scan-build.md
        - agent-scan-build: agent/scan-build.en.md
        - agent-scan-bom: agent/scan-bom.md
        - agent-scan-bom: agent/scan-bom.en.md
        - agent-scan-technology: agent/scan-technology.md
        - agent-scan-technology: agent/scan-technology.en.md
        - agent-scan-secrets: agent/scan-secrets.md
        - agent-scan-secrets: agent/scan-secrets.en.md
        - agent-reachability: agent/reachability.md
        - agent-reachability: agent/reachability.en.md
        - agent-sign-verify-bom: agent/sign-verify-bom.md
        - agent-sign-verify-bom: agent/sign-verify-bom.en.md
        - agent-launch-docker: agent/launch-docker.md
        - agent-launch-docker: agent/launch-docker.en.md
        - agent-gitlab-ci: agent/gitlab-ci.md
        - agent-gitlab-ci: agent/gitlab-ci.en.md
        - agent-jenkins: agent/jenkins-pipeline.md
        - agent-jenkins: agent/jenkins-pipeline.en.md
        - agent-gitflic-ci: agent/gitflic-ci.md
        - agent-gitflic-ci: agent/gitflic-ci.en.md
        - agent-save-results: agent/save-results.md
        - agent-save-results: agent/save-results.en.md
        - agent-export: agent/export.md
        - agent-export: agent/export.en.md
        - agent-resolve: agent/resolve.md
        - agent-resolve: agent/resolve.en.md
      - ide:
        - ide-general: ide/index.md
        - ide-general: ide/index.en.md
        - vscode-sca: ide/vscode-sca.md
        - vscode-sca: ide/vscode-sca.en.md
        - intellij-sca: ide/intellij-sca.md
        - intellij-sca: ide/intellij-sca.en.md
      - dependencies:
        - dependencies-general: dependencies/index.md
        - dependencies-general: dependencies/index.en.md
        - dependencies-java: dependencies/java.md
        - dependencies-java: dependencies/java.en.md
        - dependencies-scala: dependencies/scala.md
        - dependencies-scala: dependencies/scala.en.md
        - dependencies-go: dependencies/go.md
        - dependencies-go: dependencies/go.en.md
        - dependencies-js: dependencies/js.md
        - dependencies-js: dependencies/js.en.md
        - dependencies-dotnet: dependencies/dotnet.md
        - dependencies-dotnet: dependencies/dotnet.en.md
        - dependencies-php: dependencies/php.md
        - dependencies-php: dependencies/php.en.md
        - dependencies-python: dependencies/python.md
        - dependencies-python: dependencies/python.en.md
        - dependencies-ruby: dependencies/ruby.md
        - dependencies-ruby: dependencies/ruby.en.md
    - secrets:
      - secrets-general: secrets/index.md
      - secrets-general: secrets/index.en.md
      - secrets-configuration:
        - secrets-setup: secrets/secrets-setup.md
        - secrets-setup: secrets/secrets-setup.en.md
        - secrets-vcs: secrets/secrets-vcs.md
        - secrets-vcs: secrets/secrets-vcs.en.md
      - secrets-usage:
        - secrets-launch: secrets/secrets-launch.md
        - secrets-launch: secrets/secrets-launch.en.md
        - secrets-cli: secrets/secrets-cli.md
        - secrets-cli: secrets/secrets-cli.en.md
        - secrets-findings: secrets/secrets-findings.md
        - secrets-findings: secrets/secrets-findings.en.md
      - secrets-model: secrets/secrets-model.md
      - secrets-model: secrets/secrets-model.en.md
    - tqi:
      - tqi-general: tqi/index.md
      - tqi-general: tqi/index.en.md
      - tqi-analysis-group:
        - tqi-analysis: tqi/launch-analysis.md
        - tqi-analysis: tqi/launch-analysis.en.md
        - tqi-results: tqi/viewing-results.md
        - tqi-results: tqi/viewing-results.en.md
        - tqi-clones: tqi/clones.md
        - tqi-clones: tqi/clones.en.md
        - tqi-metrics: tqi/metrics.md
        - tqi-metrics: tqi/metrics.en.md
      - tqi-authors:
        - tqi-authors-profiles: tqi/authors.md
        - tqi-authors-profiles: tqi/authors.en.md
  - changelog:
    - on-premise-changelog: changelog/on-premise-changelog.md
    - on-premise-changelog: changelog/on-premise-changelog.en.md
    - johnny-changelog: changelog/johnny-changelog.md
    - johnny-changelog: changelog/johnny-changelog.en.md
    - nexus-changelog: changelog/nexus-changelog.md
    - nexus-changelog: changelog/nexus-changelog.en.md
    - jfrog-changelog: changelog/jfrog-changelog.md
    - jfrog-changelog: changelog/jfrog-changelog.en.md
    - sfera-changelog: changelog/sfera-changelog.md
    - sfera-changelog: changelog/sfera-changelog.en.md
    - vscode-changelog: changelog/vscode-changelog.md
    - vscode-changelog: changelog/vscode-changelog.en.md
    - intellij-changelog: changelog/intellij-changelog.md
    - intellij-changelog: changelog/intellij-changelog.en.md
    - proxy-changelog: changelog/proxy-changelog.md
    - proxy-changelog: changelog/proxy-changelog.en.md

copyright: Copyright &copy; 2018 - <script>document.write(new Date().getFullYear())</script> CodeScoring

markdown_extensions:
  - attr_list
  - def_list
  - tables
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - toc:
        permalink: true

extra_css:
  - stylesheets/extra.css
  - stylesheets/home.css
  - css/logo.css
  - css/hide_lang_links.css
  - css/print.css

extra_javascript:
  - js/search.js
  - js/home.js

extra:
  social:
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@codescoring
      name: YouTube
    - icon: fontawesome/brands/telegram
      link: https://t.me/codescoring
      name: Telegram
    - icon: fontawesome/brands/vk
      link: https://vkvideo.ru/@codescoring/all
      name: VK Видео
  alternate:
    - name: "Русский"
      link: "/"
      lang: ru
    - name: "English"
      link: "/index.en/"
      lang: en
  i18n:
    - ru:
      site_name: "Документация CodeScoring"
    - en:
      site_name: "CodeScoring Documentation"