add readme for editors (#10)

* add readme for editors

README.md

@@ -1,39 +1,42 @@
-# Wirenboard website
-
-Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
-
-## Setup
-
-Make sure to install the dependencies:
-
-```bash
-# pnpm
-pnpm install
-```
-
-## Development Server
-
-Start the development server on `http://localhost:3000`:
-
-```bash
-# pnpm
-pnpm run dev
-```
-
-## Production
-
-Build the application for production:
-
-```bash
-# pnpm
-pnpm run build
-```
-
-Locally preview production build:
-
-```bash
-# pnpm
-pnpm run preview
-```
-
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+# Wiren Board website
+Данный репозиторий содержит в себе контент для сайта https://wirenboard.com.
+
+## Инструкции редакторам
+Для работы с md файлами локально можно использовать [плагин](https://marketplace.visualstudio.com/items?itemName=Nuxt.mdc) для VSCode.
+Это позволит вам предварительно просматривать контент прямо в редакторе. Однако для более точного представления конечного вида контента рекомендуется запускать сайт локально. Ниже приведены инструкции по запуску сайта.
+
+- [Как добавить партнера](./content/ru/_partners/software/.README.md);
+- [Как добавить интегратора](./content/ru/_partners/integrator/.README.md);
+- [Как добавить вакансию](./content/ru/jobs/.README.md);
+- [Как добавить ссылку на статью](./content/ru/_articles/.README.md);
+- [Дополнительные компоненты](./doc/components.md).
+
+## Как запустить сайт локально
+Запуск сайта в браузере позволит вам видеть все внесенные изменения в реальном времени — страница будет обновляться после каждого сохранения файла. Для этого выполните следующие шаги:
+
+- Клонируйте этот репозиторий:
+  ```
+  https://github.com/wirenboard/website.git
+  ```
+- Установите NodeJS. Скачайте и установите [NodeJS](https://nodejs.org/en/download/prebuilt-installer) для вашей операционной системы.
+- Установите пакетный менеджер [pnpm](https://pnpm.io/installation). В процессе установки подвтерждайте предложенные варианты.
+- Установите зависимости проекта. Перейдите в корневую директорию проекта и выполните команду:
+    ```bash
+    pnpm install
+    ```
+- Запустите локальный сервер, выполнив команду:
+    ```bash
+    pnpm run dev
+    ```
+
+Просмотр будет доступен в браузере по адресу `http://localhost:3000`. Не забудьте ввести в адресную строку url редактируемой страницы, например `http://localhost:3000/ru/pages/articles`.
+Отображаться будет только контент, без остального содержимого сайта (навигации, футера и пр.).
+
+![Пример страницы](doc/example.png)
+## Деплой в продакшен
+
+Для деплоя изменений на продакшен выполните следующие шаги:
+
+1. Создайте пул реквест в ветку main вашего репозитория.
+2. Пройдите процесс ревью и смержьте изменения.
+3. После успешной сборки изменения будут доступны по адресу https://wirenboard.com.

content/ru/_articles/.README.md

@@ -0,0 +1,33 @@
+Содержимое папки *_articles* автоматически формирует раздел [Статьи](https://wirenboard.com/ru/pages/articles/).
+Внутри есть 4 раздела с подразделами:
+- eductational (Обучающие ролики)
+  - 3rd_party_devices (Подключение сторонних устройств)
+  - begginers (Начинающим)
+  - electrics (Электрика)
+  - heating (Отопление)
+  - integrations (Интеграция со сторонним ПО)
+  - node_red (Автоматизация на Node-RED)
+  - ventilation (Вентиляция)
+- hardware_selection (Подбор оборудования)
+- manufactoring (О производстве и процессах)
+- user_experience (Опыт пользователей)
+  - apartments (Многоквартирные дома и ЖК)
+  - business_objects (Бизнес-объекты)
+  - embedded (Встраиваемые системы и метеостанции)
+  - home_automation (Домашняя автоматизация)
+  - retail (Ритейл, рестораны и отели)
+  - tsod (ЦОД)
+Для того чтобы добавить новую статью в один из разделах, просто создайте в необходимом разделе файл с разрешением **.md**,
+и дайте ему осмысленное название, чтобы было удобнее ориентироваться в будущем. Содержимое файла следующее:
+```
+---
+title: Заголовок статьи (чем лаконичнее, тем лучше)
+url: Ссылка на статью
+cover: Путь до обложки статьи внутри папки public (например /img/articles/educational/beginners/dark_room_scenario.jpg)
+date: Дата публикации статьи в формате ISO 8601 (YYYY-MM-DD, например 2023-01-21)
+category: Раздел (выше есть список разделов, например educational)
+sub_category: Подраздел, если есть (например 3rd_party_devices)
+---
+```
+
+Не забудьте добавить обложку статьи в дирекорию public/img/articles. Желательно чтобы картинка не была шириной выше 500 пикселей.

content/ru/_partners/integrator/.README.md

@@ -0,0 +1,22 @@
+Содержимое папки *_partners/integrator* автоматически формирует раздел [Интеграторы](https://wirenboard.com/ru/pages/integrators/).
+
+Для того чтобы добавить нового интегратора, просто создайте файл с разрешением **.md**,
+и дайте ему осмысленное название, чтобы было удобнее ориентироваться в будущем.
+
+Содержимое файла следующее:
+```
+---
+district: Основной регион работы, пишется в квадратных скобках (например [volga]. доступные регионы: moscow, spb, center, volga, ural, by, kg)
+coordinates: Массив координат головного офиса, например ([55.82427415604684, 49.19640453369345])
+title: Название интегратора
+logo: Путь до логотипа (например /img/partners/integrator/iridi.webp)
+phone: Телефонный номер без доп символов и пробелов (например 74993227329)
+website: Сайт, начинается с https:// (https://iridi.com/ru)
+email: Контактный e-mail
+---
+
+А здесь описание в формате md разметки.
+```
+
+Не забудьте добавить логотип в дирекорию public/img/partners.
+При необходимости продублируйте перевод на английский язык по тому же пути в папке *en*.

content/ru/_partners/software/.README.md

@@ -0,0 +1,21 @@
+Содержимое папки *_partners/software* автоматически формирует раздел [Партнеры](https://wirenboard.com/ru/pages/partners/).
+
+Для того чтобы добавить нового партнера, просто создайте файл с разрешением **.md**,
+и дайте ему осмысленное название, чтобы было удобнее ориентироваться в будущем. 
+
+Содержимое файла следующее:
+```
+---
+title: Название интегратора
+logo: Путь до логотипа (например /img/partners/software/iridi.webp)
+phone: Телефонный номер без доп символов и пробелов (например 74993227329)
+website: Сайт, начинается с https:// (https://iridi.com/ru)
+email: Контактный e-mail
+---
+
+А здесь описание в формате md разметки.
+
+```
+
+Не забудьте добавить логотип в дирекорию public/img/partners.
+При необходимости продублируйте перевод на английский язык по тому же пути в папке *en*.

content/ru/jobs/.README.md

@@ -0,0 +1,49 @@
+Файл *index.md* описывает контент страницы [Работа в Wirenboard](https://wirenboard.com/ru/pages/jobs/).
+
+Содержимое папки *_vacancies* автоматически формирует список доступных вакансий.
+
+Для того чтобы добавить новую вакансию, просто создайте файл с разрешением **.md** в папке *vacancies*,
+и дайте ему осмысленное название, чтобы было удобнее ориентироваться в будущем.
+
+Для разметки мы используем mdx разметку, которая может содержать компоненты (в данном случае карточка компонента ::vacancy) и пропсы,
+которые передаются внутрь этих компонентов (#title, #salary...). 
+Также используется соглашение о том, что для формирования список мы используем [Front-matter](https://content.nuxt.com/usage/markdown) — то что в верхней части файла между знаками `---`. 
+
+Содержимое файла следующее:
+```
+---
+actual: true/false (в зависимости от того актуальна ли сейчас данная вакансия)
+---
+
+::vacancy
+
+#title
+Название вакансии (например Инженер-схемотехник)
+
+#salary
+Зарплатная вилка (например 170 000 — 300 000 ₽/мес)
+
+#description
+Базовое описание вакансии
+
+#goals
+Задачи, которые будут стоять перед кандидатом, желательно оформленные списком
+* разрабатывать классный софт;
+* тестировать клевые устройства.
+
+#requirements
+Требования к кандидату
+* высшее техническое образование.
+* опыт работы не менее 3-х лет.
+
+#advantage
+Будет плюсом если кандидат умеет что-то еще:
+* опыт работы с инструкциями;
+* знания о промышленной автоматизации.
+
+#conditions
+Условия, которые мы предоставляем:
+* оформление по ТК РФ;
+* просторный и удобный офис.
+::
+```