Справка по работе с сайтом Wiren Board

Полезные ссылки

• Описание синтаксиса
• Произвольные страницы
• Партнёры
• Интеграторы
• Вакансии
• Статьи
• Видео
• Готовые решения
• Каталог товаров — не внедрено!

Способы редактирования и предпросмотра

Процесс работы с Git для редакторов и ревьюверов описан в Работа с Pull Request.

Офлайн-редактор (VSCode)

Для постоянной работы:

• Установите VSCode, а также плагины:
  • vscode-mdx-wb-editor-tools,
  • проверку орфографии Code Spell Checker (и поддержку русского Russian - Code Spell Checker) — есть в магазине расширений,
  • утилиты для работы с Git.
• Клонируйте репозиторий и откройте папку в VS Code.

Всю работу с Git удобно выполнять прямо в VScode (статья по теме).

Онлайн-редактирование (GitHub Web)

Для быстрых правок:

1. Откройте файл в репозитории на GitHub.
2. Нажмите «Edit», внесите правки и выберите Commit changes в новую ветку.
3. Несколько изменений по одной задаче делайте в одной ветке — это позволит ревьюверам посмотреть всё сразу не собирая одну ветку из нескольких.
4. Создайте PR прямо из веб-интерфейса.

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

Тяжёлая артиллерия, показывает изменения почти как они будут на сайте в итоге. Тут имеет смысл смотреть дизайн или общие сгенерированные страницы с кучей карточек-ссылок, например, Статьи, Работа и т.п.

Для обычного внесения правок и предпросмотра рекомендуем использовать VSCode.

Как пользоваться

1. Убедитесь, что Node.js и pnpm установлены.
2. В корне проекта:

   pnpm install
   pnpm run dev

3. Откройте браузер по адресу 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 - хэш коммита.