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.

Sign up for GitHub

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

Jump to bottom

feat: Add docs/readme.md + update crosslinks #6700

Merged
merged 40 commits into from
Feb 11, 2022
Merged

feat: Add docs/readme.md + update crosslinks #6700

merged 40 commits into from
Feb 11, 2022

Conversation

davorpa
Copy link
Member

@davorpa davorpa commented Feb 7, 2022 •
edited
Loading

What does this PR do?

Add info | Improve repo

For resources

Description

Add a readme.md index to folder with all gobernance documents and its translations

Also updates list with current available locales, fixing some of its 404 status

Why is this valuable (or not)?

Is a good practice have a README.md in each folder, specially in docs or root.

Resolves #6698

Checklist:

Follow-up

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

@davorpa
complete translate list with the new languages appeared since hacktob…
0f646d0 
…erfest
@davorpa
Create docs/README.md with the translations section
410d056 
using root README.md as source. Links are adapted to this folder

Address EbookFoundation#6698
@davorpa
fix remaining url + translation items
d267cbf 
- Portuguese (Portugal)
- Slovak / slovenčina
- Slovenian / slovenščina

Address EbookFoundation#6698
@davorpa
fix remaining url + translation items
6654893 
- Portuguese (Portugal)
- Slovak / slovenčina
- Slovenian / slovenščina

Address EbookFoundation#6698
@davorpa davorpa self-assigned this Feb 7, 2022
@davorpa davorpa added the question Needs clarification by involved users / reviewers label Feb 7, 2022
@davorpa
Copy link
Member Author

davorpa commented Feb 7, 2022

Should translations sections be removed from root readme.md and then adapt current crosslinks to new folder location?

@davorpa davorpa marked this pull request as ready for review February 7, 2022 14:51
@eshellman
Copy link
Collaborator

  • the changes to the heading levels on README.md are good.
  • duplicating the translation links doubles the maintenance burden. we should either make docs/README a stub pointing at README, or move the translation links, which will break a lot of links and demote the visibility of translations. Using the rule "If it ain't broke, don't fix it" I prefer the stub.

@davorpa davorpa added waiting for changes PR has been reviewed and changes/suggestions requested and removed question Needs clarification by involved users / reviewers labels Feb 8, 2022
davorpa referenced this pull request Feb 8, 2022
@davorpa
fix h2-h3 heading levels
8c2fdab
@davorpa davorpa marked this pull request as draft February 8, 2022 07:09
@davorpa davorpa changed the title feat: Add docs/readme.md + links feat: Add docs/readme.md + crosslinks Feb 8, 2022
@davorpa davorpa added 🗣️ locale:fil Resources addressing "Filipino" language 🗣️ locale:fr Resources addressing "French / français" language 🗣️ locale:he Resources addressing "Hebrew / עברית" language 🗣️ locale:hi Resources addressing "Hindi / हिन्दी" language 🗣️ locale:hu Resources addressing "Hungarian / magyar / magyar nyelv" language 🗣️ locale:id Resources addressing "Indonesian" language 🗣️ locale:it Resources addressing "Italian / italiano" language 🗣️ locale:ja Resources addressing "Japanese / 日本語" language 🗣️ locale:kk Resources addressing "Kazakh / қазақша" language 🗣️ locale:km Resources addressing "Khmer / Cambodian / ខ្មែរ" language 🗣️ locale:ko Resources addressing "Korean / 한국어 [韓國語]" language 🗣️ locale:ml Resources addressing "Malayalam / മലയാളം" language 🗣️ locale:my Resources addressing "Burmese / မြန်မာဘာသာ" language 🗣️ locale:nl Resources addressing "Dutch / Nederlands" language 🗣️ locale:no Resources addressing "Norwegian / Norsk" language 🗣️ locale:pl Resources addressing "Polish / polski" language 🗣️ locale:pt Resources addressing "Portuguese / Brazilian" language 🗣️ locale:ro Resources addressing "Romanian (Romania) / limba română / român" language 🗣️ locale:ru Resources addressing "Russian / Русский язык" language 🗣️ locale:si Resources addressing "Sinhala / සිංහල" language 🗣️ locale:sk Resources addressing "Slovak / slovenčina" language 🗣️ locale:sl Resources addressing "Slovenian / slovenščina" language 🗣️ locale:sv Resources addressing "Sweedish / Svenska" language 🗣️ locale:ta Resources addressing "Tamil / தமிழ்" 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 labels Feb 22, 2022
@davorpa davorpa mentioned this pull request Apr 15, 2022
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eshellman eshellman Awaiting requested review from eshellman

Assignees

@davorpa davorpa

Labels
🗣️ locale:ar Resources addressing "Arabic / العربية" language 🗣️ locale:az Resources addressing "Azerbaijani / Азәрбајҹан дили / آذربايجانجا ديلي" language 🗣️ locale:bg Resources addressing "Bulgarian / български" language 🗣️ locale:bn Resources addressing "Bengali / বাংলা" language 🗣️ locale:bs Resources addressing "Bosnian / bosanski jezik" language 🗣️ locale:cs Resources addressing "Czech / čeština / český jazyk" language 🗣️ locale:da Resources addressing "Danish / dansk" 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:et Resources addressing "Estonian / eesti keel" language 🗣️ locale:fa_IR Resources addressing "Persian / Farsi (Iran) / فارسى" language 🗣️ locale:fi Resources addressing "Finnish / suomi / suomen kieli" language 🗣️ locale:fil Resources addressing "Filipino" language 🗣️ locale:fr Resources addressing "French / français" language 🗣️ locale:he Resources addressing "Hebrew / עברית" language 🗣️ locale:hi Resources addressing "Hindi / हिन्दी" language 🗣️ locale:hu Resources addressing "Hungarian / magyar / magyar nyelv" language 🗣️ locale:id Resources addressing "Indonesian" language 🗣️ locale:it Resources addressing "Italian / italiano" language 🗣️ locale:ja Resources addressing "Japanese / 日本語" language 🗣️ locale:kk Resources addressing "Kazakh / қазақша" language 🗣️ locale:km Resources addressing "Khmer / Cambodian / ខ្មែរ" language 🗣️ locale:ko Resources addressing "Korean / 한국어 [韓國語]" language 🗣️ locale:ml Resources addressing "Malayalam / മലയാളം" language 🗣️ locale:my Resources addressing "Burmese / မြန်မာဘာသာ" language 🗣️ locale:nl Resources addressing "Dutch / Nederlands" language 🗣️ locale:no Resources addressing "Norwegian / Norsk" language 🗣️ locale:pl Resources addressing "Polish / polski" language 🗣️ locale:pt Resources addressing "Portuguese / Brazilian" language 🗣️ locale:ro Resources addressing "Romanian (Romania) / limba română / român" language 🗣️ locale:ru Resources addressing "Russian / Русский язык" language 🗣️ locale:si Resources addressing "Sinhala / සිංහල" language 🗣️ locale:sk Resources addressing "Slovak / slovenčina" language 🗣️ locale:sl Resources addressing "Slovenian / slovenščina" language 🗣️ locale:sv Resources addressing "Sweedish / Svenska" language 🗣️ locale:ta Resources addressing "Tamil / தமிழ்" 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 waiting for changes PR has been reviewed and changes/suggestions requested
Projects
None yet
Milestone
No milestone
2 participants
@davorpa @eshellman