Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

Publish documentation translations #161

Closed
nzakas opened this issue Nov 25, 2015 · 15 comments
Closed

Publish documentation translations #161

nzakas opened this issue Nov 25, 2015 · 15 comments
Labels
documentation Relates to ESLint's documentation enhancement This change enhances an existing feature of the website

Comments

@nzakas
Copy link
Member

nzakas commented Nov 25, 2015

We have the opportunity to have Chinese translations for our documentation. Some things we need to figure out:

  1. How would we store this documentation in the repo? (Is it a separate repo?)
  2. How will people get to it? (cn.ESLint.org? eslint.org/cn?)
  3. How can we do this in a way that doesn't negatively affect SEO?
@eslintbot eslintbot added the triage An ESLint team member will look at this issue soon label Nov 25, 2015
@ilyavolodin
Copy link
Member

If we are talking specifically about Chinese translation, then as far as I understand, offer implied maintaining a separate repository and a completely separate site. I don't think it would be great idea to merge translations into this repository and use our existing site for it, since we would need to do a release every time translations are updated.

@nzakas
Copy link
Member Author

nzakas commented Nov 25, 2015

Yes, that's what the offer was, I'm looking at additional options. I want to make sure we are considering all possibilities before diving in.

@ilyavolodin
Copy link
Member

Well, I think I definitely wouldn't want to keep rule documentation translations in eslint main repository, since it would require release for publishing every time and would in general create a bunch of commits unrelated to the core project.
Keeping it in this repository vs. having a separate repository doesn't seem to make much of a difference, other then, with a separate repository, merges can be done with somebody who actually knows the language, instead of us just guessing. Separate repository implies separate site (unless we create some scripts to copy content from one repository to another, which doesn't seem all that necessary)

@nzakas
Copy link
Member Author

nzakas commented Nov 25, 2015

I'm not opposed to having a separate repo,, but what would we do about share CSS, images, etc? Manually copy them whenever they changed?

@ilyavolodin
Copy link
Member

Good point, I'm actually not 100% sure what to do about those. Doesn't Github allow for nested repositories somehow? I though I saw something like that. Could we possibly use that?

@mysticatea
Copy link
Member

Node.js seems to have repositories for localization: e.g. https://github.com/nodejs?utf8=%E2%9C%93&query=ja

I image that "gensite" script takes localization contents from those repositories.
At the time, the script inserts a note "this translated content might be old" if the localization content is older than original.

@nzakas
Copy link
Member Author

nzakas commented Dec 18, 2015

Okay, so we can start with a separate repo.

@molee1905
Copy link
Contributor

molee1905 commented Dec 21, 2015

Well, vuejs has the same characteristic, with separated repo and new branches.

it seems that there is not a better solution than this for now .

Actually, in the past three weeks, with the efforts of my teammates, the translation is basically completed without proofreading, and has been published to a temporary site mixing Chinese and English.

In my plan, after the completion of proofreading, the final Chinese version of ESLint will be born in the coming weeks。

So, may it be possible to be published to http://cn.eslint.org or http://eslint.cn ?

@nzakas
Copy link
Member Author

nzakas commented Dec 21, 2015

Yes, if I setup a repo for cn.ESLint.org, can you use that?

@nzakas
Copy link
Member Author

nzakas commented Dec 21, 2015

I setup a repo for cn.eslint.org. @molee1905 I've given you permission to push to that repo. Please let me know who else should have permission.

@molee1905
Copy link
Contributor

Very thanks.

Now the mixed version eslint-zh forked from eslint.github.io is on smocean, i will move it to the new repo after preliminary proofreading to eliminate typos, inaccurate or obscure statement in Chinese , and work on the new repo, to let more people take part in.

@nzakas
Copy link
Member Author

nzakas commented Dec 22, 2015

I've setup cn.eslint.org CNAME, so it's now using the new repo: http://cn.eslint.org/

@molee1905
Copy link
Contributor

http://cn.eslint.org/ is available now

@nzakas
Copy link
Member Author

nzakas commented Apr 1, 2016

Awesome!

@kaicataldo kaicataldo added documentation Relates to ESLint's documentation enhancement This change enhances an existing feature of the website and removed triage An ESLint team member will look at this issue soon labels Jun 18, 2019
@kaicataldo
Copy link
Member

Closing this since the work for this specific task is done. Further discussion is occurring here.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Relates to ESLint's documentation enhancement This change enhances an existing feature of the website
Projects
None yet
Development

No branches or pull requests

6 participants