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

๐ŸŒ ๐Ÿ”  ๐Ÿ“„ ๐Ÿข Translate docs to Emoji ๐Ÿฅณ ๐ŸŽ‰ ๐Ÿ’ฅ ๐Ÿคฏ ๐Ÿคฏ #5385

Merged
merged 4 commits into from Apr 1, 2023

Conversation

LeeeeT
Copy link
Contributor

@LeeeeT LeeeeT commented Sep 13, 2022

I just really love ๐Ÿ’• ๐Ÿคฉ the idea of adding some emojis ๐Ÿ˜„๐Ÿ˜๐Ÿ˜… here and there across the ๐Ÿ“„ docs ๐Ÿ“„ (like in here for example). So I decided to write โœ the entire documentation out of emojis ๐Ÿ’ฅ๐ŸŽ‰๐ŸŒŸ. All these words ๐Ÿคฎ๐Ÿคข and... fancy-looking letters.. ๐Ÿ‘Ž๐Ÿ‘Ž๐Ÿ‘Ž ugh... That's so boring ๐Ÿฅฑ. I believe reading documentation made of emojis will definitely (don't argue ๐Ÿ˜›๐Ÿคช) be much funnier ๐Ÿ˜ƒ and easier ๐Ÿ˜ป for beginners. Just take a look at a new awesome ๐Ÿ”ฅ async page ๐Ÿ”ฅ. So here it is, don't thank me. ๐Ÿ’ฅ๐Ÿ’ฏ๐Ÿ’ซโญ

@codecov
Copy link

codecov bot commented Sep 13, 2022

Codecov Report

Patch and project coverage have no change.

Comparison is base (cf73051) 100.00% compared to head (3b37ad3) 100.00%.

โ— Current head 3b37ad3 differs from pull request most recent head 7b50132. Consider uploading reports for the commit 7b50132 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #5385   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          540       540           
  Lines        13969     13951   -18     
=========================================
- Hits         13969     13951   -18     

see 10 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

โ˜” View full report in Codecov by Sentry.
๐Ÿ“ข Do you have feedback about the report comment? Let us know in this issue.

@github-actions
Copy link
Contributor

๐Ÿ“ Docs preview for commit 5590e38 at: https://6320bdb2dc53d17efc1ba804--fastapi.netlify.app

Comment on lines 9 to 13
* <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank"><strong>OpenAPI</strong></a> ๐Ÿ— API, โœ… ๐Ÿ™‚๐Ÿ“› <abbr title="๐Ÿ’ญ HTTP-๐Ÿ‘ฉโ€๐Ÿ”ฌ โœ… : POST, GET, PUT, DELETE">๐Ÿ› </abbr> <abbr title="๐Ÿ’ญ: ๐Ÿ”—, ๐Ÿ›ฃ, '๐Ÿต', โ™’๏ธ.">๐ŸŒŒ</abbr>, ๐Ÿ”ข, โœ” ๐Ÿ’ช, ๐Ÿ’‚โ€โ™‚, โ™’๏ธ.

Copy link

@MadL1me MadL1me Sep 13, 2022

Choose a reason for hiding this comment

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

I think "Security" in native emoji is more like "๐Ÿ‘ฎ" than your translated "๐Ÿ’‚โ€โ™‚". However, the other parts are perfect, I like it

Copy link
Owner

Choose a reason for hiding this comment

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

I find amusing the seriousness of this review. ๐Ÿ˜‚

Copy link
Contributor

@FeeeeK FeeeeK left a comment

Choose a reason for hiding this comment

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

It looks๐Ÿ‘€ like the markup๐Ÿ“ is a bit๐Ÿค broken๐Ÿ’”, making it hard๐Ÿ˜… to read๐Ÿ“– such great๐Ÿ‘ documentation๐Ÿ“.
https://6320bdb2dc53d17efc1ba804--fastapi.netlify.app/emj/
image
image

@github-actions
Copy link
Contributor

๐Ÿ“ Docs preview for commit 3b37ad3 at: https://6321d213a4b3527ed976768f--fastapi.netlify.app

@LeeeeT
Copy link
Contributor Author

LeeeeT commented Sep 14, 2022

@FeeeeK ๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅ Fixed ๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅ

@tiangolo
Copy link
Owner

Hey there! Is this coming from a joke or something somewhere else? ๐Ÿ˜…

I imagine that given all the approvals and interactions, but I didn't see the original joke... ๐Ÿคท

@FeeeeK
Copy link
Contributor

FeeeeK commented Sep 14, 2022

@FeeeeK ๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅ Fixed ๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅ

Great๐Ÿ’ซ, I think this is a very nice๐Ÿ‘ change, making the documentation๐Ÿ“ much friendlier๐Ÿ™Œ. It's a pity that the previousโฎ๏ธ version of the Concurrency and async / await documentation was removedโŒ, I really miss it๐Ÿฅฒ.

@github-actions github-actions bot removed the answered label Sep 14, 2022
@mrMiiao
Copy link

mrMiiao commented Sep 14, 2022

