README.md

Статьи медиа «Разрабы»

Здесь айти-медиа «Разрабы» хранит материалы своих статей. С помощью этого репозитория написанные вами статьи могут быть опубликованы на сайте https://razrabs.ru.

Ниже — детальная инструкция. В двух словах процесс такой: клонишь репозиторий, бранчуешься, создаешь пост, делаешь пуллреквест — мы мёржим, и пост публикуется.

Добавление постов

Я разработчик и/или понимаю, как пользоваться гитхабом

• Создать форк репозитория

• Сделать ветку с названием статьи транслитом

• Закинуть в нее папку с постом. Важно, чтобы название папки было уникальным, иначе произойдет обновление существующего поста (за раз можно добавить не более 30 файлов)

• Создать PR

• Лейблы в PR будут использованы как теги в посте

Мне нужна подробная инструкция

• Создать отдельную ветку от main, в текстовом поле ввести название новой ветки, нажать на Create branch

  

• Перейти в новую ветку и кликнуть Add file' => Upload files

  

• Перетащить файл поста или папку с файлом в поле на новой странице. После успешной загрузки нажать зеленую кнопку Commit changes

  • При создании нового поста важно, чтобы название папки было уникальным, иначе произойдет обновление существующего поста (за раз можно добавить не более 30 файлов)

  

• Если все прошло успешно, то на экране появится соответствующее сообщение, в котором предлагается создать Pull Request. Кликаем зеленую кнопку Compare & pull request

  

• В новом окне надо задать информацию о Pull Request. Поля заголовка и описания используются только для удобства редактора, они не играют абсолютно никакой роли в формировании поста. Те лейблы, которые будут проставлены в поле labels в дальнейшем станут тегами поста. На данном этапе необязательно заполнять все как в последний раз, у вас еще будет возможно все отредактировать. После всех приготовлений кликаем зеленую кнопку Create pull request

  

• В следующем окне отображается вся информация о вашем Pull Request, вы в любой момент можете его закрыть и вернуться позднее, прогресс не пропадет. Создание поста происходит после клика на кнопку Merge pull request

Обновление постов

Обновление существующего поста

• Если необходимо обновить только теги, то можно использовать Pull Request, который создавался ранее для создания поста, в случае изменения тегов в этом PR они автоматически изменятся в посте

• Для редактирования остальных полей необходимо пройти процедуру создания поста снова. При обновлении поста важно учитывать его расположение в основной ветке проекта. То есть, если файл поста, который вы хотите изменить, называется PostAboutForest.md и находится в папке Forest, то в новой ветке он так же должен находится в папке Forest и иметь названия PostAboutForest.md. Остальные действия полностью аналогичны созданию поста

Как .md файл парсится и выглядит на сайте

Рекомендации к оформлению статьи

Варианты размещения заголовка, описания, превью в статье

• Заголовок - первая строка в файле, обязательно наличие # перед началом строки

• Превью - первая картинка (.jpg, .png, .jpeg) в статье. Находится между заголовком и телом статьи

• Описание - Первый абзац статьи после заголовка

• Абзацы необходимо отделять друг от друга пустой строкой. При отсутствии разделения текста на абзацы весь текст статьи окажется в описании

Примерный формат:

# Заголовок

![img](превью.png)

Этот абзац попадет в описание статьи

Первый абзац статьи

Второй абзац статьи

Ограничения по количеству символов в посте и рекомендации к изображениям

• Небольшой заголовок
• Описание в один абзац
• Превью статьи не должна быть формата .gif
• По изображениям желателен любой горизонтальный формат (.jpg, .png, .jpeg). Соотношение сторон между 4:3 и 16:9 либо приближенное