Skip to content

Documentation

Sébastien Levert edited this page Jul 25, 2023 · 4 revisions

Documentation

The Microsoft Graph Toolkit documentation is hosted in a separate repository and managed by the Microsoft Graph docs team. When creating PRs that add functionality to the toolkit, you will also need to add or update the toolkit documentation at the same time. This could be anything from adding a sentence or two in an existing documentation page, or adding an entire new page for larger features.

Documentation https://docs.microsoft.com/graph/toolkit/overview
Documentation Source https://github.com/microsoftgraph/microsoft-graph-docs/tree/main/concepts/toolkit

Contributing to Microsoft Graph Toolkit docs

For an overview on how to contribute to Microsoft Docs, visit the Microsoft Docs contributor guide. The guide is the best place to learn about how to contribute to any Microsoft documentation on docs.microsoft.com.

The toolkit documentation is hosted as part of the larger Microsoft Graph documentation. If you are making larger updates to the toolkit docs, such as changes across multiple pages or adding new pages, you will first need to start by cloning the Microsoft Graph docs repo

> git clone https://github.com/microsoftgraph/microsoft-graph-docs

> cd microsoft-graph-docs

This repository contains the documentation for all Microsoft Graph documentation, but the toolkit documentation is found under concepts\toolkit. You can open this folder in vscode and make your changes there

cd .\concepts\toolkit
code .

What branch should I target?

main

The main branch contains the source for the documentation you see on docs.microsoft.com. If you are updating the documentation for features that have already been released in the toolkit, base your changes from the main branch. Your changes should be live within 24 hours after the PR has been merged.

mgt/next

The mgt/next branch is our work-in-progress branch for documentation that will be published alongside the next toolkit release. If you are documenting a new feature, create your Pull Request against the mgt/next branch. Your changes will be published when the next release of the toolkit has been released.

Linking PRs across repositories

When creating a PR in the toolkit repository, and your PR adds a new feature, you will also need to create a docs PR as described here. Once you've created both PRs, make sure to edit the description of both PRs and add link to the other PR so we know which docs PR belongs to what feature PR.