Really ๐Ÿ˜ƒ๐Ÿ˜ƒ๐Ÿ˜ƒ cool ๐Ÿ˜๐Ÿ˜๐Ÿ™‚ idea ๐Ÿ‘๐Ÿง ๐Ÿซฆ bro ๐Ÿฅต๐Ÿ˜Ž๐Ÿฅต!!!

@FeeeeK
Copy link
Contributor

FeeeeK commented Sep 14, 2022

@tiangolo You see right through us. Forgive us this joke. We're just really sad about the decision to remove the emojis in #3273. They made the documentation unusual and stand out from the documentation of other frameworks. That's why we wanted to bring back that distinctive feature, so we'd be very happy if you could merge this pull request.โค๏ธ

@LeeeeT
Copy link
Contributor Author

LeeeeT commented Sep 14, 2022

I think I could do a full translation of all the pages as well as fix a few formatting issues if you would ever consider adding an emoji version of the documentation, just for fun ๐Ÿ˜Š

@LeeeeT
Copy link
Contributor Author

LeeeeT commented Feb 7, 2023

Cool! ๐Ÿฅณ I'm going to finish up translating the remaining pages and prepare this for merging as promised. ๐Ÿ˜„

@github-actions
Copy link
Contributor

github-actions bot commented Mar 8, 2023

๐Ÿ“ Docs preview for commit d51f60e at: https://64090307112b5b1b116dc96e--fastapi.netlify.app

@LeeeeT LeeeeT requested review from FeeeeK and yallxe and removed request for FeeeeK and yallxe March 8, 2023 21:58
@BrycensRanch
Copy link

LGTM

@FeeeeK
Copy link
Contributor

FeeeeK commented Mar 13, 2023

@LeeeeT, I tried to send a review, but for some reason github just gives an error, I have already contacted support, I hope they will help, but for now please wait a bit.

@LeeeeT
Copy link
Contributor Author

LeeeeT commented Mar 15, 2023

Well, @FeeeeK, you can submit a pull request with your proposed changes to my fork ๐Ÿ˜‹

Copy link

@danielh2942 danielh2942 left a comment

Choose a reason for hiding this comment

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

LGTM ๐Ÿ‘

Copy link

@baseplate-admin baseplate-admin left a comment

Choose a reason for hiding this comment

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

LGTM

@github-actions
Copy link
Contributor

๐Ÿ“ Docs preview for commit 24527b5 at: https://642663a0b548622487cc93a0--fastapi.netlify.app

@github-actions
Copy link
Contributor

๐Ÿ“ Docs preview for commit d51f60e at: https://6426a87c996bf600a71bb68f--fastapi.netlify.app

@FeeeeK
Copy link
Contributor

FeeeeK commented Mar 31, 2023

Now I know that github doesn't like this
Screenshot_20230331-133513_GitHub.png

@github-actions
Copy link
Contributor

๐Ÿ“ Docs preview for commit 924c274 at: https://6426a9b35d5fc100b1db0463--fastapi.netlify.app

@LeeeeT
Copy link
Contributor Author

LeeeeT commented Mar 31, 2023

@FeeeeK It's probably for the best... ๐Ÿ˜

@LeeeeT LeeeeT requested a review from tiangolo April 1, 2023 07:47
@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2023

๐Ÿ“ Docs preview for commit 7b50132 at: https://6427f6b2a6d5896aca012137--fastapi.netlify.app

Copy link
Owner

@tiangolo tiangolo left a comment

Choose a reason for hiding this comment

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

I'm actually impressed. You did an amazing job here. The consistency of the translation from the original is great. ๐Ÿค“๐Ÿ˜Ž


I moved the content from emj toem, that simplifies the URLs and makes using the internal scripts simpler (to run the docs live locally, etc).

em is not assigned to any other language so that's fine. https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes#Table_of_all_possible_two_letter_codes


I imagine you automatized parts of it, I would love to know how you did it!


I'm also cracking up. ๐Ÿ˜‚


Thank you for your contribution! ๐Ÿ™‡๐Ÿฐ

@tiangolo tiangolo merged commit d4e85da into tiangolo:master Apr 1, 2023
10 checks passed
@FeeeeK
Copy link
Contributor

FeeeeK commented Apr 1, 2023


I imagine you automatized parts of it, I would love to know how you did it!


@tiangolo For all this, regexes were used to separate the text from code blocks, and then the translation through Yandex translator (link), and after all this, I fixed some inaccuracies and broken emojis. I think this can also be automated and converted to GitHub action, but we need to make it a little more stable.

@LeeeeT
Copy link
Contributor Author

LeeeeT commented Apr 1, 2023

Yea, it required some reverse engineering and use of private API in order to automate translating with Yandex. ๐Ÿ˜… And my script for extracting readable and translatable text from md files is... well, it's better not to see it. ๐Ÿ˜น๐Ÿ˜น Also, Yandex translator is far from ideal and some manual editing is required. So I don't think it should (and can) be automated. ๐Ÿซค

Anyway, I want to thank all the participants of this pull request. โค๏ธ You guys made the prank even funnier. ๐Ÿคช๐Ÿฅฐ

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet