docs(howto): Homogenize HowTo's format across translated files (Ebook…

…Foundation#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#6590 * Rewording to be more meaningful * Add H1 header + `Read this` ... aligned to right Via EbookFoundation#6590 * remove trailing spaces * Split a bit first paragraph to highlight welcome. Via EbookFoundation#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#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 7ee485b commit Via EbookFoundation#6590 * Some bolds to highlight common resources formating issues (like in CONTRIBUTING) * Fix typos suggested by AhmedElTabarani Co-authored-by: أحمد الطبراني <[email protected]> * Add paragrah from EbookFoundation#5351. Need language translation * New strings translated to `it` Italian Co-authored-by: ImVector <[email protected]> * 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 <[email protected]> * Fix korean typos Co-authored-by: Wonjang Son <[email protected]> * New strings translated to `ar` Arabic Co-authored-by: أحمد الطبراني <[email protected]> * New strings translated to `fr` French Co-authored-by: Loic Beylot <[email protected]> Co-authored-by: أحمد الطبراني <[email protected]> Co-authored-by: ImVector <[email protected]> Co-authored-by: Wonjang Son <[email protected]> Co-authored-by: Loic Beylot <[email protected]>
aq15951 · Feb 28, 2022 · 28ec791 · 28ec791
1 parent 47d53f8
commit 28ec791
Show file tree

Hide file tree

