From 171e250989a06dc48cc5f25037d0e462d38fd039 Mon Sep 17 00:00:00 2001 From: viztor Date: Thu, 9 Nov 2017 01:44:27 +0800 Subject: [PATCH 1/3] Add translation for getting-started page --- docs/getting-started.en-US.md | 133 ++++++++++++++++++ ...ng-started.md => getting-started.zh-CN.md} | 4 +- 2 files changed, 134 insertions(+), 3 deletions(-) create mode 100644 docs/getting-started.en-US.md rename docs/{getting-started.md => getting-started.zh-CN.md} (98%) diff --git a/docs/getting-started.en-US.md b/docs/getting-started.en-US.md new file mode 100644 index 000000000..c4dadc4fb --- /dev/null +++ b/docs/getting-started.en-US.md @@ -0,0 +1,133 @@ +--- +order: 0 +title: Getting started +type: Introduction +--- + +## Foreword + +Ant Design Pro is a production-ready solution for the admin interface. Continue on the design principles brought by [Ant Design](http://ant.design/) and with the aim of building high-level components from the basics ones; we have developed patterns, business components, and relevant design resources, to improve the user and development experience for the admin interface. +With developers' feedback, we will increment, build and consolidate patterns and corresponding implementation, conclude best practices, components, and business logic. +We welcome your particiation very much. +With those objectives, we have found discovered the following patterns, and have built a scaffold based on React.js, which helps you prototyping production-ready admin interface. + +``` +- Dashboard + - Analytic + - Monitor + - General +- Form + - Basic + - Step-based + - Advanced +- List + - Query Table + - Basic + - Card + - Search (Projects, Applications, Articles) +- Detail + - Basic + - Advanced +- Result + - Success + - Failure +- Exception + - 403 Unauthorized + - 404 Not Found + - 500 Internal Error +- Account + - Log-in + - Sign-up + - Sign-up success +``` + +### For Designer + +If you are product manager or designer, you can find [design kit](/docs/resource) here. + +### For Developer + +We will give you a detailed introduction on how to use this scaffold. + +## Preparation + +You will needs [node](http://nodejs.org/) and [git](https://git-scm.com/). The project is based on [ES2015+](http://es6.ruanyifeng.com/), [React](http://facebook.github.io/react/), [dva](http://github.com/dvajs/dva), [g2](https://antv.alipay.com/g2/doc/index.html) and [antd](https://ant.design/docs/react/introduce). It would be very helpful if you have pre-existing knowledge on those. + +## Installation + +There are three ways to install. + +### Clone Git Repository + +```bash +$ git clone --depth=1 git@github.com:ant-design/ant-design-pro.git my-project +$ cd my-project +``` + +### Download Package + +Download [https://github.com/ant-design/ant-design-pro/archive/master.zip](https://github.com/ant-design/ant-design-pro/archive/master.zip), and unzip. + +### Use Command Line + +You can also use [ant-design-pro-cli](https://github.com/ant-design/ant-design-pro-cli). + +```bash +$ npm install ant-design-pro-cli -g +$ mkdir my-project && cd my-project +$ pro init # Initialize Scaffold +``` + +## Scaffolding + +We have provided a scaffold for you, includes common routes for admins, the directory structure is presented below. + +```bash +├── mock # Local Mock Data +├── public +│   ├── favicon.ico # Favicon +│   └── index.html # HTML Entry File +├── src +│   ├── common # Common Configuration: Nav Bar +│   ├── components # Components +│   ├── e2e # Integrated Test Case +│   ├── layouts # Common Layouts +│   ├── models # dva Model +│   ├── routes # Sub-pages and templates +│   ├── services # Back-end Services +│   ├── utils # Utility +│   ├── g2.js # Dataviz Configuration +│   ├── polyfill.js # Polyfills +│   ├── theme.js # Theme Configuration +│   ├── index.js # App Entry +│   ├── index.less # Global Stylesheet +│   └── router.js # Route Entry File +├── tests # Tests +├── README.md +└── package.json +``` + +## Development + +Install Dependencies + +```bash +$ npm install +``` + + + + +```bash +$ npm start +``` + + + +After it is done, it will automatically open [http://localhost:8000](http://localhost:8000). If you see the following page, you succeed. + +Screenshot + +You're all set! +We have built-in models, standard components, mock data, hot module reloading, state management, i18n, global router, etc. +You can continue exploring other documents for more details on those topics. \ No newline at end of file diff --git a/docs/getting-started.md b/docs/getting-started.zh-CN.md similarity index 98% rename from docs/getting-started.md rename to docs/getting-started.zh-CN.md index 06422e9b3..49c60223f 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.zh-CN.md @@ -1,8 +1,6 @@ --- order: 0 -title: - en-US: Getting Started - zh-CN: 开始使用 +title: 开始使用 type: 入门 --- From d9f501ed435b0ec38d74106eccab187aa49433e3 Mon Sep 17 00:00:00 2001 From: viztor Date: Thu, 9 Nov 2017 02:04:06 +0800 Subject: [PATCH 2/3] Update for consistency with Readme --- docs/getting-started.en-US.md | 52 +++++++++++++++++------------------ 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/getting-started.en-US.md b/docs/getting-started.en-US.md index c4dadc4fb..9396f3a57 100644 --- a/docs/getting-started.en-US.md +++ b/docs/getting-started.en-US.md @@ -6,39 +6,39 @@ type: Introduction ## Foreword -Ant Design Pro is a production-ready solution for the admin interface. Continue on the design principles brought by [Ant Design](http://ant.design/) and with the aim of building high-level components from the basics ones; we have developed patterns, business components, and relevant design resources, to improve the user and development experience for the admin interface. -With developers' feedback, we will increment, build and consolidate patterns and corresponding implementation, conclude best practices, components, and business logic. +Ant Design Pro is a production-ready solution for the admin interface. Continue on the design principles brought by [Ant Design](http://ant.design/) and with the aim of building high-level components from the basics ones; we have developed templates, components, and relevant design resources, to improve the user and development experience for the admin interface. +With developers' feedback, we will increment, build and consolidate templates and corresponding implementation, conclude best practices, components, and business logic. We welcome your particiation very much. -With those objectives, we have found discovered the following patterns, and have built a scaffold based on React.js, which helps you prototyping production-ready admin interface. +With those objectives, we built the following templates, and have built a scaffold based on React.js, which should help you prototyping production-ready admin interface. ``` - Dashboard - Analytic - Monitor - - General + - Workspace - Form - - Basic - - Step-based - - Advanced + - Basic Form + - Step Form + - Advanced From - List - - Query Table - - Basic - - Card - - Search (Projects, Applications, Articles) -- Detail - - Basic - - Advanced + - Standard Table + - Standard List + - Card List + - Search List (Project/Applications/Article) +- Profile + - Simple Profile + - Advanced Profile - Result - Success - - Failure + - Failed - Exception - - 403 Unauthorized - - 404 Not Found - - 500 Internal Error -- Account - - Log-in - - Sign-up - - Sign-up success + - 403 + - 404 + - 500 +- User + - Login + - Register + - Register Result ``` ### For Designer @@ -47,7 +47,7 @@ If you are product manager or designer, you can find [design kit](/docs/resource ### For Developer -We will give you a detailed introduction on how to use this scaffold. +We will give you a detailed introduction on how to use. ## Preparation @@ -66,7 +66,7 @@ $ cd my-project ### Download Package -Download [https://github.com/ant-design/ant-design-pro/archive/master.zip](https://github.com/ant-design/ant-design-pro/archive/master.zip), and unzip. +Download [https://github.com/ant-design/ant-design-pro/archive/master.zip](https://github.com/ant-design/ant-design-pro/archive/master.zip), and un-archive. ### Use Command Line @@ -88,7 +88,7 @@ We have provided a scaffold for you, includes common routes for admins, the dire │   ├── favicon.ico # Favicon │   └── index.html # HTML Entry File ├── src -│   ├── common # Common Configuration: Nav Bar +│   ├── common # Common Configuration like Navigation │   ├── components # Components │   ├── e2e # Integrated Test Case │   ├── layouts # Common Layouts @@ -102,7 +102,7 @@ We have provided a scaffold for you, includes common routes for admins, the dire │   ├── index.js # App Entry │   ├── index.less # Global Stylesheet │   └── router.js # Route Entry File -├── tests # Tests +├── tests # Tests Configuration ├── README.md └── package.json ``` From cb4960999646206f609c32dae97d031cc2a15ca3 Mon Sep 17 00:00:00 2001 From: viztor Date: Thu, 9 Nov 2017 14:19:10 +0800 Subject: [PATCH 3/3] Fix minor problems & improve quality --- docs/getting-started.en-US.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/getting-started.en-US.md b/docs/getting-started.en-US.md index 9396f3a57..dc2b3d554 100644 --- a/docs/getting-started.en-US.md +++ b/docs/getting-started.en-US.md @@ -1,15 +1,16 @@ --- order: 0 -title: Getting started +title: Getting Started type: Introduction --- ## Foreword -Ant Design Pro is a production-ready solution for the admin interface. Continue on the design principles brought by [Ant Design](http://ant.design/) and with the aim of building high-level components from the basics ones; we have developed templates, components, and relevant design resources, to improve the user and development experience for the admin interface. -With developers' feedback, we will increment, build and consolidate templates and corresponding implementation, conclude best practices, components, and business logic. -We welcome your particiation very much. -With those objectives, we built the following templates, and have built a scaffold based on React.js, which should help you prototyping production-ready admin interface. + +Ant Design Pro is a production-ready solution for admin interfaces. Continue on the design specifications brought by [Ant Design](http://ant.design/) and with the aim of building high-level components from the basics ones; we have developed templates, components, and corresponding design kit to improve the user and development experience for admin interfaces. +With developers' feedback, we will increment, build and consolidate those templates and implementation, conclude best practices for components and business logic. Your help is much welcomed. +Bear those objectives in mind, we have built the following templates, and have built a scaffold based on React.js, which should help you prototyping production-ready admin interface. + ``` - Dashboard @@ -43,32 +44,32 @@ With those objectives, we built the following templates, and have built a scaffo ### For Designer -If you are product manager or designer, you can find [design kit](/docs/resource) here. +If you are product manager or designer, you can find the [design kit](/docs/resource) here. ### For Developer -We will give you a detailed introduction on how to use. +We will walk you through the steps to get started. ## Preparation -You will needs [node](http://nodejs.org/) and [git](https://git-scm.com/). The project is based on [ES2015+](http://es6.ruanyifeng.com/), [React](http://facebook.github.io/react/), [dva](http://github.com/dvajs/dva), [g2](https://antv.alipay.com/g2/doc/index.html) and [antd](https://ant.design/docs/react/introduce). It would be very helpful if you have pre-existing knowledge on those. +You will needs [node](http://nodejs.org/) and [git](https://git-scm.com/). The project is based on [ES2015+](http://es6.ruanyifeng.com/), [React](http://facebook.github.io/react/), [dva](http://github.com/dvajs/dva), [g2](https://antv.alipay.com/g2/doc/index.html) and [antd](https://ant.design/docs/react/introduce). It would be helpful if you have pre-existing knowledge on those. ## Installation There are three ways to install. -### Clone Git Repository +### Clone the Git Repository ```bash $ git clone --depth=1 git@github.com:ant-design/ant-design-pro.git my-project $ cd my-project ``` -### Download Package +### Download the Package Download [https://github.com/ant-design/ant-design-pro/archive/master.zip](https://github.com/ant-design/ant-design-pro/archive/master.zip), and un-archive. -### Use Command Line +### Use the Command Line You can also use [ant-design-pro-cli](https://github.com/ant-design/ant-design-pro-cli).