Загрузка документации#
| Версия | Дата релиза | Документация (zip) |
|---|---|---|
| v.5.58.0 | 16.02.24 | lim_rus_docs_v.5.58.0 |
Документация комплекта поставки#
В данном разделе описывается пакет документации из комплекта поставки LIM. Все документы находятся в папке "/docs" комплекта поставки.
Руководства по эксплуатации#
Нижеперечисленные руководства описывают общие процессы LIM, его архитектуру и развертывание.
Большинство документов представлены в форматах PDF и HTML. Навигация в PDF документе проще, однако в HTML документе удобнее копировать команды. Если отсутствует доступ к сети Интернет, то для HTML документа требуется наличие template_VL.css.
| Документ | Описание |
|---|---|
| LIM_Administrator_Manual_Rus.* | Руководство администратора LUNA Index Module |
| LIM_Installation_Manual_Rus.* | Руководство по ручной установке LIM с использованием Docker-контейнеров. В данном руководстве приведен пример установки сервисов LIM на единый сервер |
| LIM_Upgrade_Manual_Rus.* | Руководство по обновлению LIM с использованием Docker-контейнеров. В данном руководстве приведен пример установки сервисов LIM на единый сервер |
| LIM_Docker_Compose_Example_Rus.* | Руководство по установке LIM с помощью Docker Compose. В данном руководстве приведен пример установки сервисов LIM на единый сервер |
| LIM_Release_Notes_Rus.* | Примечания к выпуску LUNA Index Module |
* PDF и HTML форматы
Справочные руководства#
В настоящее время все справочные руководства доступны только на английском языке в английской поставке.
Нижеперечисленные руководства описывают спецификации OpenAPI для сервисов LIM. Спецификация OpenAPI - единственный документ, предоставляющий актуальную информацию о API сервисов. Спецификация может использоваться:
- Инструментами создания документации для визуализации API.
- Инструментами генерации кода.
Все документы и код, созданные с использованием этой спецификации, могут содержать неточности, и их следует тщательно проверять.
Данные руководства расположены в директории "./docs/ReferenceManuals". В этой директории расположены документы в формате YML и HTML. Документы в формате YML содержат запросы ко всем сервисам LIM. Их можно использовать для автоматической генерации запросов в Postman. Не гарантируется, что все запросы будут импортированы правильно, может потребоваться ручное редактирование. Документы в формате HTML используются для визуализации данных спецификации и могут быть не полными.
Спецификацию OpenAPI можно получить с помощью ресурса "/docs/spec". Заголовок "Accept" должен принимать значение "application/x-yaml".
| Руководство | Описание |
|---|---|
| IndexedMatcherReferenceManual.* | Описание API сервиса Indexed Matcher |
| IndexerReferenceManual.* | Описание API сервиса Indexer |
| IndexManagerReferenceManual.* | Описание API сервиса Index Manager |
* YML и HTML форматы
Руководство для разработчиков#
Для LIM доступно руководство разработчика. Руководство можно найти в директории "./docs/ServiceManuals" английской поставки LIM.