mirror of
https://github.com/CopterExpress/clover.git
synced 2026-05-26 21:19:35 +00:00
docs: add information about writing new article (#148)
* docs: Add information about writing new article * docs: Add illustrations for pull request * docs: Trying to make markdown linter happy * docs: Trying to make markdown linter happy 2 * docs: Trying to make markdown linter happy 3 * docs: Finall corrections of article about writing new article * docs: Finall corrections of article about writing new article 2
This commit is contained in:
committed by
Oleg Kalachev
parent
8956b3459e
commit
9873c24cae
BIN
docs/assets/github-fork.png
Normal file
BIN
docs/assets/github-fork.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
BIN
docs/assets/github-pull-request-create.png
Normal file
BIN
docs/assets/github-pull-request-create.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 118 KiB |
BIN
docs/assets/github-pull-request.png
Normal file
BIN
docs/assets/github-pull-request.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
@@ -34,10 +34,61 @@
|
||||
|
||||
Более подробную информацию о Pull Request'ах смотрите [на GitHub](https://help.github.com/articles/about-pull-requests/) (англ.) или в [документации по git](https://git-scm.com/book/ru/v2/GitHub-Внесение-собственного-вклада-в-проекты) (русск.).
|
||||
|
||||
## Ваш проект с Клевером
|
||||
## Добавление статьи в GitBook
|
||||
|
||||
Если вы реализовали собственный интересный проект на Клевере, вы можете добавить статью о нем в раздел "Проекты на базе Клевера".
|
||||
> **Note** Если вы реализовали собственный интересный проект на Клевере, вы можете добавить статью о нем в раздел "Проекты на базе Клевера".
|
||||
|
||||
Подготовьте вашу статью и пришлите Pull Request с ней в [репозиторий Клевера](https://github.com/CopterExpress/clever).
|
||||
|
||||
<!-- TODO -->
|
||||
1. Сделайте форк репозитория Клевера:
|
||||
|
||||
<img src="../assets/github-fork.png" alt="GitHub Fork">
|
||||
|
||||
2. Склонируйте форк на компьютер:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/<USERNAME>/clever.git
|
||||
```
|
||||
|
||||
3. Перейдите в директорию с форком и создайте новую ветку с названием вашей статьи (например `new-article`):
|
||||
|
||||
```bash
|
||||
git checkout -b new-article
|
||||
```
|
||||
|
||||
4. Напишите новую статью в разделе `docs/ru` или `docs/en` в формате [Markdown](https://ru.wikipedia.org/wiki/Markdown) (например `docs/ru/new_article.md`).
|
||||
5. Поместите дополнительные визуальные материалы в папку `docs/assets` и оформите на них ссылки в вашей статье.
|
||||
6. Добавьте статью в файл оглавления `SUMMARY.md` в том разделе, где вы её написали (например в `docs/ru/SUMMARY.md`):
|
||||
|
||||
```bash
|
||||
...
|
||||
* Дополнительные материалы
|
||||
* [Олимпиада НТИ 2019](nti2019.md)
|
||||
* [Вклад в Клевер](contributing.md)
|
||||
* [Новая статья](new_article.md)
|
||||
* [Сборка и модификация образа Клевера](image_building.md)
|
||||
* [Прошивка ESC контроллеров](esc_firmware.md)
|
||||
...
|
||||
```
|
||||
|
||||
7. Сохраните состояние ваших изменений локально:
|
||||
|
||||
```bash
|
||||
git add docs/
|
||||
git commit -m "Add new article for Clever"
|
||||
```
|
||||
|
||||
8. Загрузите вашу новую ветку с изменениями на ваш GitHub репозиторий с форком Клевера:
|
||||
|
||||
```bash
|
||||
git push -u origin new-article
|
||||
```
|
||||
|
||||
9. Перейдите на web страницу вашего форка и сделайте `pull request` вашей ветки в master Клевера:
|
||||
|
||||
<img src="../assets/github-pull-request.png" alt="GitHub Pull Request">
|
||||
|
||||
<img src="../assets/github-pull-request-create.png" alt="GitHub Create Pull">
|
||||
|
||||
10. Дождитесь комментариев на свою статью, сделайте правки, если потребуется.
|
||||
11. Порадуйтесь своей новой полезной статье, опубликованной на https://clever.copterexpress.com!
|
||||
|
||||
Reference in New Issue
Block a user