Let us learn about Learn to Fix Microsoft SCCM Intune Documentation Configuration Manager ConfigMgr. How many of us complaint about SCCM Intune documentation?
The documentation is not updated and not relevant etc.. Here is the real opportunity to help yourself and update SCCM and Intune documentation.
But don’t get worried about the quality of the SCCM Intune documentation, as there are several steps of validation before your edits/changes get published. Hack a doc is the theme of this post 😉
Check out the Video “Learn How to Help Fixing SCCM Intune Documentation Issues“
We had a great MVPHackaDoc session with Aaron during the MVP Summit 2018. All the credits to Aaron taught me how to start updating SCCM/Intune documentation. I don’t recommend going around and editing or updating all the documentation. But start small before you leap.
Start Small
What is changed?
Microsoft documentation service (https://docs.microsoft.com) is hosted on the GitHub platform, and this helps to get a better user experience while reading the documentation.
Even SCCM and Intune documents have been migrated to a new platform. Following is my list of key features of new docs—Microsoft platform.
- Readability
- Estimated Reading Time
- Content and Site Navigation
- Shortened Article Length
- Responsive Design
- Community Contributions
- Social Sharing
- Friendly URLs
How to Start Updating SCCM Intune Documentation?
I hope you have gone through a lot of Microsoft documentation every day. Find out the wrong article, and you wanted to let the Microsoft doc team know about this incorrect info.
- Create a GitHub account if you don’t have one. Creating a GitHub account took me one and 2 minutes for me.
- Select the GitHub Free plan as part of the signup process, and Tailor your experience should be filled with a short intro about yourself.
- Open the article you identified and click on the EDIT button, as I showed in the video tutorial. You should open the article from the same browser you already logged in from your GitHub account.
- Once you click on the EDIT button on that article, it will redirect to the GitHub editor.
- GitHub editor is the place where you will perform all the updates.
Identify Article and Start Contributing
How to Contribute to SCCM Intune Documentation
As Aaron mentioned in his “MVP Hack a Doc” session, start small. Standard GitHub accounts may not have any access to edit the code of live documents. And you will get the following error when you try to edit or update an article.
- You’re editing a file in a project you don’t have write access to.
- Submitting a change to this file will write it to a new branch in your fork.
- AnoopCNair/SCCMdocs, so you can send a pull request.
As I have shown in the “Hack A Doc“ video, A perfect example of raising an issue from Jason. He raised a problem, and a documentation BUG is filed to fix this issue.
Creating a PULL request is another option that I tried. But I think that needs more access to edit the master file. A normal GitHub account may not have access to proceed with a pull request.
Another interesting learning for me was tipping about selecting the best title, title suffix, description, ms. Custom, ms. Date, and ms. prod for technical articles. As Aaron suggested, we can start doing the following things:-
- Clarifications
- Examples
- SDK, PowerShell
- Guidance tips
- Translations
- See something, fix something
I have tried raising an issue with documentation, and that is the best and easy part that I learned during the MVPHackaDoc session. I have more details about the problems raised in Hack A Doc’s video tutorial.
Another useful option trying to try to track the documentation issues with th GitHub account. So we can rest assured that Microsoft is aware of this bug, and they will fix it soon. Following is the file structure of GitHub article (for example) SCCMdocs/sccm/core/plan-design/hierarchy/accounts.md .
Start Contributing = Raising an Issue
Resources
- Basic writing and formatting syntax
- https://msdn.microsoft.com/en-us/communitydocs/community/edit-docs-on-github-guide
- https://docs.microsoft.com/en-us/teamblog/introducing-docs-microsoft-com
Author
Anoop is Microsoft MVP! He is a Solution Architect in enterprise client management with more than 20 years of experience (calculation done in 2021) in IT. He is Blogger, Speaker, and Local User Group HTMD Community leader. His main focus is on Device Management technologies like SCCM 2012, Current Branch, and Intune. He writes about ConfigMgr, Windows 11, Windows 10, Azure AD, Microsoft Intune, Windows 365, AVD, etc……………
