Merge branch 'fix-headings' into 'main'

fixed headings See merge request CodeScoring/docs!300
CodeScoring · Jan 31, 2025 · 27b2e87 · 27b2e87
2 parents 5636fad + 9c4fd7f
commit 27b2e87
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 20 deletions.
diff --git a/docs/agent/export.en.md b/docs/agent/export.en.md
@@ -5,7 +5,7 @@ hide:
 
 # Exporting scan results
 
-The Johnny console agent supports exporting scan results to several formats. This allows to adapt reporting to various needs, including integration with vulnerability management systems.
+The Johnny console agent supports exporting scan results in several formats. This allows to adapt reporting to various needs, including integration with vulnerability management systems.
 
 ## Available report formats
 

diff --git a/docs/agent/export.md b/docs/agent/export.md
@@ -5,7 +5,7 @@ hide:
 
 # Экспорт результатов сканирования
 
-Консольный агент Johnny поддерживает выгрузку результатов сканирования в несколько форматов. Это позволяет адаптировать отчетность под различные нужды, включая интеграцию с системами управления уязвимостями.
+Консольный агент Johnny поддерживает выгрузку результатов сканирования в нескольких форматах. Это позволяет адаптировать отчетность под различные нужды, включая интеграцию с системами управления уязвимостями.
 
 ## Доступные форматы отчетов
 

diff --git a/docs/agent/scan-build.en.md b/docs/agent/scan-build.en.md
@@ -43,14 +43,14 @@ Then the build analysis command is called and the path to the config file is spe
 ./johnny scan build ./buildConfig.json
 ```
 
-**Important**: the command is intended for use in Linux-based operating systems only.
-
 As a result of the work, the agent displays one of three codes:
 
 - **0** – successful analysis, no problems were found in the build;
 - **1** – problems were found in the build, action is required;
 - **2** – analysis failed.
 
+**Important**: the command is intended for use in Linux-based operating systems only.
+
 ## Сommand parameters
 
 The **scan build** command has four unique parameters, in addition to [general scan command settings](/agent/scan.en/#launch-options:

diff --git a/docs/agent/scan-build.md b/docs/agent/scan-build.md
@@ -43,14 +43,14 @@ Johnny анализирует процесс сборки, используя ф
 ./johnny scan build ./buildConfig.json
 ```
 
-**Важно**: команда предназначена только для использования в Linux-based операционных системах.
-
 В результате работы агент отображает один из трех кодов:
 
 - **0** – успешный анализ, не было выявлено проблем в сборке;
 - **1** – были выявлены проблемы в сборке, требуется действие;
 - **2** – анализ не удался.
 
+**Важно**: команда предназначена только для использования в Linux-based операционных системах.
+
 ## Параметры команды
 
 Команда **scan build** имеет четыре уникальных параметра, помимо [общих настроек команды сканирования](/agent/scan/#_2):

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -68,17 +68,17 @@ plugins:
           vcs: "Connecting to VCS"
           repo-managers: "Connecting to repository managers"
           project-control: "Managing projects"
-          policies: "Policy management"
+          policies: "Managing policies"
           launch-analysis: "Launching analysis"
           export-results: "Exporting analysis results"
           registries: "Connecting container registries"
           groups: "Creating user groups"
           users: "Managing user accounts"
-          ldap: "LDAP settings"
-          graph: "Dependency graph"
-          notifications: "Notification settings"
-          audit-log: "Audit log"
-          metrics: "Metrics"
+          ldap: "Setting up LDAP"
+          graph: "Visualizing dependency graph"
+          notifications: "Setting up notifications"
+          audit-log: "Working with audit log"
+          metrics: "Collecting metrics"
           webhooks: "Setting up webhooks"
           api: "Working with API"
           osa: "CodeScoring OSA"
@@ -99,9 +99,9 @@ plugins:
           agent-scan-build: "Scanning a C/C++ build"
           agent-scan-bom: "Scanning a SBOM"
           agent-launch-docker: "Launching in Docker"
-          agent-gitlab-ci: "Integration into Gitlab CI"
-          agent-jenkins: "Integration into Jenkins Pipeline"
-          agent-gitflic-ci: "Integration into GitFlic CI"
+          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"
@@ -112,7 +112,7 @@ plugins:
           secrets-launch: "Launching secret search"
           secrets-cli: "Importing report to a CLI project"
           secrets-findings: "Working with findings"
-          secrets-model: "ML Model management"
+          secrets-model: "Managing ML Model"
           jfrog-changelog: "JFrog OSA"
           johnny-changelog: "CLI agent Johnny"
           nexus-changelog: "Nexus OSA"
@@ -136,7 +136,7 @@ plugins:
           analysis-ignore-paths: "Пути анализа и исключения"
           troubleshooting: "Диагностика неполадок"
           beginning: "Начало работы с инсталляцией"
-          activation: "Активация"
+          activation: "Активация системы"
           proprietors: "Создание владельцев"
           vcs: "Подключение системы контроля версий"
           repo-managers: "Подключение менеджеров репозиториев"
@@ -150,9 +150,9 @@ plugins:
           ldap: "Настройка LDAP"
           graph: "Визуализация графа зависимостей"
           notifications: "Настройка уведомлений"
-          audit-log: "Аудит-лог"
-          metrics: "Метрики"
-          webhooks: "Настройка вебхуков"
+          audit-log: "Работа с аудит-логом"
+          metrics: "Сбор метрик"
+          webhooks: "Подключение вебхуков"
           api: "Работа с API"
           osa: "CodeScoring OSA"
           osa-general: "Общее"