Wiren Board website

Репозиторий содержит в себе контент для сайта https://wirenboard.com.

Инструкции по редактированию контента:

• Описание синтаксиса;
• Произвольные страницы;
• Товары из каталога;
• Партнеры;
• Интеграторы;
• Вакансии;
• Статьи;
• Видео;
• Внедрения.

Онлайн-редактор

Если вам надо добавить интегратора или внести небольшие исправления в существующие страницы, это удобно делать через веб-интерфейс Github. Документация на английском:

• управление файлами;
• создание и удаление веток;
• создание пуллреквестов.

Общий алгоритм такой:

1. Вносите изменения: правите файлы или добавляете новые.
2. Сохраняете их с помощью кнопок Commit changes… в отдельную веточку, например, feature/added-setpoint или bugfix/fix-bcs-description.
3. Как всё будет готово, создаёте пуллреквест и заполняете форму, выбираете ревьювером matveevrj (замещает aadegtyarev). Создать пуллреквест можно сразу при сохранении изменений в каком-либо файле или на странице Pull requests.
4. Отправляете пуллреквест на ревью и ждёте обратную связь от коллег.
5. Если есть, что поправить, коллеги оставят комментарии. Когда по мнению коллег всё будет хорошо, они одобряют правки (аппрувят, approve).
6. Вы вливаете изменения (мержите, Merge) через кнопку Squash and merge. Если комментарий при вливании будет большой и непонятный — перепишите его.

Деплой в продакшн. После вливания изменений сайт будет собран и опубликован по адресу https://wirenboard.com. Следить за процессом сборки можно в разделе Actions.

Офлайн редактор

Предполагается, что у вас установлен Git, редактор VSCode с плагином подсветки компонентов Nuxt и вы умеете этим пользоваться. В VSCode есть простой предпросмотр, но для сложных изменений рекомендуем запускать сайт локально и смотреть страницу целиком с учётом вставленных изображений, компонентов и т.п.

Сам процесс создания новых веток, PR и прочего описан в документе Процесс разработки проектов Wiren Board с использованием Git.

Деплой в продакшн. После вливания изменений (мержа, merge) сайт будет собран и опубликован по адресу https://wirenboard.com. Следить за процессом сборки можно в разделе Actions.

Как запустить сайт локально

Запуск сайта в браузере позволит вам видеть все внесенные изменения в реальном времени — страница будет обновляться после каждого сохранения файла. Для этого выполните следующие шаги:

• Клонируйте этот репозиторий:

  git clone https://github.com/wirenboard/website.git
  

Эта команда создаст папку website с сайтом, склонированным из репозитория в GitHub.

• Установите NodeJS. Скачайте и установите NodeJS для вашей операционной системы.
• Установите пакетный менеджер pnpm. В процессе установки подвтерждайте предложенные варианты.
• Перейдите в корневую директорию проекта и выполните команду:

  cd website

Используйте вместо website другую директорию, если вы намеренно указали её при клонировании проекта.

• Установите зависимости проекта. Это создаёт необходимую среду для запуска сайта.

  pnpm install

• Запустите локальный сервер, выполнив команду:

  pnpm run dev

Сайт будет доступен в браузере по адресу http://localhost:3000. Не забудьте ввести в адресную строку url просматриваемой страницы, например http://localhost:3000/ru/contents/articles.

Отображаться будет только контент, без остального содержимого сайта (навигации, футера и пр.).

Чтобы посмотреть, какой версии в github соответствует текущая версия сайта, можно использовать адрес http://localhost:3000/version.txt. Это также будет работать, если сайт развёрнут целиком, как на https://wirenboard.com : https://wirenboard.com/version.txt.

По этому адресу будет доступен такой текстовый файл:

Base version: unknown
External version: main@d9faf525

В данном примере main@d9faf525 — это версия сайта, которая соответствует текущему состоянию в репозитории. main - ветка, d9faf525 - хэш коммита.

Как посмотреть изменения из PR локально

1. Обновите локальный main

   git checkout main
   git pull origin main

2. Загрузите PR (замените <номер> на номер нужного вам PR)

   git fetch origin pull/<номер>/head:pr-<номер>
   git checkout pr-<номер>

3. Проверьте изменения

• Запустите локальный сервер

  pnpm run dev

• Посмотрите, как работает внесённое изменение используя локальный url по типу http://localhost:3000/version.txt.