Feature/documentation automation #3013
Conversation
|
|
|
Very cool @kooliokey , please rebase to release branch for this PR. |
kooliokey
force-pushed
the
feature/documentation-automation
branch
from
8e47b02
to
eb08d6e
Compare
I rebased off |
|
Yes, we haven't merge the master to feature. You can skip the commit not yours during the rebase. |
kooliokey
force-pushed
the
feature/documentation-automation
branch
2 times, most recently
from
0251b25
to
6f02d14
Compare
…XML comments and attributes in the library. Translation will be done where necessary to generate the Chineese site. Did some small code clean up on the way. Removed or removed from public APIs: AnchorLink.LinkDom Button.RemoveAnimationAfter Button.Icons - never used Calendar.PrefixCls All date pickers - method OnOkClick Descriptions.Items ListItem.PrefixName AntList.PrefixName ListItemMeta.PrefixName Menu.Submenus Menu.MenuItems Transfer.ChildContent Table.ColumnContext Space.SetClass Steps.Handler Radio.OnClick
kooliokey
force-pushed
the
feature/documentation-automation
branch
from
6f02d14
to
7aedb59
Compare
Codecov ReportBase: 43.11% // Head: 43.17% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## feature #3013 +/- ##
===========================================
+ Coverage 43.11% 43.17% +0.06%
===========================================
Files 556 559 +3
Lines 26176 26174 -2
Branches 263 263
===========================================
+ Hits 11285 11300 +15
+ Misses 14851 14834 -17
Partials 40 40
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
hello @kooliokey , google tanslate service is not available in China, so we may need to use bing. |
Oh, I didn't realize that. I'll have to see if it is possible to use Bing this way. Ideally we need to replace this implementation with a real API. Are there any that Microsoft gives for being in the dot net foundation? Or maybe some service you can get since the project is open source? |
|
@ElderJames We may be able to get away with using Azure Translator's API. It allows 2 million characters a month for free. The total characters currently translated are just under 95k so we could translate the entire documentation 21 times a month. I can set up an account for me to test with. Could a Github build translate in PRs and commit the change to the JSON file to the PR? I think that's the only way it would make sense for an API requiring credentials to be used. Individuals could always provide their own to run locally if desired. Pricing https://azure.microsoft.com/en-us/pricing/details/cognitive-services/translator/#pricing |
…ate appsettings JSON file to translate locally with it.
kooliokey
force-pushed
the
feature/documentation-automation
branch
from
37ba11a
to
9712250
Compare
@ElderJames I went ahead and added an |
|
Thank you @kooliokey , I think we need to fallback to English while the translate service is blocken. |
…cache not cache it and return text asked to translate.
Yeah, that makes sense. I went ahead and did that now. It also won't cache it so that when build is ran again it will still try to translate it since it wasn't able to the first time. |
|
That's fine. I will continue to fix the building and merge. |
|
@ElderJames Is there anything I can do to help get this merged? |
|
@ElderJames Would this action help with committing the changes to the translations made in the PR? https://github.com/marketplace/actions/git-auto-commit Looks like it allows committing changes to the branch of the PR and lets you provide a glob pattern for selecting the file(s) to commit which would let us just target the translation cache file. |
|
@kooliokey Thank you, I will rebase these commits to the feature branch. |
|
I haven't success to build the site yet. 😂 |
2 similar comments
|
I haven't success to build the site yet. 😂 |
|
I haven't success to build the site yet. 😂 |
|
@kooliokey We will merge this feature when we rewrite the documentation site for antd v5. |
🤔 This is a ...
🔗 Related issue link
#2832
💡 Background and solution
Documentation for the site will now be automatically generated with a combination of XML documentation comments and data attributes put on library components. All comments are expected/assumed to be in English and translations are made to generate the Chinese documentation. We still retain the ability to specify the Chinese translation for summaries though in cases where the automatic translation may be invalid.
Full details can be read in the new markdown file
DOCUMENTATION.mdin this PR.There are also a handful of spots where things were never used that have been removed. It may be worth skimming through to generate a changelog at somepoint for those changes.
📝 Changelog
☑️ Self Check before Merge