Refactor documentation for tools #2949
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
…ns, and enhance content clarity - Updated titles and descriptions for TFS User Mapping Tool, TFS Validate Required Field Tool, TFS Work Item Embedded Link Tool, TFS Work Item Link Tool, TFS Work Item Type Validator Tool, and Work Item Type Mapping Tool for consistency and clarity. - Expanded overviews and use cases for each tool to provide better context and understanding of their functionalities. - Improved configuration examples and common scenarios to illustrate practical applications of each tool. - Added troubleshooting sections with common issues and solutions to assist users in resolving potential problems during migration. - Enhanced good practices sections to guide users in effective tool usage and configuration management.
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://blue-river-093197403-2949.westeurope.5.azurestaticapps.net |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request introduces comprehensive improvements to both the documentation standards and the technical documentation for several migration tools. It adds new standards for list and single documentation pages, ensuring consistency and SEO-friendliness, and significantly enhances the technical reference docs for the String Manipulator Tool, TFS Attachment Tool, and TFS Changeset Mapping Tool with clearer structure, expanded configuration examples, troubleshooting, and best practices.
Documentation Standards and Structure
.github/instructions/docs.content.docs.list.instructions.mdto define standards for list pages, including front matter, content guidelines, and rules for maintaining consistency and SEO alignment..github/instructions/docs.content.docs.instructions.mdto.github/instructions/docs.content.docs.single.instructions.md, clarifying that manually added content must be preserved and specifying where such content should be placed in single documentation pages. [1] [2]Reference Documentation Improvements
docs/content/docs/reference/tools/stringmanipulatortool/index.md: Rewrote and expanded documentation for the String Manipulator Tool, adding detailed overview, configuration structure, extensive usage examples, troubleshooting, and best practices for regex-based string processing during migration. [1] [2] [3]docs/content/docs/reference/tools/tfsattachmenttool/index.md: Overhauled the TFS Attachment Tool documentation with a new overview, detailed configuration options, practical migration scenarios, troubleshooting guidance, and best practices for managing attachments during migration. [1] [2] [3]docs/content/docs/reference/tools/tfschangesetmappingtool/index.md: Rewrote the TFS Changeset Mapping Tool documentation, providing a clear overview, configuration details, migration scenarios, troubleshooting, and best practices for maintaining changeset traceability. [1] [2] [3]