From bb328d9c237808743dc32235aab8acd70a4ea77f Mon Sep 17 00:00:00 2001 From: Bala Raman Date: Fri, 20 Apr 2018 19:32:01 -0400 Subject: [PATCH 1/3] Converting FAQ to English Signed-off-by: Bala Raman --- docs/faq.en-US.md | 82 +++++++++++++++++++++++++++++++++++ docs/{faq.md => faq.zh-CN.md} | 4 +- 2 files changed, 83 insertions(+), 3 deletions(-) create mode 100644 docs/faq.en-US.md rename docs/{faq.md => faq.zh-CN.md} (98%) diff --git a/docs/faq.en-US.md b/docs/faq.en-US.md new file mode 100644 index 000000000..afb641fc9 --- /dev/null +++ b/docs/faq.en-US.md @@ -0,0 +1,82 @@ +--- +order: 22 +title: FAQ +type: Other +--- + +Before you ask a question, please check the following FAQ. + +--- + +### What is the difference between Ant Design React and Ant Design Pro? + +It can be understood that Ant Design React is a set of React component libraries, and Pro is a complete front-end scaffolding using this set of component libraries. + +### How to use Ant Design Pro? + +Please read the document [Getting Started](/docs/getting-started), and Ant Financial users please read [Getting Started (Ants Financial User)] (/docs/getting-start-inner). + +### Can I use Ant Design Pro in a production environment? + +Of course you can! Ant Design Pro is based on the latest antd version. There are currently multiple middle and backend projects in use. + +### How to update Ant Design Pro? + +- Upgrade the `antd` version separately for updating the base components. +- Compare the differences between different Ant Design Pro versions and manually modify the local configuration. +- You can also try merging remote branches: `git pull https://github.com/ant-design/ant-design-pro` (note that you need to resolve conflicts yourself). +- Copy the latest typical template directly on GitHub. + +### `npm test` hangs on `MacOS Sierra`? + +You need to install [watchman](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-test-hangs-on-macos-sierra). + +### How to modify the default webpack configuration? + +See [roadhog configuration](https://github.com/sorrycc/roadhog#configuration) for details. + +### How to add babel plugins? + +See details [roadhog extraBabelPlugins](https://github.com/sorrycc/roadhog#extrababelplugins). + +### How to use static resources such as pictures? + +Absolute paths can be used directly (map support is required). If you want to use local files directly, you can import them as follows. + +```jsx + +``` + +### How is my `#` number in my url? How to get rid of? + +Please refer to the deploy document [Routing and server integration](/docs/deploy#Routing-and-server-integration). + +### How to add scss support? + +Open the `sass` configuration in `.webpackrc`, see [sass] (https://github.com/sorrycc/roadhog#sass). + +### Git commit error? + + + +Scaffolding defaults to the [eslint](http://eslint.org/) code style check. Please follow the prompts and resubmit it, or you can manually check `npm run lint`. + +### How to disable browser automatically when npm start is disabled? + +Modify `scripts.start` in `package.json` to: + +```js +"start": "cross-env BROWSER=none roadhog server", +``` + +### Does the site support internationalization? + +This is one of the features of Ant Design Pro. The first version is currently available in Chinese. Internationalization will be our top priority in the next step. + +### English Documentation? + +English Documentation will be translated in next couple of monthes, trace [ant-design/ant-design-pro#54](https://github.com/ant-design/ant-design-pro/issues/54#issuecomment-340804479) + +--- + +More FAQs can be found in [Trouble Shooting] (https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#troubleshooting) and [roadhog] ( Https://github.com/sorrycc/roadhog). If this does not solve your problem, please [Report to us] (https://github.com/ant-design/ant-design-pro/issues). \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.zh-CN.md similarity index 98% rename from docs/faq.md rename to docs/faq.zh-CN.md index edf7d8ccc..b02b1f97a 100644 --- a/docs/faq.md +++ b/docs/faq.zh-CN.md @@ -1,8 +1,6 @@ --- order: 22 -title: - en-US: FAQ - zh-CN: 常见问题 +title: 常见问题 type: 其他 --- From 3bb5670a9fadd40297ea13dcc0b848ddadf8d163 Mon Sep 17 00:00:00 2001 From: Bala Raman Date: Sat, 21 Apr 2018 12:24:52 -0400 Subject: [PATCH 2/3] Added reference to #ant-design/ant-design-pro/issues/120 Signed-off-by: Bala Raman --- docs/faq.en-US.md | 2 +- docs/faq.zh-CN.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/faq.en-US.md b/docs/faq.en-US.md index afb641fc9..a8bb4da42 100644 --- a/docs/faq.en-US.md +++ b/docs/faq.en-US.md @@ -75,7 +75,7 @@ This is one of the features of Ant Design Pro. The first version is currently av ### English Documentation? -English Documentation will be translated in next couple of monthes, trace [ant-design/ant-design-pro#54](https://github.com/ant-design/ant-design-pro/issues/54#issuecomment-340804479) +English Documentation will be translated in next couple of monthes, trace [ant-design/ant-design-pro#54](https://github.com/ant-design/ant-design-pro/issues/54#issuecomment-340804479) and [ant-design-pro/issues/120](https://github.com/ant-design/ant-design-pro/issues/120) for more detail. --- diff --git a/docs/faq.zh-CN.md b/docs/faq.zh-CN.md index b02b1f97a..2a003bd29 100644 --- a/docs/faq.zh-CN.md +++ b/docs/faq.zh-CN.md @@ -75,7 +75,8 @@ type: 其他 ### English Documentation? -English Documentation will be translated in next couple of monthes, trace [ant-design/ant-design-pro#54](https://github.com/ant-design/ant-design-pro/issues/54#issuecomment-340804479) +English Documentation will be translated in next couple of monthes, trace [ant-design/ant-design-pro#54](https://github.com/ant-design/ant-design-pro/issues/54#issuecomment-340804479) +和[ant-design-pro/issues/120](https://github.com/ant-design/ant-design-pro/issues/120）了解更多细节。 --- From 8440ab40b96b98927941ed8535a7a9882846b38f Mon Sep 17 00:00:00 2001 From: Bala Raman Date: Sat, 21 Apr 2018 23:20:04 -0400 Subject: [PATCH 3/3] Faq updates based on review Signed-off-by: Bala Raman --- docs/faq.en-US.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/faq.en-US.md b/docs/faq.en-US.md index a8bb4da42..e01f7c6fa 100644 --- a/docs/faq.en-US.md +++ b/docs/faq.en-US.md @@ -61,7 +61,7 @@ Open the `sass` configuration in `.webpackrc`, see [sass] (https://github.com/so Scaffolding defaults to the [eslint](http://eslint.org/) code style check. Please follow the prompts and resubmit it, or you can manually check `npm run lint`. -### How to disable browser automatically when npm start is disabled? +### Disable browser opening automatically on `npm start` Modify `scripts.start` in `package.json` to: @@ -69,9 +69,9 @@ Modify `scripts.start` in `package.json` to: "start": "cross-env BROWSER=none roadhog server", ``` -### Does the site support internationalization? +### Does Ant Design Pro support internationalization? -This is one of the features of Ant Design Pro. The first version is currently available in Chinese. Internationalization will be our top priority in the next step. +This is one of the features of Ant Design Pro. The first version is currently available in Chinese. Internationalization is in our 2.0 plan and will be released soon. ### English Documentation?