Внося изменения или добавляя новое содержимое в данный репозиторий, вы соглашаетесь со следующим:
- Вы добровольно передаете свою работу данному проекту (репозиторию).
- Ваша работа автоматически подпадает под лицензию репозитория.
- Вы подтверждаете что ваша контрибуция не нарушает прочие лицензии и не является воровством чужих материалов.
- Содержимое данного проекта может быть использовано где угодно без дополнительного разрешения третьими лицами.
- Если вы хотите внести небольшие изменения (опечатки, ошибки и т.д.) — можете напрямую править материалы и предлагать Pull Request.
- Если вы желаете обсудить изменения — создайте issue.
- Если вы хотите внести большие изменения — создайте issue прежде чем начинать.
- Если вы хотите добавить новый материал — создайте issue, опишите о чём вы хотите написать, зачем это нужно, структуру будущего материала.
- Если вы хотите предложить что нужно добавить — создайте issue.
Во всех случаях вы можете сразу присылать Pull Request, но это не гарантирует его принятия, и во избежание ситуации, что вы зря потратили время, для больших изменений лучше создать issue чтобы мы могли обсудить как нам поступать и нужно ли нам это. Будет очень обидно, если вы потратите много времени и изменения не будет приняты.
Неважно как вы желаете принять участие, вам потребуется GitHub аккаунт если у вас его ещё нет. Если вы не знакомы с git и GitHub, вам может оказаться полезным материал на MDN - Гит и ГитХаб.
Существует несколько путей как вы можете начать работать с репозиторием. Всё зависит от ваших предпочтений. Вот некоторые варианты:
- Зайдите на https://github.com/Druki-ru/content или любую другую страницу со структурой или файлами репозитория и
нажмите точку
.на клавиатуре. - Зайдите на https://github.com/Druki-ru/content и редактируйте документ прямо при помощи GitHub UI. Это самый простой способ для внесения простых изменений в один файл или исправления опечаток.
- Зайдите на https://druki.ru/wiki и найдите материал, что вы хотите поправить. Внизу страницы в разделе «Помощь и обратная связь» нажмите на ссылку «Редактировать эту страницу». Данная ссылка откроет документ на редактирование в GitHub UI. Как и в предыдущем пункте, вы можете внести необходимые правки в документ или исправить опечатки.
- Установить и использовать GitHub Desktop .
- Установить и использовать GitHub CLI.
- Установить
gitи использовать его любым удобным для вас способом.
Рекомендуется, по возможности, использовать PHPStorm — он отлично поддерживает Markdown, понимает структуру проекта, проверяет пунктуацию и орфографию, а также позволяет делать простые рефакторинги, если вы захотите переместить документ. Более того, он будет подсвечивать примеры с кодом на PHP! Если у вас нет доступа к PHPStorm, можно рассмотреть использование IntelliJ IDEA Community Edition — она имеет все возможности PHPStorm, абсолютно бесплатна, но не будет понимать PHP.
Если вы ищете вариант полегче, VSCode отличный выбор. Единственное, он не сможет произвести рефакторинг при перемещении документа.
Если вы хотите внести простые изменения в один файл, например, исправить опечатку или неточность, использование GitHub UI самый простой и быстрый способ сделать это.
Например, если вы нашли опечатку на странице Drupal, вы можете зайти на GitHub, перейти в https://github.com/Druki-ru/content, найди документ отвечающий за эту страницу docs/ru/drupal/drupal.md, а затем нажать на карандаш и внести исправления.
Если вы нашли опечатку прямо во время чтения, вы можете сделать это ещё быстрее — пролистайте материал до конца и нажмите на «Редактировать эту страницу». Данная ссылка откроет нужный файл в данном репозитории на редактирование, как если бы вы проделали все действия из предыдущего абзаца.
Если вы не уверены нужно ли вносить изменения или в их корректности, вы можете создать ишью и вынести своё предложение на обсуждение. Вы также можете сделать это со страницы материала, для этого пролистайте материал до конца и нажмите «Создать обращение». Данная ссылка откроет страницу создания ишьюса, попутно предоставив дополнительную информацию о материале за вас.
Альтернативный вариант: Нажмите . на клавиатуре, находясь в репозитории и вносите изменения.
Front Matter — YAML разметка в начале документа, описывающая дополнительную информацию о документе, не являющуюся
частью содержимого. Данная разметка должна идти в самом начале документа и быть обёрнута в ---.
Пример:
---
title: Заголовок материала
slug: page-title
---
Содержимое материала.Для примера выше Front Matter это:
---
title: Заголовок материала
slug: page-title
---Эта информация никак не отображается в материалах, и будет конвертирована в данные title и slug, которые будут
использованы с какой-либо целью. Доступные значения и их применения описаны в материалах к содержимому которое
поддерживает Front Matter.
Markdown — язык разметки используемый для написания материалов. Проект поддерживает Markdown синтаксис по спецификации CommonMark.
На проекте также добавлена поддержка собственного синтаксиса.
Сноски используются для отображения различной справочной и дополнительной информации, например заметки, предупреждения или советы, на которые читателю стоит обратить внимание.
Используйте сноски в тех случаях, когда необходимо явно выделить какую-то часть информации из самого текста.
Сноски добавляются при помощи <Aside></Aside> элемента. Данный элемент парный — должен иметь как открывающий, так и закрывающий тег. Регистр важен!
Содержимое для <Aside> должно быть внутри элемента на отдельных строках. Применение <Aside> внутри строки недопустимо (он будет проигнорирован).
<Aside>
Здесь ваша заметка!
</Aside>Элемент поддерживает два аттрибута, оба они опциональны:
type: Тип сноски, влияет на её визуальное оформление. Если тип не указан или указан неверный (недопустимый) тип, то будет использованnote. Поддерживаются следующие типы сносок:note: Тип сноски по умолчанию. Используется для простых заметок.tip: Совет или подсказка. Используется для дополнительной информации, которая может оказаться полезной, но не обязательна. Например, что то, о чём описано в материале можно сделать при помоще Drush команды.warning: Предупреждение — то, на что стоит обратить внимание.important: Что-то крайне важное, что обязательно стоит прочитать.deprecated: Используется для пометки старых материалов, фукнций, кода и т.д.
header: Заголовок сноски. По умолчанию сноска не имеет заголовка, но если нужно, вы можете указать. Заголовок не поддерживает Markdown и должен быть обычной строкой.
Пример с аттрибутами:
<Aside type="tip" header="Совет">
Иметь пустые линии после открывающего и перед закрывающим тегом не обязательно, но они повышают читаемость.
</Aside>Содержимое ничего не знает о том, на каком домене, как и где оно используется и какие будут URL. Вся внутренняя перелинковка между документами должна производится при помощи относительных ссылок.
Например, имеем следующую структуру:
.
└── docs/
└── ru/
└── 8/
├── installation/
│ └── index.md
├── drush/
│ └── index.md
└── changelog/
└── index.md
Примеры ссылок и куда они приведут:
| Редактируемый файл | Ссылка | Куда приведет |
|---|---|---|
docs/ru/8/installation/index.md |
[Drush](../drush/index.md) |
docs/ru/8/drush/index.md |
docs/ru/8/installation/index.md |
[Список изменений](../changelog/index.md) |
docs/ru/8/changelog/index.md |
- Откройте настройки (
CTRL + ALT + S) и перейдите в Editor | Proofreading | Spelling. - В разделе Custom dictionaries нажмите на + или
ALT + Insert. - Укажите путь до dictionary.dic.
SHIFT + SHIFTи найдите Run Inspection by Name илиCTRL + SHIFT + ALT + I.- Найдите Typo или Grammar и запустите.