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

Add chinese document link into README #257

Closed
wants to merge 3 commits into from
Closed

Add chinese document link into README #257

wants to merge 3 commits into from

Conversation

CafuChino
Copy link
Contributor

A Chinese version document site has been made based on VuePress, which will be very useful for Chinese developers.

@crutchcorn
Copy link
Member

@CafuChino love that there exists a Chinese translation for the project! Thank you so much for the work you've done on this

For reference, this project is OSS and lives on @CafuChino's repo:

https://github.com/CafuChino/plop-cn-doc

(Notice the MIT license, which is important for us)

That said, there are a few concerns I have:

  1. The (as-of-now) unofficial URL of plop-js.com is easily confused with the official plopjs.com. This is rather unfortunate and seems like we may be playing a game of cat-and-mouse in terms of SEO/website memorization
  2. I would much rather have the documentation "in-house" aka in the PlopJS org. This would allow us to accept third-party contributors and maintain control over the docs as part of the project officially

Here's what I'm thinking, and I'd love your input on this (also wanting to CC @amwmedia)

Looking at Vue's official docs, they have a dropdown in the top corner that displays languages they have support in:

Translation dropdown

When clicking on the Chinese language, it brings you to a subdomain: https://cn.vuejs.org/index.html

I'm wondering if we can't do the same thing with our official domain. Something like https://cn.plopjs.com?

We'd certainly have to modify the code we're currently using to deploy, which lives at:

https://github.com/plopjs/plopjs.com

@amwmedia how feasible do you think it would be to deploy the site like that?

I admittedly haven't dealt too much with subdomains in the past, but I know @evelynhathaway could probably help us figure that out (she's the person who's done deployments for a ton of my projects and is looking to get involved in maintaining Plop with us)

Where are hosting the website? (DigitalOcean, GitHub Pages, etc?)

@amwmedia
Copy link
Member

I don't see why this would be a problem. The site is currently hosted on Netlify. I can easily create the subdomain and we could fork the existing plopjs.com repo to house the various translations. Maybe that's a good place to start? Just fork the website codebase to another repo that is CN specific. Then I can setup the subdomain and hook it up to a Netlify project for auto-deployment.

Once we have the cn.plopjs.com site working, we can add the dropdown to both sites to allow users to jump from one to the other.

Sound like a plan?

@crutchcorn
Copy link
Member

Sounds good - I've got a busy week ahead of me, but I'll try to tackle sometime early next week

@amwmedia
Copy link
Member

Do you think it would be better to build translations into the website codebase itself instead of building multiple sites? I'd love to be able to build something that works well for Chinese and other languages, without incurring too much overhead.

@crutchcorn
Copy link
Member

@CafuChino would you be willing to make a PR to this repo putting this data:

https://github.com/CafuChino/plop-cn-doc

Into a file called README.zh.md at the root?

Once that is done, I will work on making a PR against the plopjs.com repository that pulls all of the relevant README.md files and generates subroutes of:

plopjs.com/cn/documentation

@CafuChino I'd also like to offer to buy the plop-js.com domain from you. Ideally, I'd like this domain to stay with the project to avoid confusion. Please email me at github at crutchcorn . dev to talk more about this :)

@CafuChino
Copy link
Contributor Author

Sorry for my late reply! I will work on it in a few days. At the same time, I am also happy to transfer this domain name for free 😺

@crutchcorn
Copy link
Member

crutchcorn commented Jun 3, 2022

@CafuChino you're amazing, thank you! ✨

Could you send me an email at github @ crutchcorn dot d e v so that we can sort out the domain name transfer? :D

crutchcorn added a commit that referenced this pull request Jun 3, 2022
chore: Add README.zh.md Related with #257
This pull request was closed.
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

3 participants