diff --git a/Makefile b/Makefile index aada06c0..97b850ce 100644 --- a/Makefile +++ b/Makefile @@ -17,4 +17,4 @@ bootstrap: exordos bootstrap -i output -f -m core --admin-password admin --cidr 10.20.0.0/22 mdlint: - markdownlint-cli2 --config .markdownlint.yaml "**/*.md" "#node_modules" --fix \ No newline at end of file + markdownlint-cli2 --config .markdownlint.yaml "**/*.md" "#node_modules" "#!.venv" "#!.tox" --fix \ No newline at end of file diff --git a/docs/app-developer-guide/build.md b/docs/app-developer-guide/build.md index db263c16..907e203e 100644 --- a/docs/app-developer-guide/build.md +++ b/docs/app-developer-guide/build.md @@ -266,4 +266,4 @@ After a successful build, your elements are ready for: ## Troubleshooting -If you encounter issues during the build process — such as dependency resolution failures, VM image build errors, or manifest processing problems — refer to the [Troubleshooting Guide](troubleshooting.md) for detailed solutions and common fixes. +If you encounter issues during the build process — such as dependency resolution failures, VM image build errors, or manifest processing problems — refer to the [Troubleshooting Guide](../usage/troubleshooting.md) for detailed solutions and common fixes. diff --git a/docs/app-developer-guide/build.ru.md b/docs/app-developer-guide/build.ru.md index 82bdfbd5..6d38207a 100644 --- a/docs/app-developer-guide/build.ru.md +++ b/docs/app-developer-guide/build.ru.md @@ -266,4 +266,4 @@ output/ ## Устранение неполадок -Если вы столкнулись с проблемами в процессе сборки — такими как ошибки разрешения зависимостей, ошибки сборки образов VM или проблемы обработки манифестов — обратитесь к [Руководству по устранению неполадок](troubleshooting.ru.md) для подробных решений и типичных исправлений. +Если вы столкнулись с проблемами в процессе сборки — такими как ошибки разрешения зависимостей, ошибки сборки образов VM или проблемы обработки манифестов — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений. diff --git a/docs/app-developer-guide/deploy.md b/docs/app-developer-guide/deploy.md index ca0c52f2..3f20cd08 100644 --- a/docs/app-developer-guide/deploy.md +++ b/docs/app-developer-guide/deploy.md @@ -12,12 +12,12 @@ exordos elements install [OPTIONS] PATH_OR_NAME Key options: -| Option | Description | -|---|---| -| `-r, --repository TEXT` | Repository endpoint where the element is stored [default: `https://repo.exordos.com/exordos-elements/`] | -| `PATH_OR_NAME` | Path to a local manifest file or the name of an element in the repository | +| Option | Description | +|---|-------------------------------------------------------------------------------------------------------| +| `-r, --repository TEXT` | Repository endpoint where the element is stored [default](https://repo.exordos.com/exordos-elements/) | +| `PATH_OR_NAME` | Path to a local manifest file or the name of an element in the repository | -You can install elements on a [public Exordos Core installation](public-installation.md). Or you can deploy a [private Exordos Core installation](private-installation.md) on your own hardware. For development and testing, you can use [local laptop installation](local-laptop-installation.md). +You can install elements on a [public Exordos Core installation](../usage/public-installation.md). Or you can deploy a [private Exordos Core installation](../usage/private-installation.md) on your own hardware. For development and testing, you can use [local laptop installation](../usage/local-laptop-installation.md). --- @@ -73,10 +73,10 @@ After a successful installation: - Verify the element status in the Exordos Core CLI - [Customize the manifest](../em/manifest.md) to tailor the element configuration to your needs -- [Update the element](../admin-guide/index.md) when a new version is available +- [Update the element](../usage/admin-guide.md) when a new version is available --- ## Troubleshooting -If you encounter issues during deployment — such as element installation failures, dependency resolution errors, or realm connectivity problems — refer to the [Troubleshooting Guide](troubleshooting.md) for detailed solutions and common fixes. +If you encounter issues during deployment — such as element installation failures, dependency resolution errors, or realm connectivity problems — refer to the [Troubleshooting Guide](../usage/troubleshooting.md) for detailed solutions and common fixes. diff --git a/docs/app-developer-guide/deploy.ru.md b/docs/app-developer-guide/deploy.ru.md index 2e387b58..eba129c9 100644 --- a/docs/app-developer-guide/deploy.ru.md +++ b/docs/app-developer-guide/deploy.ru.md @@ -12,12 +12,12 @@ exordos elements install [OPTIONS] PATH_OR_NAME Ключевые опции: -| Опция | Описание | -|-------------------------|---------------------------------------------------------------------------------------------------------------| -| `-r, --repository TEXT` | Конечная точка репозитория, где хранится элемент [по умолчанию: `https://repo.exordos.com/exordos-elements/`] | -| `PATH_OR_NAME` | Путь к локальному файлу манифеста или имя элемента в репозитории | +| Опция | Описание | +|-------------------------|-------------------------------------------------------------------------------------------------------------| +| `-r, --repository TEXT` | Конечная точка репозитория, где хранится элемент [по умолчанию](https://repo.exordos.com/exordos-elements/) | +| `PATH_OR_NAME` | Путь к локальному файлу манифеста или имя элемента в репозитории | -Вы можете устанавливать элементы на [публичную установку Exordos Core](public-installation.ru.md). Или вы можете развернуть [приватную установку Exordos Core](private-installation.ru.md) на своём оборудовании. Для разработки и тестирования вы можете использовать [установку на локальном ноутбуке](../usage/local_deployment.ru.md). +Вы можете устанавливать элементы на [публичную установку Exordos Core](../usage/public-installation.ru.md). Или вы можете развернуть [приватную установку Exordos Core](../usage/private-installation.ru.md) на своём оборудовании. Для разработки и тестирования вы можете использовать [установку на локальном ноутбуке](../usage/local_deployment.ru.md). --- @@ -73,10 +73,10 @@ exordos elements install -r https://my-repo.example.com/elements/ my-element - Проверьте статус элемента в Exordos Core CLI - [Настройте манифест](../em/manifest.ru.md) для адаптации конфигурации элемента под ваши нужды -- [Обновите элемент](../admin-guide/index.ru.md) когда доступна новая версия +- [Обновите элемент](../usage/admin-guide.ru.md) когда доступна новая версия --- ## Устранение неполадок -Если вы столкнулись с проблемами во время развёртывания — такими как ошибки установки элемента, ошибки разрешения зависимостей или проблемы подключения к realm — обратитесь к [Руководству по устранению неполадок](troubleshooting.ru.md) для подробных решений и типичных исправлений. +Если вы столкнулись с проблемами во время развёртывания — такими как ошибки установки элемента, ошибки разрешения зависимостей или проблемы подключения к realm — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений. diff --git a/docs/app-developer-guide/index.md b/docs/app-developer-guide/index.md index 2e86c6ab..318ec5ee 100644 --- a/docs/app-developer-guide/index.md +++ b/docs/app-developer-guide/index.md @@ -82,7 +82,7 @@ Install the necessary tools below. Install Exordos CLI: ```bash -curl -fsSL https://repo.exordos.com/install.sh | sudo sh +curl -fsSL https://repo.exordos.com/install.sh | sh ``` The Packer [version 1.9.2](https://hashicorp-releases.yandexcloud.net/packer/1.9.2/) or earlier due to licensing limitation. Download and place into `/usr/local/bin/` or any other directory in your `$PATH`. diff --git a/docs/app-developer-guide/index.ru.md b/docs/app-developer-guide/index.ru.md index dd0e1bb8..b2129e23 100644 --- a/docs/app-developer-guide/index.ru.md +++ b/docs/app-developer-guide/index.ru.md @@ -82,7 +82,7 @@ exordos elements install Установка Exordos CLI: ```bash -curl -fsSL https://repo.exordos.com/install.sh | sudo sh +curl -fsSL https://repo.exordos.com/install.sh | sh ``` Packer [версии 1.9.2](https://hashicorp-releases.yandexcloud.net/packer/1.9.2/) или ранее из-за ограничений лицензирования. Скачайте и поместите в `/usr/local/bin/` или любую другую директорию из вашего `$PATH`. diff --git a/docs/app-developer-guide/init.md b/docs/app-developer-guide/init.md index a7168676..7f0e1d88 100644 --- a/docs/app-developer-guide/init.md +++ b/docs/app-developer-guide/init.md @@ -32,7 +32,7 @@ All other parameters are collected interactively via the wizard. `exordos init` runs as an **interactive wizard** — it guides you through a series of questions and makes decisions based on your answers. You don't need to know the options upfront; the wizard adapts its questions depending on the project type you select. -[Learn more about the wizard →](wizard.md) +[Learn more about the wizard →](../usage/wizard.md) --- @@ -85,4 +85,4 @@ After the wizard finishes, `exordos init` prints a **summary** of everything it ## Troubleshooting -If you encounter issues during initialization — such as project type detection failures, manifest generation errors, or CI/CD configuration problems — refer to the [Troubleshooting Guide](troubleshooting.md) for detailed solutions and common fixes. +If you encounter issues during initialization — such as project type detection failures, manifest generation errors, or CI/CD configuration problems — refer to the [Troubleshooting Guide](../usage/troubleshooting.md) for detailed solutions and common fixes. diff --git a/docs/app-developer-guide/init.ru.md b/docs/app-developer-guide/init.ru.md index 8b111b16..d9fb9fac 100644 --- a/docs/app-developer-guide/init.ru.md +++ b/docs/app-developer-guide/init.ru.md @@ -32,7 +32,7 @@ exordos init [OPTIONS] `exordos init` работает как **интерактивный мастер** — он проводит вас через серию вопросов и принимает решения на основе ваших ответов. Вам не нужно знать опции заранее; мастер адаптирует свои вопросы в зависимости от выбранного типа проекта. -[Подробнее о мастере →](wizard.ru.md) +[Подробнее о мастере →](../usage/wizard.ru.md) --- @@ -85,4 +85,4 @@ exordos init [OPTIONS] ## Устранение неполадок -Если вы столкнулись с проблемами во время инициализации — такими как ошибки определения типа проекта, ошибки генерации манифеста или проблемы конфигурации CI/CD — обратитесь к [Руководству по устранению неполадок](troubleshooting.ru.md) для подробных решений и типичных исправлений. +Если вы столкнулись с проблемами во время инициализации — такими как ошибки определения типа проекта, ошибки генерации манифеста или проблемы конфигурации CI/CD — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений. diff --git a/docs/app-developer-guide/push.md b/docs/app-developer-guide/push.md index 62edc325..12b7a7e2 100644 --- a/docs/app-developer-guide/push.md +++ b/docs/app-developer-guide/push.md @@ -22,7 +22,7 @@ Key options: | `-f, --force` | Force push even if the element already exists | | `-l, --latest` | Also push the element as the `latest` version (for stable versions) | -You can push elements to the [public Exordos Core repository](public-installation.md). Or you can deploy a [private Exordos Core installation](private-installation.md) on your own hardware. For development and testing, you can use [local laptop installation](local-laptop-installation.md). +You can push elements to the [public Exordos Core repository](../usage/public-installation.md). Or you can deploy a [private Exordos Core installation](../usage/private-installation.md) on your own hardware. For development and testing, you can use [local laptop installation](../usage/local-laptop-installation.md). --- @@ -125,4 +125,4 @@ After a successful push, your element is available in the registry and ready for ## Troubleshooting -If you encounter issues while pushing elements — such as repository connection failures, authentication errors, or upload problems — refer to the [Troubleshooting Guide](troubleshooting.md) for detailed solutions and common fixes. +If you encounter issues while pushing elements — such as repository connection failures, authentication errors, or upload problems — refer to the [Troubleshooting Guide](../usage/troubleshooting.md) for detailed solutions and common fixes. diff --git a/docs/app-developer-guide/push.ru.md b/docs/app-developer-guide/push.ru.md index 292ef91a..b7818c8b 100644 --- a/docs/app-developer-guide/push.ru.md +++ b/docs/app-developer-guide/push.ru.md @@ -22,7 +22,7 @@ exordos push [OPTIONS] [PROJECT_DIR] | `-f, --force` | Принудительная отправка, даже если элемент уже существует | | `-l, --latest` | Также отправить элемент как версию `latest` (для стабильных версий) | -Вы можете отправлять элементы в [публичный репозиторий Exordos Core](public-installation.ru.md). Или вы можете развернуть [приватную установку Exordos Core](private-installation.ru.md) на своём оборудовании. Для разработки и тестирования вы можете использовать [установку на локальном ноутбуке](local-laptop-installation.ru.md). +Вы можете отправлять элементы в [публичный репозиторий Exordos Core](../usage/public-installation.ru.md). Или вы можете развернуть [приватную установку Exordos Core](../usage/private-installation.ru.md) на своём оборудовании. Для разработки и тестирования вы можете использовать [установку на локальном ноутбуке](../usage/local-laptop-installation.ru.md). --- @@ -125,4 +125,4 @@ exordos push -c exordos.push.yaml ## Устранение неполадок -Если вы столкнулись с проблемами при отправке элементов — такими как ошибки подключения к репозиторию, ошибки аутентификации или проблемы загрузки — обратитесь к [Руководству по устранению неполадок](troubleshooting.ru.md) для подробных решений и типичных исправлений. +Если вы столкнулись с проблемами при отправке элементов — такими как ошибки подключения к репозиторию, ошибки аутентификации или проблемы загрузки — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений. diff --git a/docs/core-developer-guide/index.md b/docs/core-developer-guide/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/core-developer-guide/index.ru.md b/docs/core-developer-guide/index.ru.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/index.md b/docs/index.md index 9b3d408a..22048088 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ Welcome to Exordos Core! ### Linux ```bash -curl -fsSL https://repo.exordos.com/install.sh | sudo sh +curl -fsSL https://repo.exordos.com/install.sh | sh ``` ## 🚀 Application Developer Guide @@ -35,13 +35,13 @@ A guide for developers of the platform core and ecosystem elements — for examp Platform administrator documentation: managing the installation, configuring components, monitoring and maintaining the deployment. -[Go to the guide →](admin-guide/index.md) +[Go to the guide →](./usage/admin-guide.md) ## 🔒 Security Guide Documentation for security engineers. Special focus on IAM and user management, system auditing, access policies, and other information security aspects of the platform. -[Go to the guide →](security-guide/index.md) +[Go to the guide →](./usage/security.md) ## 🌐 Ecosystem diff --git a/docs/index.ru.md b/docs/index.ru.md index 04bce454..7f9b8176 100644 --- a/docs/index.ru.md +++ b/docs/index.ru.md @@ -11,7 +11,7 @@ title: Exordos Core ### Linux ```bash -curl -fsSL https://repo.exordos.com/install.sh | sudo sh +curl -fsSL https://repo.exordos.com/install.sh | sh ``` ## 🚀 Руководство для разработчиков приложений @@ -35,13 +35,13 @@ curl -fsSL https://repo.exordos.com/install.sh | sudo sh Документация для администраторов платформы: установка, настройка компонентов, мониторинг и поддержка развёртывания. -[Перейти к руководству →](admin-guide/index.ru.md) +[Перейти к руководству →](./usage/admin-guide.ru.md) ## 🔒 Руководство по безопасности Документация для инженеров по безопасности. Особое внимание уделяется IAM и управлению пользователями, аудиту системы, политикам доступа и другим аспектам информационной безопасности платформы. -[Перейти к руководству →](security-guide/index.ru.md) +[Перейти к руководству →](./usage/security.ru.md) ## 🌐 Экосистема diff --git a/docs/usage/admin-guide.md b/docs/usage/admin-guide.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/admin-guide.ru.md b/docs/usage/admin-guide.ru.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/local-laptop-installation.md b/docs/usage/local-laptop-installation.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/local-laptop-installation.ru.md b/docs/usage/local-laptop-installation.ru.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/local_deployment.md b/docs/usage/local_deployment.md index 4ee14fea..0542fdf5 100644 --- a/docs/usage/local_deployment.md +++ b/docs/usage/local_deployment.md @@ -11,7 +11,7 @@ It's assumed Linux (Ubuntu) is used as the OS on your machine. Install the Exordos CLI: ```bash -curl -fsSL https://repo.exordos.com/install.sh | sudo sh +curl -fsSL https://repo.exordos.com/install.sh | sh ``` ### Packages diff --git a/docs/usage/local_deployment.ru.md b/docs/usage/local_deployment.ru.md index 0bad97ad..b9519f51 100644 --- a/docs/usage/local_deployment.ru.md +++ b/docs/usage/local_deployment.ru.md @@ -11,7 +11,7 @@ Установите Exordos CLI: ```bash -curl -fsSL https://repo.exordos.com/install.sh | sudo sh +curl -fsSL https://repo.exordos.com/install.sh | sh ``` ### Пакеты diff --git a/docs/usage/private-installation.md b/docs/usage/private-installation.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/private-installation.ru.md b/docs/usage/private-installation.ru.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/public-installation.md b/docs/usage/public-installation.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/public-installation.ru.md b/docs/usage/public-installation.ru.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/security.md b/docs/usage/security.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/security.ru.md b/docs/usage/security.ru.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/troubleshooting.md b/docs/usage/troubleshooting.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/troubleshooting.ru.md b/docs/usage/troubleshooting.ru.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/wizard.md b/docs/usage/wizard.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/wizard.ru.md b/docs/usage/wizard.ru.md new file mode 100644 index 00000000..e69de29b diff --git a/mkdocs.yml b/mkdocs.yml index f41fa29b..08cbb609 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -100,7 +100,12 @@ markdown_extensions: nav: - Software: index.md - - Usage: usage/local_deployment.md + - Usage: + - Local Deployment: usage/local_deployment.md + - Admin Guide: usage/admin-guide.md + - Security Guide: usage/security.md + - Troubleshooting: usage/troubleshooting.md + - Wizard: usage/wizard.md - OpenAPI: - Boot API: openapi/openapi_boot.md - Orch API: openapi/openapi_orch.md