You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: docs/app-developer-guide/app-guide.ru.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
---
2
+
icon: lucide/package-open
2
3
title: Руководство для разработчиков приложений
3
4
---
4
5
@@ -16,7 +17,7 @@ exordos init
16
17
17
18
После завершения работы мастера ваш проект будет содержать необходимые конфигурационные файлы — включая манифесты — которые описывают ваш элемент для платформы.
18
19
19
-
[Подробнее →](init.ru.md)
20
+
[Подробнее →](init.md)
20
21
21
22
---
22
23
@@ -30,7 +31,7 @@ exordos build
30
31
31
32
При успехе результат сборки (образ контейнера, бинарный файл или другой тип артефакта) сохраняется локально и помечается текущей версией элемента.
32
33
33
-
[Подробнее →](build.ru.md)
34
+
[Подробнее →](build.md)
34
35
35
36
---
36
37
@@ -44,7 +45,7 @@ exordos push
44
45
45
46
Элемент версионируется и отправляется в настроенный репозиторий на основе метаданных в `exordos.yaml`.
46
47
47
-
[Подробнее →](push.ru.md)
48
+
[Подробнее →](push.md)
48
49
49
50
---
50
51
@@ -58,7 +59,7 @@ exordos elements install <element-name>
58
59
59
60
Платформа разрешает зависимости, устанавливает целевой элемент и запускает его в выбранном окружении.
60
61
61
-
[Подробнее →](deploy.ru.md)
62
+
[Подробнее →](deploy.md)
62
63
63
64
---
64
65
@@ -75,7 +76,7 @@ exordos elements install <element-name>
75
76
**Exordos** — вы можете использовать:
76
77
77
78
-**Публичную установку Exordos** — размещённую на [exordos.com](https://exordos.com). Не требуется настройка; просто создайте аккаунт и начните использовать платформу.
78
-
-**Приватную установку Exordos** — ваш собственный self-hosted экземпляр. Этот документ описывает, как его настроить: [Локальное развёртывание](../usage/local_deployment.ru.md).
79
+
-**Приватную установку Exordos** — ваш собственный self-hosted экземпляр. Этот документ описывает, как его настроить: [Локальное развёртывание](../usage/local_deployment.md).
79
80
80
81
Установите необходимые инструменты ниже.
81
82
@@ -159,6 +160,6 @@ ToDo API теперь доступен по настроенной конечн
159
160
160
161
Когда вы освоитесь с основами, изучите более углублённые темы ниже.
161
162
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 без подключения к удалённому окружению.
164
165
-[Публичная установка Exordos](https://exordos.com) — используйте размещённую Exordos-платформу без управления собственной инфраструктурой.
[Полный справочник по манифестам →](../em/manifest.ru.md)
225
+
[Полный справочник по манифестам →](../em/manifest.md)
226
226
227
227
---
228
228
@@ -259,11 +259,11 @@ output/
259
259
260
260
После успешной сборки ваши элементы готовы для:
261
261
262
-
- [`exordos push`](push.ru.md) — публикация в реестр экосистемы
263
-
- [`exordos deploy`](deploy.ru.md) — развёртывание в установку Exordos
262
+
- [`exordos push`](push.md) — публикация в реестр экосистемы
263
+
- [`exordos deploy`](deploy.md) — развёртывание в установку Exordos
264
264
265
265
---
266
266
267
267
## Устранение неполадок
268
268
269
-
Если вы столкнулись с проблемами в процессе сборки — такими как ошибки разрешения зависимостей, ошибки сборки образов VM или проблемы обработки манифестов — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
269
+
Если вы столкнулись с проблемами в процессе сборки — такими как ошибки разрешения зависимостей, ошибки сборки образов VM или проблемы обработки манифестов — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.md) для подробных решений и типичных исправлений.
Copy file name to clipboardExpand all lines: docs/app-developer-guide/deploy.ru.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ exordos elements install [OPTIONS] PATH_OR_NAME
17
17
|`-r, --repository TEXT`| Конечная точка репозитория, где хранится элемент [по умолчанию](https://repo.exordos.com/exordos-elements/)|
18
18
|`PATH_OR_NAME`| Путь к локальному файлу манифеста или имя элемента в репозитории |
19
19
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).
21
21
22
22
---
23
23
@@ -72,11 +72,11 @@ exordos elements install -r https://my-repo.example.com/elements/ my-element
72
72
После успешной установки:
73
73
74
74
- Проверьте статус элемента в Exordos Core CLI
75
-
-[Настройте манифест](../em/manifest.ru.md) для адаптации конфигурации элемента под ваши нужды
76
-
-[Обновите элемент](../usage/admin-guide.ru.md) когда доступна новая версия
75
+
-[Настройте манифест](../em/manifest.md) для адаптации конфигурации элемента под ваши нужды
76
+
-[Обновите элемент](../usage/admin-guide.md) когда доступна новая версия
77
77
78
78
---
79
79
80
80
## Устранение неполадок
81
81
82
-
Если вы столкнулись с проблемами во время развёртывания — такими как ошибки установки элемента, ошибки разрешения зависимостей или проблемы подключения к realm — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
82
+
Если вы столкнулись с проблемами во время развёртывания — такими как ошибки установки элемента, ошибки разрешения зависимостей или проблемы подключения к realm — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.md) для подробных решений и типичных исправлений.
Copy file name to clipboardExpand all lines: docs/app-developer-guide/init.ru.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ exordos init [OPTIONS]
32
32
33
33
`exordos init` работает как **интерактивный мастер** — он проводит вас через серию вопросов и принимает решения на основе ваших ответов. Вам не нужно знать опции заранее; мастер адаптирует свои вопросы в зависимости от выбранного типа проекта.
34
34
35
-
[Подробнее о мастере →](../usage/wizard.ru.md)
35
+
[Подробнее о мастере →](../usage/wizard.md)
36
36
37
37
---
38
38
@@ -64,7 +64,7 @@ exordos init [OPTIONS]
64
64
65
65
Сгенерированный манифест — это отправная точка. Вы можете отредактировать его вручную в любое время.
66
66
67
-
[Полный справочник по манифестам →](../em/manifest.ru.md)
67
+
[Полный справочник по манифестам →](../em/manifest.md)
68
68
69
69
---
70
70
@@ -85,4 +85,4 @@ exordos init [OPTIONS]
85
85
86
86
## Устранение неполадок
87
87
88
-
Если вы столкнулись с проблемами во время инициализации — такими как ошибки определения типа проекта, ошибки генерации манифеста или проблемы конфигурации CI/CD — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
88
+
Если вы столкнулись с проблемами во время инициализации — такими как ошибки определения типа проекта, ошибки генерации манифеста или проблемы конфигурации CI/CD — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.md) для подробных решений и типичных исправлений.
|`-f, --force`| Принудительная отправка, даже если элемент уже существует |
23
23
|`-l, --latest`| Также отправить элемент как версию `latest` (для стабильных версий) |
24
24
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).
После успешной отправки ваш элемент доступен в реестре и готов для:
120
120
121
-
- [`exordos deploy`](deploy.ru.md) — развёртывание элемента в установку Exordos
121
+
- [`exordos deploy`](deploy.md) — развёртывание элемента в установку Exordos
122
122
- Совместного использования с другими разработчиками в вашей организации
123
123
124
124
---
125
125
126
126
## Устранение неполадок
127
127
128
-
Если вы столкнулись с проблемами при отправке элементов — такими как ошибки подключения к репозиторию, ошибки аутентификации или проблемы загрузки — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.ru.md) для подробных решений и типичных исправлений.
128
+
Если вы столкнулись с проблемами при отправке элементов — такими как ошибки подключения к репозиторию, ошибки аутентификации или проблемы загрузки — обратитесь к [Руководству по устранению неполадок](../usage/troubleshooting.md) для подробных решений и типичных исправлений.
0 commit comments