Split Kestrel docs into smaller, more focused pages to improve readability#21091
Merged
Conversation
halter73
force-pushed
the
halter73/split-kestrel
branch
from
acad571 to
0296086
Compare
halter73
commented
Jan 1, 2021
Member
Author
|
The build report is now clean! |
JamesNK
reviewed
Jan 1, 2021
JamesNK
reviewed
Jan 1, 2021
Member
|
I like it. One improvement is the overview page needs to summarize some of the other pages. Overview should have Configuring options and Configuring endpoints sections that show a basic example, and then link to the other pages with more information. |
Tratcher
approved these changes
Jan 4, 2021
Member
Tratcher
left a comment
Tratcher
left a comment
There was a problem hiding this comment.
I've mostly limited my review to the high level structure. I think the Endpoints doc needs a re-write after this.
jkotalik
reviewed
Jan 4, 2021
jkotalik
approved these changes
Jan 4, 2021
This was referenced Jan 4, 2021
scottaddie
reviewed
Jan 5, 2021
JamesNK
reviewed
Jan 14, 2021
Co-authored-by: James Newton-King <james@newtonking.com>
Co-authored-by: James Newton-King <james@newtonking.com>
halter73
force-pushed
the
halter73/split-kestrel
branch
4 times, most recently
from
b8248e7 to
815dc3f
Compare
halter73
force-pushed
the
halter73/split-kestrel
branch
from
815dc3f to
ff9d1a5
Compare
scottaddie
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Internal Review
This is an attempt to see what it would look like to split Kestrel's docs into multiple pages so it doesn't feel so overwhelming to read and edit. This is inspired by the IIS documentation which is split up similarly. This only tries to update the aspnetcore-5.0 moniker.
I did my best to fix up the internal deep links referencing the aspnetcore5.0 version of kestrel.md. I also added
<a name="old-section-name"></a>above the links to the new subpages to help with external deep links that may already be referencing aspnetcore-5.0.Thoughts?