mirror of
https://github.com/EbookFoundation/free-programming-books.git
synced 2025-08-18 13:51:38 +02:00
docs(howto): Homogenize HowTo's format across translated files (#6724)
* Homogenize HowTo's
- Add H1 header
- `Read this` ... right alignmements
- Split a bit first paragraph to highlight welcome.
- Introduce Pull Request acronym.
- trademarks / typos: GitHub, YouTube, Pull Request
- Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped.
- Details block added, with center align. When clicked, the contributor graphs is toggled.
- Some bolds to highlight common resources formating issues (like in CONTRIBUTING)
- Repo name in monospace font
- Re-worded last part of 4th paragraph to explain that no new PR is needed to open if there are linter errors or changes are requested. Now it's more clear, I thought.
Via EbookFoundation/free-programming-books#6590
* Rewording to be more meaningful
* Add H1 header + `Read this` ... aligned to right
Via EbookFoundation/free-programming-books#6590
* remove trailing spaces
* Split a bit first paragraph to highlight welcome.
Via EbookFoundation/free-programming-books#6590
* homogenize `1-2` newlines amount between paragraphs
* Update Github documentation links list
- Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped.
- Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context
Via EbookFoundation/free-programming-books#6590
* GitHub trademark typos
* YouTube trademark typos
* `Welcome to fpb!` in bold style
* Repo name backticked in monospace font
(non-translatable)
* reword es-en graph summary
* Add a centered details block with graphs about contributions (users vs. time)
Detail blocks are toggleable sections in GitHub
Provided graphs by apiseven:
- Contributor over time Graph
- Monthly Active Contributors graph
* GitHub trademark typos
* Fix pull request typos and introduce it acronym
* Update Github documentation links list
- Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped.
- Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context
The forgot rest addressed on 7ee485bb3b commit
Via EbookFoundation/free-programming-books#6590
* Some bolds to highlight common resources formating issues (like in CONTRIBUTING)
* Fix typos suggested by AhmedElTabarani
Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com>
* Add paragrah from #5351. Need language translation
* New strings translated to `it` Italian
Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>
* use languages not countries. `in Egyptian Arabic`
* use languages not countries. `in Algerian Arabic`
* remove notes from details block containing graphs about contributions (users vs. time)
* Fix spanish typos
Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>
* Fix korean typos
Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>
* New strings translated to `ar` Arabic
Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com>
* New strings translated to `fr` French
Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com>
Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>
Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>
Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
This commit is contained in:
David Ordás
GitHub
@@ -1,21 +1,38 @@
|
||||
# How-To at a glance
|
||||
|
||||
<div align="right" markdown="1">
|
||||
|
||||
*[Доступно на других языках](README.md#translations)*
|
||||
|
||||
Добро пожаловать в Free-Programming-Books! Мы приветствуем новых участников; даже тех, кто делает свой самый первый пулреквест на Github. Если вы один из них, вот несколько ресурсов, которые могут вам помочь:
|
||||
</div>
|
||||
|
||||
* [:us: Про пулреквесты](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
|
||||
* [:us: Создание пулреквеста](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
|
||||
* [:us: Github Hello World](https://guides.github.com/activities/hello-world/)
|
||||
* [:us: Youtube - обучающий ролик по Github для новичков](https://www.youtube.com/watch?v=0fKg7e37bQE)
|
||||
* [:us: Youtube - Как форкнуть GitHub репозиторий и отправить пулл реквест](https://www.youtube.com/watch?v=G1I3HF4YWEw)
|
||||
* [:us: Youtube - курс погружения в Markdown](https://www.youtube.com/watch?v=HUBNt18RFbo)
|
||||
**Добро пожаловать в `Free-Programming-Books`!**
|
||||
|
||||
* [:ru: Pull request'ы на GitHub или Как мне внести изменения в чужой проект](https://habr.com/ru/post/125999/)
|
||||
* [:ru: Github Hello World](http://bi0morph.github.io/hello-world/)
|
||||
* [:ru: Youtube - Изучение GitHub в одном видео уроке за 15 минут](https://www.youtube.com/watch?v=JfpCicDUMKc)
|
||||
* [:ru: Youtube - Markdown - пиши README без боли](https://www.youtube.com/watch?v=FFBTGdEMrQ4)
|
||||
|
||||
Не стесняйтесь задавать вопросы; каждый участник начал с первого PR. Вы могли бы стать нашим тысячным!
|
||||
Мы приветствуем новых участников; даже тех, кто делает свой самый первый Pull Request (PR) на GitHub. Если вы один из них, вот несколько ресурсов, которые могут вам помочь:
|
||||
|
||||
Даже если вы опытный участник проекта с открытым исходным кодом, есть вещи, которые могут вас сбить с толку. После того как вы отправите свой PR, GitHub Actions запустит линтер который часто находит небольшие проблемы с пробелами или алфавитным порядком. Если у вас появляется зеленая кнопка, все готово к проверке, а если нет, нажмите "Details" под проверкой, которая не смогла выяснить, что не понравилось линтеру. Устраните проблему и добавьте коммит в свой пулреквест.
|
||||
* [Про пулреквесты](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) *(на английском языке)*
|
||||
* [Создание пулреквеста](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) *(на английском языке)*
|
||||
* [GitHub Hello World](https://docs.github.com/en/get-started/quickstart/hello-world) *(на английском языке)*
|
||||
* [YouTube - обучающий ролик по GitHub для новичков](https://www.youtube.com/watch?v=0fKg7e37bQE) *(на английском языке)*
|
||||
* [YouTube - Как форкнуть GitHub репозиторий и отправить пулл реквест](https://www.youtube.com/watch?v=G1I3HF4YWEw) *(на английском языке)*
|
||||
* [YouTube - курс погружения в Markdown](https://www.youtube.com/watch?v=HUBNt18RFbo) *(на английском языке)*
|
||||
|
||||
Наконец, если вы не уверены, что ресурс, который вы хотите добавить, подходит для Free-Programming-Books, прочтите рекомендации в [CONTRIBUTING](CONTRIBUTING-ru.md). ([translations](README.md#translations))
|
||||
* [Pull request'ы на GitHub или Как мне внести изменения в чужой проект](https://habr.com/ru/post/125999/)
|
||||
* [GitHub Hello World](http://bi0morph.github.io/hello-world/)
|
||||
* [YouTube - Изучение GitHub в одном видео уроке за 15 минут](https://www.youtube.com/watch?v=JfpCicDUMKc)
|
||||
* [YouTube - Markdown - пиши README без боли](https://www.youtube.com/watch?v=FFBTGdEMrQ4)
|
||||
|
||||
Не стесняйтесь задавать вопросы; каждый участник начал с первого PR. Вы могли бы стать нашим тысячным! So... why not join our [large, growing](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books) community.
|
||||
|
||||
<details align="center" markdown="1">
|
||||
<summary>Click to see the growth users vs. time graphs.</summary>
|
||||
|
||||
[](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)
|
||||
|
||||
[](https://www.apiseven.com/en/contributor-graph?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)
|
||||
|
||||
</details>
|
||||
|
||||
Даже если вы опытный участник проекта с открытым исходным кодом, есть вещи, которые могут вас сбить с толку. После того как вы отправите свой PR, ***GitHub Actions* запустит *linter* который часто находит небольшие проблемы с пробелами или алфавитным порядком**. Если у вас появляется зеленая кнопка, все готово к проверке, а если нет, нажмите "Details" под проверкой, которая не смогла выяснить, что не понравилось линтеру. Устраните проблему и добавьте коммит в свой PR.
|
||||
|
||||
Наконец, если вы не уверены, что ресурс, который вы хотите добавить, подходит для `Free-Programming-Books`, прочтите рекомендации в [CONTRIBUTING](CONTRIBUTING-ru.md). ([translations](README.md#translations))
|
||||
|
||||
Reference in New Issue
Block a user