How to use the Configuration Manager docs
Applies to: Configuration Manager (current branch)
This article provides the following sections with multiple resources and tips for using the Configuration Manager documentation library:
For general help with the product, see Find help.
Use the following search tips to help you find the information that you need:
When using your preferred search engine to locate content for Configuration Manager, include
SCCMalong with your search keywords.
Look for results from docs.microsoft.com for Configuration Manager current branch. Results from technet.microsoft.com or msdn.microsoft.com are for older product versions.
To further focus the search results to the current content library, include
site:docs.microsoft.comto scope the search engine.
Use search terms that match terminology in the user interface and online documentation. Avoid unofficial terms or abbreviations that you might see in community content. For example, search for "management point" rather than "MP"; "deployment type" rather than "DT"; and "software updates" rather than "SUM."
To search within an article you are currently viewing, use your browser's Find feature. With most modern web browsers, press Ctrl+F and then enter your search terms.
Each article on docs.microsoft.com includes the following fields to assist with searching the content:
Search in the upper right corner. To search all articles enter terms in this field. Articles in the Configuration Manager library automatically include the "ConfigMgr" scope.
Filter by title above the left table of contents. To search the current table of contents, enter terms in this field. This field only matches terms that appear in the article titles for the current node. For example, Core Infrastructure or Application Management.
Having problems finding something? File feedback! When filing the issue, provide the search engine you're using, the keywords you tried, and the target article. This feedback helps Microsoft optimize the content for better search.
Starting in Configuration Manager version 1902, there's a Documentation node in the new Community workspace. This node includes up-to-date information about Configuration Manager documentation and support articles. For more information, see Using the Configuration Manager console
Go to the Feedback section at the bottom by clicking the Feedback link in the upper right of any article. This section is integrated with GitHub Issues. For more information about integration with GitHub Issues, see the docs platform blog post.
To share feedback on the Configuration Manager product itself, click Product feedback. For more information, see Product feedback.
A GitHub account is a prerequisite for providing documentation feedback. Once you sign in, there is a one-time authorization for MicrosoftDocs. Then when you click Content feedback, enter a title and comment, and then Submit feedback. This action files a new issue for the target article in the SCCMdocs repository.
This integration also displays any existing open or closed issues for the target article. If any exist, review them before submitting a new issue. If you find a related issue, click the face icon to add a reaction, or you can expand it to add a comment.
Types of feedback
Use GitHub Issues to submit the following types of feedback:
- Doc bug: The content is out of date, unclear, confusing, or broken.
- Doc enhancement: A suggestion to improve the article.
- Doc question: You need help finding existing documentation.
- Doc idea: A suggestion for a new article. Use this method instead of UserVoice for documentation feedback.
- Kudos: Positive feedback about a helpful or informative article!
- Localization: Feedback about content translation.
- Search engine optimization (SEO): Feedback about problems searching for content. Include the search engine, keywords, and target article in the comments.
To share feedback on the docs.microsoft.com platform, see Docs feedback. The platform includes all of the wrapper components such as the header, table of contents, and right menu. Also how the articles render in the browser, such as the font, alert boxes, and page anchors.
To receive notifications when content changes in the documentation library, use the following steps:
- Use the docs search to find an article or set of articles. For example:
- Search for a single article by title: "Log files for troubleshooting - Configuration Manager"
- Search for any article regarding SQL
- In the upper right corner, click the RSS link.
- Use this feed in any RSS application to receive notifications when there is a change to any of the search results.
You can also Watch the SCCMdocs repository on GitHub. This method generates a lot of notifications. It also doesn't include changes from a private repository used by Microsoft.
The Configuration Manager documentation library, like most content on docs.microsoft.com, is open-sourced on GitHub. This library accepts and encourages community contributions. For more information on how to get started, see the Contributor Guide. Creating a GitHub account is the only prerequisite.
Basic steps to contribute to SCCMdocs
From the target article, click Edit. This action opens the source file in GitHub.
To edit the source file, click the pencil icon.
Make changes in the markdown source. For more information, see How to use Markdown for writing Docs.
In the Propose file change section, enter the public commit comment describing what you changed. Then click Propose file change.
Scroll down and verify the changes you made. Click Create pull request to open the form. Describe why you made this change. Tag the article author and request that they review. Click Create pull request.
What to contribute
If you're interested in contributing, but don't know where to start, see the following suggestions:
Search the list of issues for the community-targeted labels:
Review an article for accuracy. Then update the ms.date metadata using
mm/dd/yyyyformat. This contribution helps keep the content fresh.
Add clarifications, examples, or guidance based on your experience. This contribution uses the power of the community to share knowledge.
Correct translations in a non-English language. This contribution improves the usability of localized content.
Large contributions require signing a Contribution License Agreement (CLA) if you aren't a Microsoft employee. GitHub automatically requires you to sign this agreement when a contribution meets the threshold.
Follow these general guidelines when contributing to Configuration Manager docs:
Don't surprise us with large pull requests. Instead, file an issue and start a discussion. Then we can agree on a direction before you invest a large amount of time.
Use the pull request template as the starting point of your work.
Follow the GitHub Flow workflow.
Blog and tweet (or whatever) about your contributions, frequently!
(This list was borrowed from the .NET contributing guide.)