Giter VIP home page Giter VIP logo

dotnet / aspnetcore.docs Goto Github PK

View Code? Open in Web Editor NEW
12.4K 706.0 25.3K 814.41 MB

Documentation for ASP.NET Core

Home Page: https://docs.microsoft.com/aspnet/core

License: Creative Commons Attribution 4.0 International

HTML 27.58% C# 60.55% CSS 1.71% JavaScript 6.08% PowerShell 0.26% TypeScript 0.50% Ruby 0.01% Dockerfile 0.01% Java 0.01% TSQL 0.01% ASP.NET 0.01% Rich Text Format 0.31% Less 2.98%
aspnetcore aspnet-core aspnet docs asp

aspnetcore.docs's Introduction

aspnetcore.docs's People

Contributors

01binary avatar analogrelay avatar ardalis avatar badersur avatar bradygaster avatar brennanconroy avatar camsoper avatar captainsafia avatar damienbod avatar danroth27 avatar daveabrock avatar dependabot[bot] avatar fiyazbinhasan avatar githubpang avatar guardrex avatar hakenr avatar halter73 avatar jamesnk avatar nschonni avatar pranavkm avatar rachelappel avatar rick-anderson avatar scottaddie avatar serpent5 avatar shirhatti avatar spboyer avatar tdykstra avatar timdeschryver avatar user135711 avatar wadepickett avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

aspnetcore.docs's Issues

Create a New NuGet Package with DNX

ASP.NET 5->.NET Execution Environment (DNX)->Create a New NuGet Package with DNX

  • Create a new DNX project for your package (link to DNX projects article)
    • Various project.json properties map to package metadata: authors, description, version, etc
    • Package id will match the DNX project name (folder name by default, no way to change it yet)
    • Version can have -*. Set DNX_BUILD_VERSION env var on your build server to specify the replacement for the version wildcard.
    • Pointer to DNX commands article for creating command packages
  • Targeting multiple frameworks
    • Each framework under frameworks maps to a folder under lib in your package that gets built for you by DNX automatically
    • Target framework specific dependencies are handled for you
    • Specify set of frameworks that you can target (.NET 2.0?, PCLs? Silverlight? etc)
  • Building your package
    • dnu pack will do a build and create your package and symbol package
    • Dependencies/frameworkAssemblies will automatically get handled
    • Limitations:
  • Publishing your package
    • Upload to your favorite package feed (nuget.org, myget.org, internal company feed, etc)
    • Note: Uploading to nuget.org requires you to have a description . . .

Application Startup

