From de0cb6b8ccc6eb300e8465d7bbe7a54f56f46afb Mon Sep 17 00:00:00 2001 From: Halil ibrahim Kalkan Date: Tue, 18 Dec 2018 15:41:49 +0300 Subject: [PATCH] Create intro document --- .../Getting-Started-AspNetCore-Application.md | 2 +- ...Getting-Started-AspNetCore-MVC-Template.md | 2 + docs/en/Index.md | 90 ++++++------------- 3 files changed, 31 insertions(+), 63 deletions(-) diff --git a/docs/en/Getting-Started-AspNetCore-Application.md b/docs/en/Getting-Started-AspNetCore-Application.md index 8c0d03b6bb..fe1ff3450b 100644 --- a/docs/en/Getting-Started-AspNetCore-Application.md +++ b/docs/en/Getting-Started-AspNetCore-Application.md @@ -1,6 +1,6 @@ # Getting Started ABP With AspNet Core MVC Web Application -This tutorial explains how to start ABP from scratch with minimal dependencies. You generally want to start with a **[startup template](https://abp.io/Templates)**. +This tutorial explains how to start ABP from scratch with minimal dependencies. You generally want to start with the **[startup template](Getting-Started-AspNetCore-MVC-Template.md)**. ## Create A New Project diff --git a/docs/en/Getting-Started-AspNetCore-MVC-Template.md b/docs/en/Getting-Started-AspNetCore-MVC-Template.md index 665cec98b1..de9a5b09cb 100644 --- a/docs/en/Getting-Started-AspNetCore-MVC-Template.md +++ b/docs/en/Getting-Started-AspNetCore-MVC-Template.md @@ -1,5 +1,7 @@ ## ASP.NET Core MVC Template +This tutorials explains how to create a new ASP.NET Core MVC web application using the startup template, configure and run it. + ### Creating a new project Go to [the template creation page](https://abp.io/Templates), enter a project name and create your project as shown below: diff --git a/docs/en/Index.md b/docs/en/Index.md index 18df429102..df0cab524a 100644 --- a/docs/en/Index.md +++ b/docs/en/Index.md @@ -1,64 +1,30 @@ # ABP Documentation -* Getting Started - * From Startup Templates - * [ASP.NET Core MVC Template](Getting-Started-AspNetCore-MVC-Template.md) - * From Empty Projects - * [With Console Application](Getting-Started-Console-Application.md) - * [With ASP.NET Core Web Application](Getting-Started-AspNetCore-Application.md) -* Tutorials - * Application Development - * [With ASP.NET Core MVC](Tutorials/AspNetCore-Mvc/Part-I.md) -* Fundamentals - * [Dependency Injection](Dependency-Injection.md) - * [AutoFac Integration](Autofac-Integration.md) - * [Virtual File System](Virtual-File-System.md) - * [Localization](Localization.md) - * [Exception Handling](Exception-Handling.md) - * Validation - * Authorization - * Caching - * Auditing - * Setting Management - * Object to Object Mapping - * AutoMapper Integration -* Events - * Event Bus (local) - * Distributed Event Bus - * RabbitMQ Integration -* Services - * Object Serialization - * JSON Serialization - * Emailing - * GUIDs - * Threading - * Timing -* [Multi Tenancy](Multi-Tenancy.md) -* Module Development - * [Basics](Module-Development-Basics.md) - * Plug-In Modules - * [Best Practices](Best-Practices/Index.md) -* Domain Driven Design - * Domain Layer - * [Entities & Aggregate Roots](Entities.md) - * Value Objects - * [Repositories](Repositories.md) - * Domain Services - * Specifications - * Application Layer - * Application Services - * Data Transfer Objects - * Unit Of Work -* ASP.NET Core MVC - * API Versioning - * User Interface - * [Client Side Package Management](AspNetCore/Client-Side-Package-Management.md) - * [Bundling & Minification](AspNetCore/Bundling-Minification.md) - * [Tag Helpers](Tag-Helpers.md) - * [Theming](AspNetCore/Theming.md) -* Data Access - * [Entity Framework Core Integration](Entity-Framework-Core.md) - * [MongoDB Integration](MongoDB.md) -* Background - * [Background Jobs](Background-Jobs.md) -* Testing +ABP is an **open source application framework** focused on ASP.NET Core based web application development, but also supports developing other types of applications. + +Explore the left navigation menu to deep dive in the documentation. + +## Project Status + +ABP is the **next generation** of the open source [ASP.NET Boilerplate](https://aspnetboilerplate.com/) framework. It's currently in early preview stage and not ready to use in production. The documentation is in progress and currently is very incomplete. + +For short-term and production applications, it's suggested to use the [ASP.NET Boilerplate](https://aspnetboilerplate.com/) framework which is feature rich, mature, maintained and up-to-date. + +## Getting Started + +Easiest way to start a new project with ABP is to use the Startup templates: + +* [ASP.NET Core MVC Template](Getting-Started-AspNetCore-MVC-Template.md) + +If you want to start from scratch (with an empty project) then manually install the ABP framework, use following tutorials: + +* [Console Application](Getting-Started-Console-Application.md) +* [ASP.NET Core Web Application](Getting-Started-AspNetCore-Application.md) + +## Source Code + +ABP is being developed on GitHub. See [the source code](https://github.com/abpframework/abp). + +## Want to Contribute? + +ABP is a community-driven open source project. See [the contribution guide](Contribution/Index.md) if you want to be a part of this project. \ No newline at end of file