Руководство

Помощь сообщества очень приветствуется! Не переживайте, если у вас мало опыта работы с проектами с открытым исходным кодом или с git — на этой странице приведены рекомендации для начинающих.

Чем я могу помочь?

Прежде всего — спасибо, что хотите помочь этому проекту расти. Есть множество способов внести свой вклад — расскажите друзьям о ham.guide, исправьте найденные грамматические ошибки, уточните устаревшую информацию, переведите страницы на другой язык или даже добавьте новое содержание. На нашей странице Github Issue ищите сообщения, помеченные help wanted, и попробуйте помочь с их решением.

Issues

Если у вас есть предложения, вопросы или вы нашли ошибки, напишите сообщение на нашей странице Github Issue.

Редактирование для начинающих

Если вы нашли грамматическую ошибку, неверную информацию или хотели бы что-то уточнить, выполните следующие шаги:

• Прокрутите до низа страницы, которую хотели бы отредактировать, и нажмите ссылку Редактировать эту страницу. Вы будете перенаправлены на Github, и для отправки изменений вам потребуется создать учётную запись, если её у вас ещё нет.
• После входа нажмите кнопку Fork this repository and propose changes.
• Внесите изменения на страницу и в разделе Propose file change объясните, что и почему вы изменили.
• Нажмите кнопку Propose file change, а затем Create pull request на следующей странице.
• Убедитесь, что ваш pull request имеет подходящий заголовок и описание, и нажмите Create pull request.

Спасибо, что улучшаете ham.guide! Мы рассмотрим ваши изменения, и обновлённую страницу вы увидите после того, как мы подтвердим изменения. Время от времени проверяйте свой pull request — там вы можете найти комментарии и вопросы, связанные с вашими изменениями.

Редактирование для продвинутых

VitePress

Проект создан с использованием VitePress.

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

Windows

В этом случае рекомендую использовать WSL и таким образом установить Git и Node.

MacOS

Установите Git и Node по этим инструкциям (или следуйте похожему руководству, которое можно найти в интернете).

Linux

Используя менеджер пакетов вашего дистрибутива, установите программы Git и Node.

1. Когда установите Git и Node, клонируйте репозиторий ham.guide и создайте новую ветку.

2. Установите необходимые модули

npm install

Чтобы видеть карты, скопируйте .env.example в .env и впишите свой ключ доступа Mapbox в VITE_MAPBOX_TOKEN. Остальная часть сайта работает и без него.

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

npm run dev

Откройте localhost:5173, и вы должны увидеть работающий локально ham.guide.

Структура проекта

.
├── src
│   ├── .vitepress
│   ├── contribute
|   ├── phonetic-alphabet
|   ├── q-code
|   ├── radio-operating-ethics
│   └── ru
│       ├── contribute
│       ├── phonetic-alphabet
│       ├── q-code
│       └── radio-operating-ethics
├── CHANGELOG.md
├── LICENSE
├── package.json
└── README.md

Это упрощённая схема структуры проекта.

• В папке src/ размещается всё содержание сайта.
• В src/.vitepress находятся файлы конфигурации и стилей VitePress, каталоги компонентов и публичных файлов. Больше информации об этом можно найти в документации VitePress, но этим файлам редко нужны изменения.

.
├── src
│   ├── .vitepress
│   ├── contribute
│   ├── phonetic-alphabet
|   ├── q-code
|   ├── radio-operating-ethics
│   └── ru
│       ├── contribute
|       ├── phonetic-alphabet
|       ├── q-code
│       └── radio-operating-ethics
...

Папки src/contribute/ или src/q-code/ — это папки страниц или групп страниц. Страница — это папка, содержащая один файл index.md. Группа страниц — это папка, содержащая index.md и другие .md-файлы для дополнительных страниц.

Предупреждение

Если вы хотите создать новую страницу или группу страниц, потребуется изменить настройку locales.<lang>.themeConfig.sidebar в файле src/.vitepress/config.mts, чтобы ваша страница отображалась в навигации. Попробуйте сделать это самостоятельно, используя уже написанный код как пример, но не бойтесь просить помощи на нашей странице Github, если застрянете!

.
├── src
│   ├── .vitepress
│   ├── contribute
│   ├── phonetic-alphabet
|   ├── q-code
|   ├── radio-operating-ethics
│   └── ru
│       ├── contribute
|       ├── phonetic-alphabet
|       ├── q-code
│       └── radio-operating-ethics
...

Папки, названные по двухбуквенному коду страны, — это папки языков. Язык по умолчанию в этом проекте — английский, поэтому папкам src/contribute/ и src/radio-operating-ethics/ папка языка не нужна. Другие языки обязательно должны иметь папку языка, и она должна содержать те же страницы и группы страниц, что написаны на английском языке.