Showing 27 changed files with 740 additions and 268 deletions.
diff --git a/docs/HOWTO-ar.md b/docs/HOWTO-ar.md
@@ -1,23 +1,40 @@
+# How-To at a glance
+
+<div align="right" markdown="1">
+
 *[إقرأ هذا بلغات أخرى](README.md#translations)*
 
+</div>
+
 <div dir="rtl" markdown="1">
 
-مرحبا بكم في *!Free-Programming-Books* نرحّب بجميع المساهمين الجدد؛ ونرحب أيضا بهؤلاء الذين يريدون تقديم أول بولّ ريكويست لهم علي جيت هبّ. إن كنت واحدا منهم، فإليك بعض المصادر التي ربما تساعدك:
+**مرحبا بكم في *!`Free-Programming-Books`**
+
+نرحّب بجميع المساهمين الجدد؛ ونرحب أيضا بهؤلاء الذين يريدون تقديم أول Pull Request (PR) لهم علي GitHub. إن كنت واحدا منهم، فإليك بعض المصادر التي ربما تساعدك:
+
+* [عن البولّ ريكويست](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) *(in English)*
+* [إنشاء بولّ ريكويست](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) *(in English)*
+* [GitHub مرحبا يا عالَم](https://docs.github.com/en/get-started/quickstart/hello-world) *(in English)*
+* [YouTube - دورات تعليمية عن GitHub للمبتدئين](https://www.youtube.com/watch?v=0fKg7e37bQE) *(in English)*
+* [YouTube - كيف تنشئ نسختك من مستودع علي GitHub وتقوم بتقديم بولّ ريكويست](https://www.youtube.com/watch?v=G1I3HF4YWEw) *(in English)*
+* [YouTube - دورة تعليمية مكثفة عن لغة المارك داون](https://www.youtube.com/watch?v=HUBNt18RFbo) *(in English)*
+* [YouTube - دورة تعليمية مكثفة عن لغة المارك داون](https://www.youtube.com/watch?v=1lZCkU5VpIs) *(in Algerian Arabic / بالجزائري)*
+* [YouTube - دورات تعليمية عن GitHub للمبتدئين](https://www.youtube.com/playlist?list=PLDoPjvoNmBAw4eOj58MZPakHjaO3frVMF) *(in Egyptian Arabic / بالمصري)*
+
+
+لا تخجل من أن تسأل، كل مساهم بدأ بأول PR له، ربما تكون من الآلاف المساهمين لدينا!  لذا... لما لا تنضم إلى مجتمعنا [الكبير والمزدهر](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books).
+
+<details align="center" markdown="1">
+<summary>إضغط لترى الرسم البياني لنمو المساهمين بالنسبة للزمن.</summary>
 
-* [عن البولّ ريكويست](https://help.github.com/articles/about-pull-requests/)
-* [إنشاء بولّ ريكويست](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
-* [جيت هبّ مرحبا يا عالَم](https://guides.github.com/activities/hello-world/)
-* [يوتيوب - دورات تعليمية عن جيت هبّ للمبتدئين](https://www.youtube.com/watch?v=0fKg7e37bQE)
-* [يوتيوب - كيف تنشئ نسختك من مستودع علي جيت هبّ وتقوم بتقديم بولّ ريكويست](https://www.youtube.com/watch?v=G1I3HF4YWEw)
-* [يوتيوب - دورة تعليمية مكثفة عن لغة المارك داون](https://www.youtube.com/watch?v=HUBNt18RFbo)
-* [يوتيوب - دورة تعليمية مكثفة عن لغة المارك داون](https://www.youtube.com/watch?v=1lZCkU5VpIs)
-* [يوتيوب - دورات تعليمية عن جيت هبّ للمبتدئين](https://www.youtube.com/playlist?list=PLDoPjvoNmBAw4eOj58MZPakHjaO3frVMF)
+[![EbookFoundation/free-programming-books's Contributor over time Graph](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)
 
+[![EbookFoundation/free-programming-books's Monthly Active Contributors graph](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)](https://www.apiseven.com/en/contributor-graph?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)
 
-لا تخجل من أن تسأل، كل مساهم بدأ بأول بولّ ريكويست له، ربما تكون من الآلاف المساهمين لدينا!
+</details>
 
-حتي لو كنت مساهما متمرسا في المشاريع مفتوحة المصدر، هناك بعض الأشياء التي ربما تقف في طريقك. فعند تقديمك للبولّ ريكويست، يقوم *جيت هبّ أكشن* بتشغيل فاحص تلقائيا لاكتشاف بعض الأخطاء الصغيرة التي قد تحدث بسبب المسافات أو الأخطاء الأبجدية. فإذا كان الزر أخضرا، هذا يعني أن الكود جاهز للمراجعة، ولكن إن كان غير ذلك، إضغط علي "تفاصيل" تحت الإختبار الذي فشل لتري ما هي الأخطاء التي يجب أن تصححها قبل مراجعة الكود. بعد تصحيح الأخطاء قم بعمل كومّيت لإضافة التعديلات للبولّ ريكويست.
+حتي لو كنت مساهما متمرسا في المشاريع مفتوحة المصدر، هناك بعض الأشياء التي ربما تقف في طريقك. فعند تقديمك للـPR، يقوم ***GitHub Actions* بتشغيل فاحص تلقائيا لاكتشاف بعض الأخطاء الصغيرة التي قد تحدث بسبب المسافات أو الأخطاء الأبجدية.** فإذا كان الزر أخضرا، هذا يعني أن الكود جاهز للمراجعة، ولكن إن كان غير ذلك، إضغط علي "تفاصيل" تحت الإختبار الذي فشل لتري ما هي الأخطاء التي يجب أن تصححها قبل مراجعة الكود. بعد تصحيح الأخطاء قم بعمل كومّيت لإضافة التعديلات للـPR.
 
-في النهاية، إذا لم تتأكد من أن المصادر التي تريد إضافتها مناسبة لـ *Free-Programming-Books*، فقم بقرآءة الدليل الإرشادي في [CONTRIBUTING](CONTRIBUTING.md). ([translations](README.md#translations))
+في النهاية، إذا لم تتأكد من أن المصادر التي تريد إضافتها مناسبة لـ `Free-Programming-Books`، فقم بقرآءة الدليل الإرشادي في [CONTRIBUTING](CONTRIBUTING.md). ([translations](README.md#translations))
 
 </div>
diff --git a/docs/HOWTO-bn.md b/docs/HOWTO-bn.md
@@ -1,16 +1,34 @@
+# How-To at a glance
+
+<div align="right" markdown="1">
+
 *[অন্য ভাষায় এটা পড়ুন](README.md#translations)*
 
-Free-Programming-Books রিপোজটরি তে স্বাগতম! আমরা নবাগত কন্ট্রিবিউটরস দের স্বাগতম জানাই; এমনকি যারা গিটহাবে এই প্রথম কোন "পুল রিকোয়েস্ট" তৈরি কয়েছেন। যদি আপনি তাদের একজন হয়ে থাকেন তাহলে নিচের রিসোর্স গুলো আপনার কাজে লাগতে পারেঃ
+</div>
+
+**`Free-Programming-Books` রিপোজটরি তে স্বাগতম!**
+
+আমরা নবাগত কন্ট্রিবিউটরস দের স্বাগতম জানাই; এমনকি যারা GitHub এই প্রথম কোন Pull Request (PR) তৈরি কয়েছেন। যদি আপনি তাদের একজন হয়ে থাকেন তাহলে নিচের রিসোর্স গুলো আপনার কাজে লাগতে পারেঃ
+
+* [পুল রিকোয়েস্ট কি?](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) *(in english)*
+* [কিভাবে পুল রিকোয়েস্ট দিব](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) *(in english)*
+* [GitHub হ্যালো ওয়ার্ল্ড](https://docs.github.com/en/get-started/quickstart/hello-world) *(in english)*
+* [YouTube - নতুনদের জন্য GitHub](https://www.youtube.com/watch?v=0fKg7e37bQE) *(in english)*
+* [YouTube - কিভাবে একটি GitHub রিপোজিটরি ফোর্ক করবেন এবং পুল রিকোয়েস্ট সাবমিট করবেন](https://www.youtube.com/watch?v=G1I3HF4YWEw) *(in english)*
+* [YouTube - মার্কডাউন ক্র্যাশ কোর্স](https://www.youtube.com/watch?v=HUBNt18RFbo) *(in english)*
+
+
+কোন প্রশ্ন করতে দ্বিধাবোধ করবেন না। সব কন্ট্রিবিউটরই ফার্স্ট 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>
+
+[![EbookFoundation/free-programming-books's Contributor over time Graph](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)
 
-* [:us: পুল রিকোয়েস্ট কি?](https://help.github.com/articles/about-pull-requests/) *(in english)*
-* [:us: কিভাবে পুল রিকোয়েস্ট দিব](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) *(in english)*
-* [:us: গিটহাব হ্যালো ওয়ার্ল্ড](https://guides.github.com/activities/hello-world/) *(in english)*
-* [:us: ইউটিউব - নতুনদের জন্য গিটহাব](https://www.youtube.com/watch?v=0fKg7e37bQE) *(in english)*
-* [:us: ইউটিউব - কিভাবে একটি গিটহাব রিপোজিটরি ফোর্ক করবেন এবং পুল রিকোয়েস্ট সাবমিট করবেন](https://www.youtube.com/watch?v=G1I3HF4YWEw) *(in english)*
-* [:us: ইউটিউব - মার্কডাউন ক্র্যাশ কোর্স ](https://www.youtube.com/watch?v=HUBNt18RFbo) *(in english)*
+[![EbookFoundation/free-programming-books's Monthly Active Contributors graph](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)](https://www.apiseven.com/en/contributor-graph?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)
 
-কোন প্রশ্ন করতে দ্বিধাবোধ করবেন না। সব কন্ট্রিবিউটরই ফার্স্ট পুল রিকোয়েস্ট থেকে শুরু করেছিল। আপনিও হতে পারেন আমাদের সহস্রতম কন্ট্রিবিউটর! 
+</details>
 
-এমনকি আপনি যদি একজন অভিজ্ঞ ওপেন-সোর্স কন্ট্রিবিউটর ও হয়ে থাকেন, কখনও কখনো কিছু জিনিস ভুল হতেই পারে। যখন আপনি আপনার পুল রিকোয়েস্ট সাবমিট করবেন গিটহাব একশনস আপনার কোড কে যাচাই-বাছাই করবে, কখনো বা স্পেসিং বা ক্যাপিটালাইজেশন এর মত ছোটখাটো জিনিস খুঁজে বের করবে। যদি আপনি সবুজ বাটন পেয়ে যান, তাহলে বুঝতে পারবেন সবকিছু রিভিউ এর জন্য প্রস্তুত। কিন্তু যদি আপনি সবুজ বাটন না পান তাহলে ফেইল্ড হওয়া চেক এর নিচে "Details" এ ক্লিক করলে সমস্যাগুলি খুঁজে বের করতে পারবেন। তারপর সেই সমস্যাগুলো ফিক্স করার পর আপনার পুল রিকোয়েস্ট এ কমিট করবেন। 
+এমনকি আপনি যদি একজন অভিজ্ঞ ওপেন-সোর্স কন্ট্রিবিউটর ও হয়ে থাকেন, কখনও কখনো কিছু জিনিস ভুল হতেই পারে। যখন আপনি আপনার PR সাবমিট করবেন ***GitHub Actions* আপনার কোড কে যাচাই-বাছাই করবে, কখনো বা স্পেসিং বা ক্যাপিটালাইজেশন এর মত ছোটখাটো জিনিস খুঁজে বের করবে**। যদি আপনি সবুজ বাটন পেয়ে যান, তাহলে বুঝতে পারবেন সবকিছু রিভিউ এর জন্য প্রস্তুত। কিন্তু যদি আপনি সবুজ বাটন না পান তাহলে ফেইল্ড হওয়া চেক এর নিচে "Details" এ ক্লিক করলে সমস্যাগুলি খুঁজে বের করতে পারবেন। তারপর সেই সমস্যাগুলো ফিক্স করার পর আপনার PR এ কমিট করবেন।
 
-যদি আপনার সন্দেহ হয় যে আপনার রিসোর্স "Free-Programming-Books" এর জন্য উপযুক্ত কিনা, এই গাইডলাইন্স পড়ে দেখুন- [CONTRIBUTING](CONTRIBUTING.md) ([translations](README.md#translations))
+যদি আপনার সন্দেহ হয় যে আপনার রিসোর্স `Free-Programming-Books` এর জন্য উপযুক্ত কিনা, এই গাইডলাইন্স পড়ে দেখুন- [CONTRIBUTING](CONTRIBUTING.md) ([translations](README.md#translations))
diff --git a/docs/HOWTO-bs.md b/docs/HOWTO-bs.md
@@ -1,17 +1,34 @@
+# How-To at a glance
+
+<div align="right" markdown="1">
+
 *[Pročitaj ovo u drugim jezicima](README.md#translations)*
 
-Dobrodošli u Free-Programming-Books! Primamo nove kontributore; čak i one koji tek prave svoj prvi pull request na GitHub-u. Ako ste jedan od njih, ovdje je nekoliko izvora koji bi Vam mogli pomoći:
+</div>
+
+**Dobrodošli u `Free-Programming-Books`!**
+
+Primamo nove kontributore; čak i one koji tek prave svoj prvi Pull Request (PR) na GitHub-u. Ako ste jedan od njih, ovdje je nekoliko izvora koji bi Vam mogli pomoći:
+
+* [O pull request-ima](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) *(in english)*
+* [Kreiranje pull request-a](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) *(in english)*
+* [GitHub Hello World](https://docs.github.com/en/get-started/quickstart/hello-world) *(in english)*
+* [YouTube - GitHub tutorijal za početnike](https://www.youtube.com/watch?v=0fKg7e37bQE) *(in english)*
+* [YouTube - Kako fork-ati GitHub repozitorij i postaviti pull request](https://www.youtube.com/watch?v=G1I3HF4YWEw) *(in english)*
+* [YouTube - Markdown Crash Course](https://www.youtube.com/watch?v=HUBNt18RFbo) *(in english)*
+
+
+Namojte se ustručavati da postavljate pitanja; svaki kontributor je započeo sa prvim PR-om. 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>
 
-* [O pull request-ima](https://help.github.com/articles/about-pull-requests/)
-* [Kreiranje pull request-a](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
-* [GitHub Hello World](https://guides.github.com/activities/hello-world/)
-* [YouTube - GitHub tutorijal za početnike](https://www.youtube.com/watch?v=0fKg7e37bQE)
-* [YouTube - Kako fork-ati GitHub repozitorij i postaviti pull request](https://www.youtube.com/watch?v=G1I3HF4YWEw)
-* [YouTube - Markdown Crash Course](https://www.youtube.com/watch?v=HUBNt18RFbo)
+[![EbookFoundation/free-programming-books's Contributor over time Graph](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)
 
+[![EbookFoundation/free-programming-books's Monthly Active Contributors graph](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)](https://www.apiseven.com/en/contributor-graph?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)
 
-Namojte se ustručavati da postavljate pitanja; svaki kontributor je započeo sa prvim PR-om. Vi biste mogli biti naš hiljaditi!
+</details>
 
-Čak i ako ste iskusan open source kontributor, postoje stvari u kojma biste se mogli zapetljati. Nakon što ste postavili Vaš PR, GitHub Actions će pokrenuti linter, koji često pronalazi problemčiće sa proredom ili abecednim redoslijedom. Ako dobijete zeleno dugme, sve je spremno za pregled, u suprotnom, kliknite "Details" ispod provjere koja nije uspjela kako biste otkrili šta se linter-u nije svidjelo. Ispravite problem i dodajte commit Vašem PR-u.
+Čak i ako ste iskusan open source kontributor, postoje stvari u kojma biste se mogli zapetljati. Nakon što ste postavili Vaš PR, ***GitHub Actions* će pokrenuti *linter*, koji često pronalazi problemčiće sa proredom ili abecednim redoslijedom**. Ako dobijete zeleno dugme, sve je spremno za pregled, u suprotnom, kliknite "Details" ispod provjere koja nije uspjela kako biste otkrili šta se linter-u nije svidjelo. Ispravite problem i dodajte commit Vašem PR-u.
 
-Na kraju, ako niste sigurni da je resurs koji želite dodati prikladan za Free-Programming-Books, pročitajte smjernice u [CONTRIBUTING](CONTRIBUTING.md). ([translations](README.md#translations))
+Na kraju, ako niste sigurni da je resurs koji želite dodati prikladan za `Free-Programming-Books`, pročitajte smjernice u [CONTRIBUTING](CONTRIBUTING.md). ([translations](README.md#translations))