ASP.NET 5->Runtime->Application Startup

  • Accessing and using available runtime services during Startup
  • Startup class conventions and discovery
    • Assembly determined by config (Hosting:Application), otherwise application name
    • Class named Startup in any namespace
    • Can be static (but then you get no DI)
  • ConfigureServices
    • Link to DI (#65)
    • Can return IServiceProvider for wiring up 3rd party IoC (reference DI topic)
    • Analogous to app.UseServices(services => { services.AddMvc(); ... })
  • Configure
    • Must be public and return void
    • Used to construct a middleware pipeline using IApplicationBuilder
      • Link to Middleware (#109) topic
  • Link to Environments content with

Creating a Cross-Platform Console App with DNX

ASP.NET 5->.NET Execution Environment (DNX)->Creating a Cross-Platform Console App with DNX

  • Create a Console Application (Package)
  • Building and publishing your cross-platform console app
  • Running your cross-platform app

Yeoman article

Noel's booked until later in April when he expects to write this article.

Using Commands

ASP.NET 5->.NET Execution Environment (DNX)->Using Commands

  • What is a command?
  • Using commands in your project
    • Examples: web, kestrel, test, ef?
  • Running commands using dnx.exe
    • dnx [command]
    • dnx run
  • Global commands
    • Installing
      • Done by package ID
      • Note: only global NuGet.Config is used
      • Option to override (--overwrite)
    • Running
      • Always run with the active DNX
    • Uninstalling
      • Done by command name
    • Built-in global commands (user-secrets, sqlservercache)
  • Building and publishing global commands
    • Create a new DNX Console app (ref existing article)
    • Define a command in commands section
    • Build as a package (dnu pack or option in VS)
    • Publish to your feed

Working with DNX Projects

ASP.NET 5->.NET Execution Environment->Working with DNX Projects

  • Creating a new project
  • Targeting multiple frameworks
  • Adding dependencies
  • Restoring packages
  • Project lock file
  • Referencing other projects
  • Adding package metadata

Working with Static Files

ASP.NET 5->Runtime->Working with Static Files

  • Servicing static files
  • Directory browsing
  • Default files
    • URL rewrite to point to default files (ex index.html) if they exist
    • Generally used in conjunction with static file middleware
  • File Server = Static files + directory browsing + default files
  • Common options
    • Custom IFileProvider (ex service files from location other than web root or from embedded assembly resources)
    • "Request path" specifies a common prefix in the URL to handle
  • General notes
    • Generally configure early in pipeline - everything falls through if the file/dir doesn't exist

DI / IoC

port my DI doc from HTML to reStructuredText

Improve "Migrating Configuration" with description of all common cases

Configuration is a big topic. In a common web app on old ASP.NET we'd have roughly the following stuff in web.config:

  • appSettings with simple key-value settings of the app and libs
  • standard sections from .NET like system.diagnostics
  • settings for asp.net - system.web
  • settings for web server - system.webServer
  • custom sections - sections of 3rd party registered in configSections element (please pay attention that these libs can be not related with asp.net at all, just some libs)

The article only talks about the first one - appSettings. Yeah, they are easily converted to anything as it's just key-value pair.
But what to do with the others?

The most unclear thing for me is custom sections. Just imagine you used some library. And that library supports configuration - it uses ConfigurationManager which just uses "system configuration file". And now it's empty. We could say something like "do not expect the lib to configure itself from configuration file, configure it on your own via its api". It makes sense indeed. But it breaks my app. It breaks any app. Moreover the lib could not support the same abilities via Api as via config.

I'm not sure that here is a good place to discus the design "deprecating System.Configuration". But anyway consequences of that design should be clearly stated in the docs.
Thanks.

The .NET Execution Environment (DNX)

Getting Started->Conceptual Overview->The .NET Execution Environment (DNX)

  • What is the .NET Execution Environment (DNX)?
  • Why build DNX?
  • Projects
  • Dependencies
  • Packages and feeds
  • Commands
  • Application Host
  • Meta programming
  • Dependency injection
  • Publishing
  • DNX Version Manager

Introduction to ASP.NET 5

Getting Started->Conceptual Overview->Introduction to ASP.NET 5

  • What is ASP.NET 5?
  • Why build ASP.NET 5?
  • Modern Web apps in the Cloud
  • Application lifecycle
  • Middleware
  • Configuration
  • Dependency injection
  • Options
  • Hosting
  • Servers
  • Web root
  • Client-side development

Servers

ASP.NET 5->Fundamentals->Servers

  • Servers accept incoming requests and make them available to the application pipeline
  • Built-in servers (list request features and configuration parameters supported, process model, .NET flavor and OS support)
    • IIS
    • WebListener
    • Kestrel
  • Guidance on when to use which server
    • Prefer Windows optimized servers (IIS, WebListener) on Windows.
    • Use IIS for general web hosting and WebListener for custom hosting in your own process or service.
    • Use Kestrel for non-Windows environments
  • Server specific programmatic configuration using IApplicationBuilder.Server
    • Downcast and configure
  • Custom
    • Implement IServerFactory
    • Create a feature collection per request and invoke the provided application delegate
      • Mandatory features: IHttpRequestFeature and IHttpResponseFeature
      • All other features are optional
    • See #58 for details on how to use a custom server with ASP.NET Hosting

Your First ASP.NET 5 Application on a Mac

Getting Started -> Tutorials -> Your First ASP.NET 5 Application on a Mac

  • Dev setup
  • Scaffold app using Yeoman
  • Run locally using Kestrel
  • Publish to Azure (Kudu? Linux VM? Docker?)

Guidance for Hosting Providers

ASP.NET 5->Runtime->Hosting

  • Setting up a server environment
  • Multi-tenant hosting
  • Servicing
  • Directory Structure
  • Http PlatformHandler
  • Isolation by AppPools
  • Data Protection
  • Hosting off UNC shares
  • Log redirection

Migrate Grunt/Gulp articles

  • Grunt and Gulp Task Runners
  • Bower Package Manager
  • Bootstrap Responsive Web Framework
  • LESS, SASS, Font Awesome,
  • TypeScript
  • Knockout.js
  • Backbone.js
  • Angular.js
  • React.js

I am ready to translate

I am ready to translate to pt_BR.

Where are the rules for translation?
It would be nice to have it in the project wiki.

Add how to build in README.md

To let people not familiar with sphinx build these docs, add that python 2, pip, sphinx and the "sphinx_rtd_theme" module must be installed to the README. The theme is installed like so:

sudo pip install sphinx_rtd_theme

Migrating an Existing NuGet Package Project

ASP.NET 5->.NET Execution Environment (DNX)->Migrating an Existing NuGet Pacakge to Support .NET Core

  • Why use DNX to build your NuGet packages?
  • Cross-compilation
  • Adding support for .NET Core
  • Building portable libraries

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.