Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(howto): Homogenize HowTo's format across translated files #6724

Merged
merged 31 commits into from
Feb 28, 2022

Conversation

davorpa
Copy link
Member

@davorpa davorpa commented Feb 15, 2022

What does this PR do?

Improve repo

For resources

Description

  • 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.
  • Accesibility: notes for links in other languages than translated instead of flags.

Check preview at: https://davorpa.github.io/free-programming-books/docs

Why is this valuable (or not)?

Resolves post hacktoberfest chore via #6590

Checklist:

  • Read our contributing guidelines
  • Search for duplicates.
  • Put lists in alphabetical order, correct spacing.
  • Add needed indications (PDF, access notes, under construction)

Follow-up

  • Check the status of GitHub Actions and resolve any reported warnings!

@davorpa davorpa added 🗣️ translations Issues or PRs addresing translations 🗣️ locale:en Resources addressing "English" language 🗣️ locale:es Resources addressing "Spanish / español" language labels Feb 15, 2022
@davorpa davorpa self-assigned this Feb 15, 2022
@davorpa davorpa added the conflicts Conflict(s) need to be resolved label Feb 15, 2022
@davorpa davorpa changed the title Homogenize HowTo's docs(howto): Homogenize HowTo's format across translated files Feb 15, 2022
- 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
docs/HOWTO-es.md Outdated Show resolved Hide resolved
docs/HOWTO.md Outdated Show resolved Hide resolved
@davorpa davorpa linked an issue Feb 16, 2022 that may be closed by this pull request
9 tasks
@davorpa davorpa added 🗣️ locale:ar Resources addressing "Arabic / العربية" language 🗣️ locale:bn Resources addressing "Bengali / বাংলা" language 🗣️ locale:de Resources addressing "German / Deutsch" language 🗣️ locale:el Resources addressing "Greek / Hellenic / ελληνικά" language 🗣️ locale:fa_IR Resources addressing "Persian / Farsi (Iran) / فارسى" language 🗣️ locale:fil Resources addressing "Filipino" language 🗣️ locale:fr Resources addressing "French / français" language 🗣️ locale:hi Resources addressing "Hindi / हिन्दी" language 🗣️ locale:id Resources addressing "Indonesian" language labels Feb 16, 2022
@davorpa davorpa added help wanted Needs help solving a blocked / stucked item and removed question Needs clarification by involved users / reviewers labels Feb 18, 2022
docs/HOWTO-ko.md Outdated Show resolved Hide resolved
docs/HOWTO-es.md Outdated Show resolved Hide resolved
davorpa and others added 2 commits February 20, 2022 20:14
Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>
Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>
@eshellman
Copy link
Collaborator

can we merge the parts that are done?

Copy link
Contributor

@filoscoder filoscoder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🦊

@davorpa
Copy link
Member Author

davorpa commented Feb 21, 2022

can we merge the parts that are done?

LGTM too since the most active contributors has proposed it translation: english, italian, spanish, portuguese

Can we wait 1 week more? Maybe someone want to contribute with the translation of new strings. The "help wanted" label should aim to that. #6724 (comment)

@LuigiImVector
Copy link
Member

Can we wait 1 week more? Maybe someone want to contribute with the translation of new strings. The "help wanted" label should aim to that. #6724 (comment)

Good idea, no problem i think

docs/HOWTO-ar.md Outdated Show resolved Hide resolved
docs/HOWTO-ar.md Outdated Show resolved Hide resolved
docs/HOWTO-fr.md Outdated Show resolved Hide resolved
docs/HOWTO-fr.md Outdated Show resolved Hide resolved
docs/HOWTO-fr.md Outdated Show resolved Hide resolved
@LoicB
Copy link
Contributor

LoicB commented Feb 27, 2022

Hi @davorpa
Sorry for taking so long, these are my suggestions.

davorpa and others added 2 commits February 27, 2022 10:46
Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com>
Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
@davorpa
Copy link
Member Author

davorpa commented Feb 27, 2022

Hi @davorpa Sorry for taking so long, these are my suggestions.

It doesn't matter Loic 🤗!

57cb2a1 to 193b7a9 force-push was only for fixing commit message for french files

@davorpa
Copy link
Member Author

davorpa commented Feb 27, 2022

@eshellman translations period has reached (1 week as timeout since #6724 (comment))

Said that... merge are enought for me too. If anybody wants translate a new PR is needed. Original texts are in each file, so can be easily identified

@davorpa davorpa added 🚀 ready to merge LGTM. Waiting for final approval and removed help wanted Needs help solving a blocked / stucked item waiting for changes PR has been reviewed and changes/suggestions requested labels Feb 27, 2022
@eshellman
Copy link
Collaborator

Thanks everyone!

@eshellman eshellman merged commit 28ec791 into EbookFoundation:main Feb 28, 2022
@davorpa davorpa mentioned this pull request Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚀 ready to merge LGTM. Waiting for final approval 🗣️ locale:ar Resources addressing "Arabic / العربية" language 🗣️ locale:bn Resources addressing "Bengali / বাংলা" language 🗣️ locale:bs Resources addressing "Bosnian / bosanski jezik" language 🗣️ locale:de Resources addressing "German / Deutsch" language 🗣️ locale:el Resources addressing "Greek / Hellenic / ελληνικά" language 🗣️ locale:en Resources addressing "English" language 🗣️ locale:es Resources addressing "Spanish / español" language 🗣️ locale:fa_IR Resources addressing "Persian / Farsi (Iran) / فارسى" language 🗣️ locale:fil Resources addressing "Filipino" language 🗣️ locale:fr Resources addressing "French / français" language 🗣️ locale:hi Resources addressing "Hindi / हिन्दी" language 🗣️ locale:id Resources addressing "Indonesian" language 🗣️ locale:it Resources addressing "Italian / italiano" language 🗣️ locale:km Resources addressing "Khmer / Cambodian / ខ្មែរ" language 🗣️ locale:ko Resources addressing "Korean / 한국어 [韓國語]" language 🗣️ locale:nl Resources addressing "Dutch / Nederlands" language 🗣️ locale:pl Resources addressing "Polish / polski" language 🗣️ locale:pt Resources addressing "Portuguese / Brazilian" language 🗣️ locale:ru Resources addressing "Russian / Русский язык" language 🗣️ locale:sl Resources addressing "Slovenian / slovenščina" language 🗣️ locale:sv Resources addressing "Sweedish / Svenska" language 🗣️ locale:th Resources addressing "Thai / ไทย" language 🗣️ locale:tr Resources addressing "Turkish / Türkçe" language 🗣️ locale:uk Resources addressing "Ukrainian / Українська" language 🗣️ locale:vi Resources addressing "Vietnamese / Tiếng Việt" language 🗣️ locale:zh Resources addressing "Chinese" language 🗣️ translations Issues or PRs addresing translations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Homogenize governance (CoC, CONTRIBUTING & HOWTO) across files
6 participants