Skip to content

Commit 88e3036

Browse files
committed
docs(usage): add platform overview, licensing, admin guide and support lifecycle pages
- Add platform-overview, licensing, admin-guide, support-lifecycle documentation in English and Russian - Add build_docs.sh script to build docs artifacts via tox - Register exordos_docs manifest and artifact in exordos.yaml - Update mkdocs.yml navigation with new usage sections Signed-off-by: Anton Kremenetsky <anton.kremenetsky@gmail.com>
1 parent ef31e66 commit 88e3036

58 files changed

Lines changed: 1550 additions & 90 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
icon: lucide/package-open
23
title: Application Developer Guide
34
---
45

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
icon: lucide/package-open
23
title: Руководство для разработчиков приложений
34
---
45

@@ -16,7 +17,7 @@ exordos init
1617

1718
После завершения работы мастера ваш проект будет содержать необходимые конфигурационные файлы — включая манифесты — которые описывают ваш элемент для платформы.
1819

19-
[Подробнее →](init.ru.md)
20+
[Подробнее →](init.md)
2021

2122
---
2223

@@ -30,7 +31,7 @@ exordos build
3031

3132
При успехе результат сборки (образ контейнера, бинарный файл или другой тип артефакта) сохраняется локально и помечается текущей версией элемента.
3233

33-
[Подробнее →](build.ru.md)
34+
[Подробнее →](build.md)
3435

3536
---
3637

@@ -44,7 +45,7 @@ exordos push
4445

4546
Элемент версионируется и отправляется в настроенный репозиторий на основе метаданных в `exordos.yaml`.
4647

47-
[Подробнее →](push.ru.md)
48+
[Подробнее →](push.md)
4849

4950
---
5051

@@ -58,7 +59,7 @@ exordos elements install <element-name>
5859

5960
Платформа разрешает зависимости, устанавливает целевой элемент и запускает его в выбранном окружении.
6061

61-
[Подробнее →](deploy.ru.md)
62+
[Подробнее →](deploy.md)
6263

6364
---
6465

@@ -75,7 +76,7 @@ exordos elements install <element-name>
7576
**Exordos** — вы можете использовать:
7677

