1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-25 02:42:28 +02:00

Правки документации

This commit is contained in:
Anton 2024-03-10 22:31:37 +03:00
parent 58689477e1
commit a8e9b340ff
4 changed files with 14 additions and 5 deletions

View File

@ -7,7 +7,7 @@ sidebar_position: 1
![OPI](../static/img/logo_long.png) ![OPI](../static/img/logo_long.png)
**Открытый пакет интеграций** - набор библиотек для интеграции с некоторыми популярными API для 1C:Enterprise. Он состоит из общих модулей, каждый из которых отвечает за свой API, а также нескольких модулей-инструментов, общих для всех. **Открытый пакет интеграций** - набор библиотек для интеграции с некоторыми популярными API для 1C:Enterprise и OneScript. Он состоит из общих модулей, каждый из которых отвечает за свой API, а также нескольких модулей-инструментов, общих для всех.
Реализованные методы выполняют конечные задачи (вроде *ОтправитьСообщение()* или *СоздатьПост()*), что позволяет использовать их без углубления в реализацию. Однако, код, при этом, достаточно сильно декомпозирован - методы авторизации, получения данных и пр. по возможности вынесены в отдельные функции. Это позволяет легко добавлять новые методы, даже если они еще не реализованы в самой библиотеке на текущий момент. Реализованные методы выполняют конечные задачи (вроде *ОтправитьСообщение()* или *СоздатьПост()*), что позволяет использовать их без углубления в реализацию. Однако, код, при этом, достаточно сильно декомпозирован - методы авторизации, получения данных и пр. по возможности вынесены в отдельные функции. Это позволяет легко добавлять новые методы, даже если они еще не реализованы в самой библиотеке на текущий момент.
@ -22,7 +22,7 @@ sidebar_position: 1
## Начало работы ## Начало работы
Для начала работы с ОПИ необходимо добавить его в свою конфигурацию. Так как весь проект представляет из себя общие модули, сделать это можно несколькими способами: Для начала работы с ОПИ в 1С необходимо добавить его в свою конфигурацию. Так как весь проект представляет из себя общие модули, сделать это можно несколькими способами:
- Подключением расширения - Подключением расширения
- Добавлением модулей под загрукзу XML/EDT - Добавлением модулей под загрукзу XML/EDT
@ -30,6 +30,15 @@ sidebar_position: 1
Вне зависимости от выбранного сопособа установки, получать файлы необходимо из [Release](https://github.com/Bayselonarrend/OpenIntegrations/releases), так как в самих файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки. Вне зависимости от выбранного сопособа установки, получать файлы необходимо из [Release](https://github.com/Bayselonarrend/OpenIntegrations/releases), так как в самих файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки.
<br/>
Для начала работы в OneScript необходимо скачать ospx файл из последнего доступного релиза, после чего выполнить Bash/CMD команду
```
opm install ./OInt-1.0.0.ospx
```
## Структура модулей ## Структура модулей

View File

@ -9,7 +9,7 @@ import {themes as prismThemes} from 'prism-react-renderer';
/** @type {import('@docusaurus/types').Config} */ /** @type {import('@docusaurus/types').Config} */
const config = { const config = {
title: 'Открытый Пакет Интеграций', title: 'Открытый Пакет Интеграций',
tagline: 'Набор библиотек для интеграции с популярными API на 1C:Enterprise', tagline: 'Набор библиотек интеграции с популярными API для 1C:Enterprise и OneScript',
favicon: 'img/favicon.ico', favicon: 'img/favicon.ico',
// Set the production url of your site here // Set the production url of your site here

View File

@ -17,7 +17,7 @@ const FeatureList = [
Svg: require('@site/static/img/delivery.svg').default, Svg: require('@site/static/img/delivery.svg').default,
description: ( description: (
<> <>
ОПИ состоит только лишь из общих модулей, а значить его легко интегрировать в любой проект: в виде bsl для EDT, как расширение или даже просто скопировав руками содержимое в заранее созданные модули в Конфигураторе ОПИ состоит только лишь из модулей с кодом, а значит его легко интегрировать в любой проект: в виде bsl для EDT, как расширение или даже скопировав руками содержимое в модули ИБ. Для OneScript в каждом релизе есть ospx файл пакета.
</> </>
), ),
}, },

View File

@ -43,7 +43,7 @@ export default function Home() {
return ( return (
<Layout <Layout
title={`Открытый пакет интеграций`} title={`Открытый пакет интеграций`}
description="ОПИ - пакет интеграций с популярными API для 1С:Enterprise"> description="ОПИ - пакет интеграций с популярными API для 1С:Enterprise и OneScript">
<HomepageHeader /> <HomepageHeader />
<main> <main>
<HomepageFeatures /> <HomepageFeatures />