Migration docs revamp. #24630
Migration docs revamp. #24630
Conversation
…ikowsky/docs into migrationdocsphaseone
…ikowsky/docs into migrationdocsphaseone
…ikowsky/docs into migrationdocsphaseone
…ikowsky/docs into migrationdocsphaseone
…ikowsky/docs into migrationdocsphaseone
…ikowsky/docs into migrationdocsphaseone
|
@adegeo in the preview I am seeing the Migration > Create a porting plan > Project structure page doing something strange, the navigation pane on the left changes and I can't figure out why? |
|
@StephenBonikowsky I have no idea :( by all accounts it should work fine. |
Co-authored-by: Andy (Steve) De George <[email protected]>
Co-authored-by: Andy (Steve) De George <[email protected]>
* Update with the minimal changes needed to align existing content to the new TOC. * Adding the new page 'tooling-requirements.md' and adding initial content to resolve dotnet#24568 * Created additional pages needed for Phase 1 modifying the TOC as needed. * Created additional pages needed for Phase 1 modifying the TOC as needed. * Update docs/core/porting/premigration-needed-changes.md * Update docs/core/porting/premigration-needed-changes.md * Add breaking change page. * Add breaking change page. * Update tooling requirements page based on feedback. * Update breaking changes page. * Update breaking changes page. * Rename and move thepage about sdk, msbuild and vs versioning. * Rename and move thepage about sdk, msbuild and vs versioning. * Latest round of feedback updates. * Latest round of feedback updates. * Update docs/core/porting/breaking-changes.md Co-authored-by: Andy (Steve) De George <[email protected]> * Update breaking-changes.md * Update versioning....md * Upgrade porting-approaches.md * Upgrade premigration-needed-changes.md * Upgrade project-structure.md * Upgrade unsupported-apis.md * TOC naming changes * Update docs/core/porting/project-structure.md Co-authored-by: Andy (Steve) De George <[email protected]> * Update docs/core/porting/project-structure.md Co-authored-by: Andy (Steve) De George <[email protected]> * Update porting-approaches.md * Update premigration-needed-changes.md Co-authored-by: Andy (Steve) De George <[email protected]> Co-authored-by: Andy De George (adegeo) <[email protected]>
| href: ../core/porting/upgrade-assistant-aspnetmvc.md | ||
| - name: Breaking changes | ||
| displayName: app compatibility | ||
| href: ../core/porting/breaking-changes.md |
There was a problem hiding this comment.
@adegeo @StephenBonikowsky What was the inspiration behind replacing the link to the /core/compatibility TOC with a link to a new /core/porting/breaking-changes.md article? This effectively orphans the /core/compatibility TOC.
There was a problem hiding this comment.
By TOC do you mean this "Types of compatibility" page? (https://learn.microsoft.com/en-us/dotnet/core/compatibility/categories)
If so, we still link to it from https://learn.microsoft.com/en-us/dotnet/core/porting/breaking-changes#types-of-compatibility
A lot changed so I can't give you reasoning for that specific change. There is a lot more content desired for the whole 'Migration guide' section but priorities and resourcing hasn't permitted getting back to it.
There was a problem hiding this comment.
Sorry, I meant "table of contents". The "compatibility" table of contents is separate to the main .NET table of contents, and so it needs to be linked from the main table of contents. But by understanding the thinking behind your change of linking to a new article, I can perhaps find a different place to link to it.
There was a problem hiding this comment.
@gewarren If I remember correctly, it was to too much open information, versus the guided philosophy of the new migration guide. Instead, a new "breaking changes" page for the migration guide was created to give context FIRST, and then if they desired, they can check out the breaking changes TOC. This way, they're not overwhelmed with "here are the 1000 types of breaking things you'll have to watch out for" which may sway them away from migrating off of .NET Framework.
4 participants
Related to #23561
Phase 1 is supposed to be the smallest possible set of changes to get the existing documentation mapped to the new TOC design.
The modifications to docs/fundamentals/toc.yml reflect this minimal set of changes.
These changes and additional content related changes are tracked with the Migration guide project.
Next steps are to make the content related changes as listed in the 'Phase 1' column of the project and start getting reviews and feedback.
Existing Migration Docs
Preview Migration Docs