search

dotnet / docfx

Static site generator for .NET API documentation.
https://dotnet.github.io/docfx/
MIT License
4.08k stars 865 forks source link

Multilanguage support #803

Open xen2 opened 8 years ago

xen2 commented 8 years ago

Is there any plan for multilanguage support?

That's probably something that could work per document, for example, MyPage.md and MyPage.jp.md (It could use default version as a fallback if no translation present)

xen2 commented 8 years ago

Note: if nothing is planned, we'll probably just build non-english doc by taking english one, overwrite the few files that are different and regenerate a full doc under a different URL (i.e. /jp instead of /en). That way, it will keep english doc for everything not translated.

FSharpCSharp commented 7 years ago

In my opinion, the topic of "multilingualism" is essential. Is there any ideas in doxFX how to best represent this? We have a similar requirement here that we need to provide help in different languages. Or is there Microsoft "Best Practices", which should be considered?

zwcloud commented 6 years ago

@FSharpCSharp The Microsoft docs uses multiple docfx sites for multilingualism, such as docs(en-us), docs.zh-cn and so on. https://github.com/dotnet?q=docs

Maybe this is the Best Practices.

FSharpCSharp commented 6 years ago

@zwcloud That's right! But apparently Microsoft also has a special docfx template to switch the languages easily. This is unfortunately not included in the standard template, which makes it very difficult to use from my point of view. I agree that it would of course be best to benefit from the templates of Microsoft docs.

fleed commented 6 years ago

@FSharpCSharp there are many advanced features from Microsoft docs that should be added to the standard template, or released as advanced template. Hopefully something will hear us..

superyyrrzz commented 6 years ago

@fleed docs.msft have some extra feature on hosting layer to make multi-lang happen. However, it might not be the same implementation for a static site generator like DocFX. It still needs some design work.

FSharpCSharp commented 6 years ago

Thank you for your answers and for supporting my statements. But I am still not quite sure whether the whole thing will be implemented or not. The topic seems to have been included in the v3 project at short notice, but has been removed immediately. Is the point even further back? This feature should be available soon if possible.

fleed commented 6 years ago

@superyyrrzz I'm also implementing a .NET core web app with a few middlewares to wrap the statically generated website.. but I feel like "reinventing the wheel"

superyyrrzz commented 6 years ago

@FSharpCSharp @fleed We haven't plan to support it in v2. I'm afraid it will not come soon.

Now we are designing v3. I removed it from board as it is not the top priority for now, but I have added it to the commnity asks. This is a valid user scenario we aim to support.

It is also welcome to share your expected input/output structure to help us better understand the request. Our best practice for docs.ms.com may not apply for other open source repos, as it heavily relies on the system behind DocFX, which is hard to open source.

FSharpCSharp commented 6 years ago

@superyyrrzz Thank you very much for the detailed answer. I find it reassuring to hear that the issue has not disappeared, but is planned for the long-term future. In my opinion, this is also essential because more and more Microsoft products are using docfx, and users are virtually forced to provide documentation or user support in similar ways.

Thank you very much for your commitment, and so on!

OsmondJiang commented 6 years ago

3343 and #3341

FSharpCSharp commented 6 years ago

@OsmondJiang It's really great that things are moving forward in this area, and a design document is already available from Microsoft! Thank you for accepting this topic.

sindharta commented 5 years ago

I saw that localization was supposed to be added in Q1 2019 in this document: https://github.com/dotnet/docfx/projects/1, but the card is still in TODO state, and the project itself seems to be "closed".

Any idea when this feature (and v3 in general) is ready for release ?

yufeih commented 5 years ago

@sindharta , localization feature is implemented in v3. But v3 currently isn't generally available for public release due to other reasons,

The project on GitHub is closed because we've switched to azure devops for workitem tracking.

sindharta commented 5 years ago

@yufeih I see. Is there any ETA when we can expect v3 to be released ?

zwcloud commented 5 years ago

we've switched to azure devops for workitem tracking.

@yufeih Where is it? I cannot see that. https://docfx.visualstudio.com/docfx/_workitems/recentlyupdated

image

yufeih commented 5 years ago

@zwcloud, it is a private azure devops project to correlate with other workitems for https://docs.microsoft.com that are close sourced.

fleed commented 5 years ago

@yufeih is https://github.com/dotnet/docfx/blob/v3/docs/roadmap.md the official place to track the progress?

yufeih commented 5 years ago

@sindharta @fleed , yes, https://github.com/dotnet/docfx/blob/v3/docs/roadmap.md is currently the official place to track progress.

chri5topherus commented 2 years ago

Are there any updates regarding the multilanguage support? Haven't found any documentation.