Skip to content

docs(v2): releasing i18n blog post#4367

Merged
slorber merged 12 commits into
masterfrom
slorber/i18n-blog-post
Mar 9, 2021
Merged

docs(v2): releasing i18n blog post#4367
slorber merged 12 commits into
masterfrom
slorber/i18n-blog-post

Conversation

@slorber

@slorber slorber commented Mar 9, 2021

Copy link
Copy Markdown
Collaborator

Motivation

https://deploy-preview-4367--docusaurus-2.netlify.app/classic/blog/2021/03/09/releasing-docusaurus-i18n

(broken links are expected, they'll be fixed once all things are online)

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Mar 9, 2021
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 9, 2021
@netlify

netlify Bot commented Mar 9, 2021

Copy link
Copy Markdown

Deploy preview for docusaurus-2 ready!

Built with commit 85157be

https://deploy-preview-4367--docusaurus-2.netlify.app

@netlify

netlify Bot commented Mar 9, 2021

Copy link
Copy Markdown

[V1] Deploy preview success

Built with commit 85157be

https://deploy-preview-4367--docusaurus-1.netlify.app

@github-actions

github-actions Bot commented Mar 9, 2021

Copy link
Copy Markdown

Size Change: +31.5 kB (+6%) 🔍

Total Size: 564 kB

Filename Size Change
website/build/assets/js/main.********.js 390 kB +31 kB (+9%) 🔍
website/build/blog/2017/12/14/introducing-docusaurus/index.html 60.7 kB +329 B (+1%)
website/build/index.html 25.6 kB +184 B (+1%)
ℹ️ View Unchanged
Filename Size Change
website/build/assets/css/styles.********.css 87.3 kB 0 B
website/build/docs/introduction/index.html 235 B 0 B

compressed-size-action

Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
Comment thread website/docs/i18n/i18n-introduction.md Outdated
@github-actions

github-actions Bot commented Mar 9, 2021

Copy link
Copy Markdown

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 80
🟢 Accessibility 96
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-4367--docusaurus-2.netlify.app/classic/

@lex111 lex111 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

@JoelMarcey JoelMarcey left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I can't tell you how happy this blog post makes me ☺️

Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
- **Scalable build-times**: allow building and deploying localized sites independently.
- **Localize assets**: an image of your site might contain text that should be translated.
- **No coupling**: not forced to use any SaaS, yet the integration is possible.
- **Easy to use with [Crowdin](https://crowdin.com/)**: multiple Docusaurus 1 sites use Crowdin, and should be able to migrate to v2.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You use the word "should" here. What would prevent a Docusaurus v1 site from not being able to migrate? Do we have a migration path / information for migrating? I think you can say something like:

multiple Docusaurus 1 sites use Crowdin, and we continue to support this valuable platform, including migration to v2.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I still have to write this migration doc, it's in the top of my list.

I don't think we should say "docusaurus has first class support for crowdin". The 2 systems are 100% decoupled and we don't ship any code to add crowdin support, it just happens that both solutions are compatible.

Not sure it's a. good idea to commit to providing support in the place of the Crowdin support team

Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
- **Simple**: just put the translated files in the correct file-system location.
- **Flexible translation workflows**: based on Git (monorepo, forks, or submodules), SaaS software, FTP...
- **Flexible deployment options**: single, multiple domains, or hybrid.
- **Modular**: allow plugin authors to provide i18n support.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we have documentation about how to do this? Maybe link to it?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

this is also some api doc that is top priority for me to add.

Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
- **Low-overhead runtime**: documentation is mostly static and does not require a heavy JS library or polyfills.
- **Scalable build-times**: allow building and deploying localized sites independently.
- **Localize assets**: an image of your site might contain text that should be translated.
- **No coupling**: not forced to use any SaaS, yet the integration is possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe give an example of a SaaS that you could integrate with in this bullet too.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

The next line mention Crowdin already, that does not seem too useful?

Maybe I should write "Easy to use with the Crowdin SaaS" instead to make it clearer Crowdin is such SaaS for which the integration is possible?

Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated

@yangshun yangshun left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks awesome!!!

Comment thread website-1.x/blog/2021-03-09-releasing-docusaurus-i18n.md Outdated
Comment thread website/docs/i18n/i18n-introduction.md Outdated
@slorber slorber changed the title docs(v2): draft docs(v2): releasing i18n blog post Mar 9, 2021
@slorber slorber marked this pull request as ready for review March 9, 2021 16:34
@slorber slorber merged commit b7a6665 into master Mar 9, 2021
@slorber slorber deleted the slorber/i18n-blog-post branch August 17, 2021 17:50
mrizwanashiq pushed a commit to mrizwanashiq/docusaurus that referenced this pull request Jun 25, 2026
* add social card

* Complete the i18n blog post

* update blog post

* add missing v1 images

* improve the blog post

* update blog post

* update blog post

* fix bad file-system wording

* add mention of dogfooding

* translate the blog post into french + mention it!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants