Skip to content

docs: move to VuePress #627

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

Merged
merged 9 commits into from
May 21, 2018
Merged

docs: move to VuePress #627

merged 9 commits into from
May 21, 2018

Conversation

eddyerburgh
Copy link
Member

@eddyerburgh eddyerburgh commented May 18, 2018

[ ] Add config docs
[ ] Add Japanese translations to config.js
[ ] Link Chinese translations correctly
[ ] Link Japanese translations correctly
[ ] Add redirects

@Jinjiang
Copy link
Member

Any help needed for Chinese translation please let me know.

@eddyerburgh
Copy link
Member Author

eddyerburgh commented May 19, 2018

Thanks @Jinjiang 😄

I need Chinese translations for:
Utilities for testing Vue components

And @38elements I need Japanese translations for:
Utilities for testing Vue components
Japanese
Languages
Edit this page on GitHub

Thank you 🙏

@38elements
Copy link
Contributor

Utilities for testing Vue components -> Vue コンポーネントをテストするためのユーティリティ
Japanese -> 日本語
Languages -> 言語
Edit this page on GitHub -> GitHub 上でこのページを編集する

@Jinjiang
Copy link
Member

Utilities for testing Vue components -> 测试 Vue 组件的实用工具

@eddyerburgh eddyerburgh merged commit 5b5319d into vuejs:dev May 21, 2018
@eddyerburgh eddyerburgh deleted the move-to-vuepress branch May 21, 2018 16:00
@kazupon
Copy link
Member

kazupon commented May 21, 2018

🎉

1 similar comment
@ulivz
Copy link
Member

ulivz commented May 21, 2018

🎉

@lex111
Copy link
Contributor

lex111 commented May 23, 2018

Hey!

Why were other translations removed? How can I restore Russian translation?

@eddyerburgh
Copy link
Member Author

@lex111 unfortunately we can only support languages that receive regular updates. If the translations are not updated regularly, they become out of sync with the real documentation.

I'm grateful for the work translating the docs to different languages, but it's difficult for us to keep these translations up-to-date, especially if no core team members speak the language. Some of the translations we had were very out of date.

The plan was to remove all translations except Chinese, but the Japanese translations also receive very regular (several times a week) updates, so we know they will be kept up to date.

You are welcome to fork and host the translation on their own, but we no longer have the bandwidth to include them in official repos

@lex111
Copy link
Contributor

lex111 commented May 23, 2018

@eddyerburgh I understand you, but we actively support translations, you probably know that about our community (https://github.com/translation-gang/), which also maintains an up-to-date official website with Vue documentation in Russian.

As for the documentation for this tool, it was not very old, we are not comfortable with tracking changes (maybe we do not know how to do it right or better, it's possible to track updates in automatic or semi-automatic mode? Please share with us the best practices about translation actualization), and then we are used to having your own repository for translation when is possible, because it's more convenient to us to do translation updates.

But give us you another chance, updates for Russian documentation are not very big, we feel sorry if our work is lost, because fewer people will know about the existence of the translation 😢

We are a community of translators, we are not so many, but we want and try to keep the documents up-to-date, we are interested in it!

@lex111
Copy link
Contributor

lex111 commented May 23, 2018

@eddyerburgh

Since now you generate documentation using your own tool, I suggest that you consider the next possibility associated with translations.

What if we do not delete all the translations, even if they have not been updated for a long time, but to mark them, that they are obsolete? It's easier to show by example, see how it's done at https://elixirschool.com
I will specify better, I mean something like an indicator of the relevance of the translation, and now I'll show you how it looks.

When the translation is relevant (no needs updates, it's synchronized), the "green circle" will be displayed
Page - https://elixirschool.com/en/lessons/basics/basics/
image

But, for example, on this page the translation needs to be updated (it's not synchronized), and now you can see the "orange circle", which means that the content on this page (translation) is out of date (needs to be updated), because the original doc was slightly updated.

image

And there is also a "red circle", which indicates that the translation is very outdated. For example, this is now on this page.

image

How do you like this idea? It would be cool to implement this, what are the advantages?

  • (most importantly) Remain all translations (this is the work of people, someone, even the old version, will benefit, plus it will motivate other people to update the translation in accordance with the original, I want to believe it! 😃 )
  • You can visually find out that the translation is up-to-date or not, it is useful, both for translators, for and for readers of translation.
  • Just as a suggestion, leave everything as is :)

Thus, you discharge your responsibility by making an explanatory message (for example, that the translation is out of date, refer to the original), if the translation is out of date, and other people, for example, can update it. Think about it, it's a good idea, in my opinion!

@eddyerburgh
Copy link
Member Author

eddyerburgh commented Jun 9, 2018

@lex111 Sorry for the delayed response.

If you guys can keep the translations in sync then we can host them again.

Next time, if they are out of sync I will remove them temporarily until they are updated. I won't remove them from the repo completely without first speaking with you.

@lex111
Copy link
Contributor

lex111 commented Jun 10, 2018

@eddyerburgh

And what about the indication of the translation described in the comment?

Can there be any recommendations to keep the documentation up to date?

Now we need PR with an actual Russian translation?

@eddyerburgh
Copy link
Member Author

At the moment, the plan is to remove them temporarily if they become out of date.

I don't have recommendations for keeping translations up to date. @38elements do you have suggestions for keeping translations up to date?

Yes, we'll accept a PR with translations.

@38elements
Copy link
Contributor

38elements commented Jun 10, 2018

You can check the change history at below page.
It is better to check the page and translate the changes at once a week.

English document of API
https://github.com/vuejs/vue-test-utils/commits/dev/docs/api

English document of guides
https://github.com/vuejs/vue-test-utils/commits/dev/docs/guides

All document
https://github.com/vuejs/vue-test-utils/commits/dev/docs

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.

6 participants