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

Multi language and framework support #28

Merged
merged 28 commits into from
Jun 15, 2018
Merged

Conversation

domyen
Copy link
Member

@domyen domyen commented Jun 1, 2018

This PR encapsulates the work necessary to support multiple languages and frameworks.

Todo

@domyen domyen added the DO NOT MERGE In progress PRs label Jun 1, 2018
@tmeasday
Copy link
Member

@domyen how are we going to deal with the intersection between languages and frameworks? e.g. we aren't going to have Spanish text for the Vue code. I don't know if the translators are going to be keen to do multiple versions.

Perhaps the chooser should be more lang+framework at the same time:

  • React / English
  • Vue / English
  • React / Spanish
  • Add another?

@tmeasday
Copy link
Member

Additionally, what do we want the URLs to look like?

Do we want to special case the React/English URLs (so say learnstorybook.com/get-started goes to React/English) or fully qualify everything (so it'd be learnstorybook.com/react/english/get-started), or both?

@tmeasday
Copy link
Member

tmeasday commented Jun 13, 2018

Also we have a few strings littered through the UI, should we translate them too?

  • 'Tweet "I'm learning Storybook! It’s a great dev tool for UI components."'
  • 'Next chapter'
  • 'Edit on GitHub'
  • 'Keep your code in sync with this chapter. View {commit} on GitHub'
  • 'Table of Contents'

A little dodgy and there a still quite a few unanswered questions.
@tmeasday
Copy link
Member

@domyen did a first pass at this just to remind myself of how Gatsby works and think about potential solutions. Let's resolve the questions above and I can do it for real.

@tmeasday tmeasday assigned domyen and tmeasday and unassigned tmeasday Jun 13, 2018
@domyen domyen mentioned this pull request Jun 13, 2018
@domyen
Copy link
Member Author

domyen commented Jun 13, 2018

URL strawman

  • We fully qualify all urls (but default to React + English with the appropriate redirects).
  • URL syntax is learnstorybook.com/react/en/get-started (use language shorthand for languages)
  • File system should mirror the URL. So we need to add /react and /vue under /content.

Localization of UI
Punt for now. Let's just work on supporting the content.

Picker UI
Your suggestion makes sense. Will update the picker to be formatted like this:

image

Copy link
Contributor

@icarlossz icarlossz left a comment

Choose a reason for hiding this comment

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

Looks great, if you need help i'm in!

@tmeasday tmeasday force-pushed the language-framework-picker branch from 0666939 to 6f2d786 Compare June 14, 2018 10:46
@tmeasday
Copy link
Member

@domyen take a look at this now. I think it's pretty close to done (for React en/es).

Let me know what I missed. It's not the cleanest ever but it works. I'd like to do a pass over it and get linting working and clean up a bit once we are satisfied with the functionality.

@domyen
Copy link
Member Author

domyen commented Jun 14, 2018

This looks great!

Todo

  • Hook the React tooltip link up so that it changes depending on which framework you select.
  • Refactor the language meta tags (my commit, still very raw) so that tags are automatically generated for each new language. Each chapter should have a meta tag to all alternate versions in other languages.
  • "Edit on GitHub" link on each chapter should go to the appropriate language directory

Once this is done, I think we're all clear to merge and ship it.

Copy link
Contributor

@icarlossz icarlossz left a comment

Choose a reason for hiding this comment

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

Looks great, just fix the twitter part and be synchronized with the github repo that is being shown in english.

@domyen
Copy link
Member Author

domyen commented Jun 14, 2018

@icarlossz do you mean the twitter message "I'm learning Storybook..."?

And great catch re:github "edit on GitHub" link!

@icarlossz
Copy link
Contributor

Yep @domyen

@tmeasday
Copy link
Member

Are we planning on translating the internal language (e.g. the tweet?).

Otherwise I think this is good to go, let's merge and we can make any fixes on master

@tmeasday
Copy link
Member

Going to merge this! Hope I didn't mess up the spanish @icarlossz

@tmeasday tmeasday merged commit 1816fe8 into master Jun 15, 2018
@tmeasday tmeasday deleted the language-framework-picker branch June 15, 2018 03:43
@domyen domyen removed the DO NOT MERGE In progress PRs label Jun 15, 2018
jonniebigodes pushed a commit that referenced this pull request Jun 17, 2022
* ✍️ Update: Design Systems For Developers > Introduction 번역 교정

* Update: Architecture revise

* Update: Build revise

* Update: Review revise

* Update: Review revise2
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.

3 participants