Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ninedev-i committed Aug 7, 2024
1 parent 36fdbee commit bfd70d9
Show file tree
Hide file tree
Showing 13 changed files with 16 additions and 11 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,13 @@

- [Как добавить партнера](./doc/partners.md);
- [Как добавить интегратора](./doc/integrators.md);
- [Как добавить вакансию](doc/vacancies);
- [Как добавить вакансию](./doc/jobs.md);
- [Как добавить ссылку на статью](./doc/articles.md);
- [Дополнительные компоненты](./doc/components.md).

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


- Клонируйте этот репозиторий:
```
https://github.com/wirenboard/website.git
Expand All @@ -41,4 +40,4 @@

1. Создайте пул реквест в ветку main вашего репозитория.
2. Пройдите процесс ревью и смержьте изменения.
3. После успешной сборки изменения будут доступны по адресу https://wirenboard.com.
3. После успешной сборки изменения будут доступны по адресу https://wirenboard.com.
2 changes: 1 addition & 1 deletion common/article_categories.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export const categories: Categories = {
]
},
{ name: 'hardware_selection', label: 'Подбор оборудования' },
{ name: 'educational', label: 'Обучающие ролики', sub_category: [
{ name: 'educational', label: 'Обучающие статьи', sub_category: [
{ name: 'beginners', label: 'Начинающим' },
{ name: 'node_red', label: 'Автоматизация на Node-RED' },
{ name: 'ventilation', label: 'Вентиляция' },
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
9 changes: 6 additions & 3 deletions doc/articles.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Содержимое папки *content/[locale]/_articles* автоматически формирует раздел [Статьи](https://wirenboard.com/ru/pages/articles/).
В локальном предпросмотре страница будет доступна по адресу http://localhost:3000/ru/pages/articles.

Внутри есть 4 раздела с подразделами:
- eductational (Обучающие ролики)
- eductational (Обучающие статьи)
- 3rd_party_devices (Подключение сторонних устройств)
- begginers (Начинающим)
- electrics (Электрика)
Expand All @@ -17,9 +19,10 @@
- home_automation (Домашняя автоматизация)
- retail (Ритейл, рестораны и отели)
- tsod (ЦОД)

Редактировать существующие и добавлять новые категории можно в файле [article_categories](../common/article_categories.ts).

Для того чтобы добавить новую статью в один из разделах, просто создайте в необходимом разделе директории *content/[locale]/_articles* файл с разрешением **.md**,
Для того чтобы добавить новую статью в один из разделов, просто создайте в необходимом разделе директории *content/[locale]/_articles* файл с разрешением **.md**,
и дайте ему осмысленное название, чтобы было удобнее ориентироваться в будущем. Содержимое файла следующее:
```
---
Expand All @@ -31,4 +34,4 @@ category: Раздел (выше есть список разделов, нап
---
```

Не забудьте добавить обложку статьи в дирекорию `public/img/articles` с именем идентисным именованию файла статьи. Желательно чтобы картинка не была шириной выше 500 пикселей.
Не забудьте добавить обложку статьи в директорию `public/img/articles` с именем идентисным именованию файла статьи. Желательно чтобы картинка не была шириной выше 500 пикселей.
3 changes: 2 additions & 1 deletion doc/integrators.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Содержимое папки *content/[locale]/_integrators* автоматически формирует раздел [Интеграторы](https://wirenboard.com/ru/pages/integrators/).
В локальном предпросмотре страница будет доступна по адресу http://localhost:3000/ru/pages/integrators.

Для того чтобы добавить нового интегратора, просто создайте файл с разрешением **.md**,
и дайте ему осмысленное название, чтобы было удобнее ориентироваться в будущем.
Expand All @@ -18,5 +19,5 @@ email: Контактный e-mail
А здесь описание в формате md разметки.
```

Не забудьте добавить логотип в дирекорию public/img/integrators.
Не забудьте добавить логотип в директорию public/img/integrators.
При необходимости продублируйте перевод на английский язык по тому же пути в папке *en*.
3 changes: 2 additions & 1 deletion doc/vacancies.md → doc/jobs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Файл [index.md](../content/ru/jobs/index.md) описывает контент страницы [Работа в Wirenboard](https://wirenboard.com/ru/pages/jobs/).

Содержимое папки *content/[locale]/jobs/_vacancies* автоматически формирует список доступных вакансий.
Содержимое папки *content/[locale]/jobs/_includes* автоматически формирует список доступных вакансий.
В локальном предпросмотре страница будет доступна по адресу http://localhost:3000/ru/pages/jobs.

Для того чтобы добавить новую вакансию, просто создайте файл с разрешением **.md** в папке *vacancies*,
и дайте ему осмысленное название, чтобы было удобнее ориентироваться в будущем.
Expand Down
3 changes: 2 additions & 1 deletion doc/partners.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Содержимое папки *content/[locale]/_partners* автоматически формирует раздел [Партнеры](https://wirenboard.com/ru/pages/partners/).
В локальном предпросмотре страница будет доступна по адресу http://localhost:3000/ru/pages/partners.

Для того чтобы добавить нового партнера, просто создайте файл с разрешением **.md**,
и дайте ему осмысленное название, чтобы было удобнее ориентироваться в будущем.
Expand All @@ -17,5 +18,5 @@ email: Контактный e-mail
```

Не забудьте добавить логотип в дирекорию public/img/partners.
Не забудьте добавить логотип в директорию public/img/partners.
При необходимости продублируйте перевод на английский язык по тому же пути в папке *en*.
2 changes: 1 addition & 1 deletion pages/pages/jobs.vue
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const data = await useLocalizedData('jobs');
useContentHead(data);
const query: QueryBuilderParams = { path: '/jobs/_vacancies', where: [{ actual: true, _locale: locale.value }] }
const query: QueryBuilderParams = { path: '/jobs/_includes', where: [{ actual: true, _locale: locale.value }] }
</script>

<template>
Expand Down

0 comments on commit bfd70d9

Please sign in to comment.