dotnet / dotnet/AspNetCore.Docs

Re-structure host and deploy docs

Open
#18,411 5 comments 1 reaction 0 assignees View on GitHub
doc-idea re-Aditya
Dominant language
C#
Stars
13.1k
Forks
24.6k
Avg merge
1d 3h
Merged PRs (30d)
97

Description

Today we conflate host and deploy in the same section and I think re-structuring can improve the clarity of the docs. One set of the docs should explain how to configure each of the servers (IIS, Kestrel, HttpSys) and all of the knobs exposed for common things.

For deployment, we should explain the top level concerns and show how to accomplish those depending on how you are deploying. For example, some top level concerns of deployment are:

- How do I get files to the deployment target?
- Process management - How do I keep my application running? (crashes etc)
- Configuring HTTPs in production - How do I setup HTTPS
- How do I do Let's Encrypt HTTPs certs?
- How do I do certificate rotation in various environments?
- How do I manage certs in production?
- How do I get an A+ rating on https://www.ssllabs.com/ssltest/?
- How do I deploy a new version of my application?
- How do I achieve zero downtime deployments?
- How do I monitor my application after it's deployed?

Then we can even have more specifics depending on application type:
- Static file configuration
- Compression configuration
- WebSocket configuration

Then we take each of those concerns and write a doc that describes how to accomplish them depending on where you're going:
- Windows + IIS
- Windows + Windows Services
- Linux
- Linux + Docker
- Azure App Service
- Kubernetes
- ACI

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.