Remove md shortcuts and their references #5372
Merged
Conversation
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
ghost
added
the
gewarren
approved these changes
Feb 25, 2021
Contributor
gewarren
left a comment
gewarren
left a comment
There was a problem hiding this comment.
This is awesome. Thanks @carlossanlop! For the XAML2009 replacement, just wondering if there should be a space in the middle.
Contributor
Author
|
I would not have done it if you had not suggested it, @gewarren :) You're talking about I'll merge until the CI starts working again. |
gewarren
reviewed
Feb 25, 2021
Contributor
gewarren
left a comment
gewarren
left a comment
There was a problem hiding this comment.
Here are the XAML2009 instances.
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
|
Docs Build status updates of commit 22dd25d:
|
|
Docs Build status updates of commit 22dd25d:
|
Contributor
Author
|
I got warnings but they do not seem to be related to my changes. @gewarren is it ok if we merge this? Edit: Got Genevieve's confirmation via chat. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
From a conversation with @gewarren, we want to remove the *.md shortcut files from the ~/include folder. These files contain texts representing official ways of calling different products or services, and they are referenced in markdown remarks all over dotnet-api-docs xmls.
We need to remove them because they prevent the DocsPortingTool from converting many remarks from CDATA+markdown into plain text (there is no way to convert INCLUDE sections to xml). We prefer to use plain xml so that Roslyn can validate triple slash comments (it is unable to validate a CDATA section).
I am requesting help from the heavy cavalry to review this huge PR: @gewarren @BillWagner @dotnet/docs @mairaw.
The PR is split in individual commits for each shortcut file to make it easier to review. I also deleted the referenced files, plus a few others that had no references anywhere.
I limited the removal of *.md files to only those whose contents have less than 80 characters. All other larger files can stay because they are what we call "lengthy remarks" and their use is repeated in many places.
In case anyone is curious, I wrote a tool to automate the substitution of all these shortcut files and uploaded it here: https://github.com/carlossanlop/experiments/tree/ShortcutReplacer
cc @jeffhandley