7778
- **Публичную установку Exordos** — размещённую на [exordos.com](https://exordos.com). Не требуется настройка; просто создайте аккаунт и начните использовать платформу.
78-
- **Приватную установку Exordos** — ваш собственный self-hosted экземпляр. Этот документ описывает, как его настроить: [Локальное развёртывание](../usage/local_deployment.ru.md).
79+
- **Приватную установку Exordos** — ваш собственный self-hosted экземпляр. Этот документ описывает, как его настроить: [Локальное развёртывание](../usage/local_deployment.md).
7980

8081
Установите необходимые инструменты ниже.
8182

@@ -159,6 +160,6 @@ ToDo API теперь доступен по настроенной конечн
159160

160161
Когда вы освоитесь с основами, изучите более углублённые темы ниже.
161162

162-
- [Написание манифеста с нуля](../em/manifest.ru.md) — изучите полную спецификацию манифеста и создайте его вручную без помощи мастера `exordos init`.
163-
- [Настройка приватной установки платформы](../usage/local_deployment.ru.md) — разверните собственный экземпляр Exordos Core для разработки и тестирования ваших элементов end-to-end без подключения к удалённому окружению.
163+
- [Написание манифеста с нуля](../em/manifest.md) — изучите полную спецификацию манифеста и создайте его вручную без помощи мастера `exordos init`.
164+
- [Настройка приватной установки платформы](../usage/local_deployment.md) — разверните собственный экземпляр Exordos Core для разработки и тестирования ваших элементов end-to-end без подключения к удалённому окружению.
164165
- [Публичная установка Exordos](https://exordos.com) — используйте размещённую Exordos-платформу без управления собственной инфраструктурой.

docs/app-developer-guide/build.ru.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ fi
222222
exordos build --manifest-var environment=production --manifest-var region=europe-east .
223223
```
224224

225-
[Полный справочник по манифестам →](../em/manifest.ru.md)
225+
[Полный справочник по манифестам →](../em/manifest.md)
226226

227227
---
228228

@@ -259,11 +259,11 @@ output/
259259

260260
После успешной сборки ваши элементы готовы для:
261261

262-
- [`exordos push`](push.ru.md) — публикация в реестр экосистемы
263-
- [`exordos deploy`](deploy.ru.md) — развёртывание в установку Exordos
262+
- [`exordos push`](push.md) — публикация в реестр экосистемы
263+
- [`exordos deploy`](deploy.md) — развёртывание в установку Exordos
264264

265265
---
266266

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

269-
Если вы столкнулись с проблемами в процессе сборки — такими как ошибки разрешения зависимостей, ошибки сборки образов VM или проблемы обработки манифестов — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
269+
Если вы столкнулись с проблемами в процессе сборки — такими как ошибки разрешения зависимостей, ошибки сборки образов VM или проблемы обработки манифестов — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.md) для подробных решений и типичных исправлений.

docs/app-developer-guide/deploy.ru.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ exordos elements install [OPTIONS] PATH_OR_NAME
1717
| `-r, --repository TEXT` | Конечная точка репозитория, где хранится элемент [по умолчанию](https://repo.exordos.com/exordos-elements/) |
1818
| `PATH_OR_NAME` | Путь к локальному файлу манифеста или имя элемента в репозитории |
1919

20-
Вы можете устанавливать элементы на [публичную установку Exordos Core](../usage/public-installation.ru.md). Или вы можете развернуть [приватную установку Exordos Core](../usage/private-installation.ru.md) на своём оборудовании. Для разработки и тестирования вы можете использовать [установку на локальном ноутбуке](../usage/local_deployment.ru.md).
20+
Вы можете устанавливать элементы на [публичную установку Exordos Core](../usage/public-installation.md). Или вы можете развернуть [приватную установку Exordos Core](../usage/private-installation.md) на своём оборудовании. Для разработки и тестирования вы можете использовать [установку на локальном ноутбуке](../usage/local_deployment.md).
2121

2222
---
2323

@@ -72,11 +72,11 @@ exordos elements install -r https://my-repo.example.com/elements/ my-element
7272
После успешной установки:
7373

7474
- Проверьте статус элемента в Exordos Core CLI
75-
- [Настройте манифест](../em/manifest.ru.md) для адаптации конфигурации элемента под ваши нужды
76-
- [Обновите элемент](../usage/admin-guide.ru.md) когда доступна новая версия
75+
- [Настройте манифест](../em/manifest.md) для адаптации конфигурации элемента под ваши нужды
76+
- [Обновите элемент](../usage/admin-guide.md) когда доступна новая версия
7777

7878
---
7979

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

82-
Если вы столкнулись с проблемами во время развёртывания — такими как ошибки установки элемента, ошибки разрешения зависимостей или проблемы подключения к realm — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
82+
Если вы столкнулись с проблемами во время развёртывания — такими как ошибки установки элемента, ошибки разрешения зависимостей или проблемы подключения к realm — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.md) для подробных решений и типичных исправлений.

docs/app-developer-guide/init.ru.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ exordos init [OPTIONS]
3232

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

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

3737
---
3838

@@ -64,7 +64,7 @@ exordos init [OPTIONS]
6464

6565
Сгенерированный манифест — это отправная точка. Вы можете отредактировать его вручную в любое время.
6666

67-
[Полный справочник по манифестам →](../em/manifest.ru.md)
67+
[Полный справочник по манифестам →](../em/manifest.md)
6868

6969
---
7070

@@ -85,4 +85,4 @@ exordos init [OPTIONS]
8585

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

88-
Если вы столкнулись с проблемами во время инициализации — такими как ошибки определения типа проекта, ошибки генерации манифеста или проблемы конфигурации CI/CD — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
88+
Если вы столкнулись с проблемами во время инициализации — такими как ошибки определения типа проекта, ошибки генерации манифеста или проблемы конфигурации CI/CD — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.md) для подробных решений и типичных исправлений.

docs/app-developer-guide/push.ru.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ exordos push [OPTIONS] [PROJECT_DIR]
2222
| `-f, --force` | Принудительная отправка, даже если элемент уже существует |
2323
| `-l, --latest` | Также отправить элемент как версию `latest` (для стабильных версий) |
2424

25-
Вы можете отправлять элементы в [публичный репозиторий Exordos Core](../usage/public-installation.ru.md). Или вы можете развернуть [приватную установку Exordos Core](../usage/private-installation.ru.md) на своём оборудовании. Для разработки и тестирования вы можете использовать [установку на локальном ноутбуке](../usage/local-laptop-installation.ru.md).
25+
Вы можете отправлять элементы в [публичный репозиторий Exordos Core](../usage/public-installation.md). Или вы можете развернуть [приватную установку Exordos Core](../usage/private-installation.md) на своём оборудовании. Для разработки и тестирования вы можете использовать [установку на локальном ноутбуке](../usage/local-laptop-installation.md).
2626

2727
---
2828

@@ -118,11 +118,11 @@ exordos push -c exordos.push.yaml
118118

119119
После успешной отправки ваш элемент доступен в реестре и готов для:
120120

121-
- [`exordos deploy`](deploy.ru.md) — развёртывание элемента в установку Exordos
121+
- [`exordos deploy`](deploy.md) — развёртывание элемента в установку Exordos
122122
- Совместного использования с другими разработчиками в вашей организации
123123

124124
---
125125

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

128-
Если вы столкнулись с проблемами при отправке элементов — такими как ошибки подключения к репозиторию, ошибки аутентификации или проблемы загрузки — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
128+
Если вы столкнулись с проблемами при отправке элементов — такими как ошибки подключения к репозиторию, ошибки аутентификации или проблемы загрузки — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.md) для подробных решений и типичных исправлений.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2+
icon: lucide/cpu
23
title: Core Developer Guide
34
---
45

56
This guide describes the internal architecture of Exordos Core: how elements, manifests, and resources are
67
stored and reconciled onto compute nodes. It's aimed at people working on Exordos Core itself. If you want
78
to build an element on top of the platform instead, see the
8-
[Application Developer Guide](../app-developer-guide/index.md).
9+
[Application Developer Guide](../app-developer-guide/app-guide.md).
910

1011
## Elements, manifests, and resources
1112

docs/core-developer-guide/index.ru.md renamed to docs/core-developer-guide/core-guide.ru.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2+
icon: lucide/cpu
23
title: Руководство для разработчиков ядра
34
---
45

56
Это руководство описывает внутреннюю архитектуру Exordos Core: как элементы, манифесты и ресурсы
67
хранятся и приводятся в соответствие (reconcile) на вычислительных нодах. Оно предназначено для тех, кто
78
работает над самим Exordos Core. Если вы хотите разработать элемент поверх платформы, см.
8-
[Руководство для разработчиков приложений](../app-developer-guide/index.ru.md).
9+
[Руководство для разработчиков приложений](../app-developer-guide/app-guide.md).
910

1011
## Элементы, манифесты и ресурсы
1112

@@ -64,7 +65,7 @@ Reconciliation выполняет `ElementManagerBuilder` (`elements/services/bu
6465

6566
Автор манифеста, забывший префикс `f"`, не получает молча пустое значение — буквальный текст `{$...}`
6667
остаётся в результирующем выводе, где бы это значение ни оказалось (в конфигурационном файле, в командной
67-
строке сервиса и т.д.). См. [Диагностику проблем](../usage/troubleshooting.ru.md) — там описаны симптомы,
68+
строке сервиса и т.д.). См. [Диагностику проблем](../usage/troubleshooting.md) — там описаны симптомы,
6869
к которым это приводит.
6970

7071
## Основные типы ресурсов ядра
@@ -73,11 +74,11 @@ Reconciliation выполняет `ElementManagerBuilder` (`elements/services/bu
7374
- `$core.em.services` — systemd-сервисы на ноде или группе нод
7475
- `$core.vs.variables` — Variable Store, используется для платформенных значений по умолчанию
7576
- `$core.config.configs` — файлы, доставляемые на ноду; требует `project_id` и `body.kind`, см.
76-
[Диагностику проблем](../usage/troubleshooting.ru.md)
77+
[Диагностику проблем](../usage/troubleshooting.md)
7778

7879
## См. также
7980

80-
- [Справочник по манифесту](../em/manifest.ru.md)
81+
- [Справочник по манифесту](../em/manifest.md)
8182
- [Service as a Service API](../em/service.md)
82-
- [Repo Proxy](./repo-proxy.ru.md)
83-
- [Диагностика проблем](../usage/troubleshooting.ru.md)
83+
- [Repo Proxy](./repo-proxy.md)
84+
- [Диагностика проблем](../usage/troubleshooting.md)

docs/core-developer-guide/repo-proxy.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
icon: lucide/git-fork
23
title: Repo Proxy
34
---
45

@@ -540,6 +541,6 @@ graph TB
540541

541542
## See also
542543

543-
- [Core Developer Guide](index.md) — architecture overview, element engine, reconciliation
544+
- [Core Developer Guide](core-guide.md) — architecture overview, element engine, reconciliation
544545
- [Exports reference](exports.md) — how elements share resources
545546
- [Manifest reference](../em/manifest.md) — manifest YAML specification

docs/core-developer-guide/repo-proxy.ru.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
icon: lucide/git-fork
23
title: Repo Proxy
34
---
45

@@ -243,7 +244,7 @@ class AbstractProxyRepoDriver(abc.ABC):
243244
перебирает инвентарь и сохраняет элементы. В режиме `copy` каждый элемент
244245
актуализируется (полная загрузка данных). В режиме `lazy` сохраняется только
245246
имя/версия. Устанавливает статус `ACTIVE` и планирует `next_refresh`.
246-
- **`_check_refresh`** — запускается каждые 10 итераций
247+
- **`refresh`** — запускается каждые 10 итераций
247248
(`REFRESH_CHECK_ITERATION_INTERVAL`). Для каждого репозитория, у которого
248249
`next_refresh` прошёл, вызывает `repo.update(force=True)` для запуска хука
249250
обновления.
@@ -544,5 +545,5 @@ graph TB
544545

545546
## См. также
546547

547-
- [Руководство для разработчиков ядра](index.ru.md) — обзор архитектуры, element engine, reconciliation
548-
- [Справочник по манифесту](../em/manifest.ru.md) — спецификация YAML-манифеста
548+
- [Руководство для разработчиков ядра](core-guide.md) — обзор архитектуры, element engine, reconciliation
549+
- [Справочник по манифесту](../em/manifest.md) — спецификация YAML-манифеста

0 commit comments

Comments
 (0)