Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
markdownlint-cli2 --config .markdownlint.yaml "**/*.md" "#node_modules" "#!.venv" "#!.tox" --fix
Comment thread
slashburygin marked this conversation as resolved.
2 changes: 1 addition & 1 deletion docs/app-developer-guide/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/app-developer-guide/build.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,4 +266,4 @@ output/

## Устранение неполадок

Если вы столкнулись с проблемами в процессе сборки — такими как ошибки разрешения зависимостей, ошибки сборки образов VM или проблемы обработки манифестов — обратитесь к [Руководству по устранению неполадок](troubleshooting.ru.md) для подробных решений и типичных исправлений.
Если вы столкнулись с проблемами в процессе сборки — такими как ошибки разрешения зависимостей, ошибки сборки образов VM или проблемы обработки манифестов — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
14 changes: 7 additions & 7 deletions docs/app-developer-guide/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Comment thread
slashburygin marked this conversation as resolved.

---

Expand Down Expand Up @@ -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.
14 changes: 7 additions & 7 deletions docs/app-developer-guide/deploy.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

---

Expand Down Expand Up @@ -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) для подробных решений и типичных исправлений.
2 changes: 1 addition & 1 deletion docs/app-developer-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion docs/app-developer-guide/index.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ exordos elements install <element-name>
Установка 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`.
Expand Down
4 changes: 2 additions & 2 deletions docs/app-developer-guide/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---

Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/app-developer-guide/init.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ exordos init [OPTIONS]

`exordos init` работает как **интерактивный мастер** — он проводит вас через серию вопросов и принимает решения на основе ваших ответов. Вам не нужно знать опции заранее; мастер адаптирует свои вопросы в зависимости от выбранного типа проекта.

[Подробнее о мастере →](wizard.ru.md)
[Подробнее о мастере →](../usage/wizard.ru.md)

---

Expand Down Expand Up @@ -85,4 +85,4 @@ exordos init [OPTIONS]

## Устранение неполадок

Если вы столкнулись с проблемами во время инициализации — такими как ошибки определения типа проекта, ошибки генерации манифеста или проблемы конфигурации CI/CD — обратитесь к [Руководству по устранению неполадок](troubleshooting.ru.md) для подробных решений и типичных исправлений.
Если вы столкнулись с проблемами во время инициализации — такими как ошибки определения типа проекта, ошибки генерации манифеста или проблемы конфигурации CI/CD — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
4 changes: 2 additions & 2 deletions docs/app-developer-guide/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Comment thread
slashburygin marked this conversation as resolved.

---

Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/app-developer-guide/push.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Comment thread
slashburygin marked this conversation as resolved.

---

Expand Down Expand Up @@ -125,4 +125,4 @@ exordos push -c exordos.push.yaml

## Устранение неполадок

Если вы столкнулись с проблемами при отправке элементов — такими как ошибки подключения к репозиторию, ошибки аутентификации или проблемы загрузки — обратитесь к [Руководству по устранению неполадок](troubleshooting.ru.md) для подробных решений и типичных исправлений.
Если вы столкнулись с проблемами при отправке элементов — такими как ошибки подключения к репозиторию, ошибки аутентификации или проблемы загрузки — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
Empty file.
Empty file.
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/index.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

## 🚀 Руководство для разработчиков приложений
Expand All @@ -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)

## 🌐 Экосистема

Expand Down
Empty file added docs/usage/admin-guide.md
Empty file.
Empty file added docs/usage/admin-guide.ru.md
Empty file.
Empty file.
Empty file.
2 changes: 1 addition & 1 deletion docs/usage/local_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment thread
slashburygin marked this conversation as resolved.
```

### Packages
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/local_deployment.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

### Пакеты
Expand Down
Empty file.
Empty file.
Empty file.
Empty file.
Empty file added docs/usage/security.md
Empty file.
Empty file added docs/usage/security.ru.md
Empty file.
Empty file added docs/usage/troubleshooting.md
Empty file.
Empty file.
Empty file added docs/usage/wizard.md
Empty file.
Empty file added docs/usage/wizard.ru.md
Empty file.
7 changes: 6 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment thread
slashburygin marked this conversation as resolved.
- OpenAPI:
- Boot API: openapi/openapi_boot.md
- Orch API: openapi/openapi_orch.md
Expand Down