microsoftgraph / microsoftgraph/msgraph-sdk-powershell

Release cycle of MS Graph PS modules should be documented

Open
#1,307 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug: Documentation
Dominant language
C#
Stars
898
Forks
230
Avg merge
2d 5h
Merged PRs (30d)
31

Description

Users ask questions like the following which could be solved by documenting the release frequency of the ms graph ps modules to PowerShell Gallery:

  • How often is MS Graph PS updated (i.e. daily, weekly, monthly, etc.)?
  • When will new API xxxx show up in MS Graph PS in PowerShell Gallery?
  • What should I do if I don't see a command that I expect to be present in MS Graph PS?

Opportunities for documenting this include:

  • The overview article, in particular the "Features" section could include the fact that new commands for APIs are released at frequency X as a "feature": https://docs.microsoft.com/en-us/powershell/microsoftgraph/overview?view=graph-powershell-beta
  • The installation section, which could include a recommendation to use the Update-Module commands with some frequency as a way to keep up with the latest commands
  • Any troubleshooting articles where the topic of "what if I can't find a command" comes up
  • The section on using Find-MgGraphCommand could note that updating to the latest microsoft.graph.authentication is required for the command to be accurate, and note the release cycle for emphasis.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the overview article's Features section and the installation, troubleshooting, and Find-MgGraphCommand documentation sections linked in the issue. Confirm the release frequency with project maintainers, then document when APIs and commands appear, how users can update modules, and what to do when a command is missing. Done means these guidance points are covered consistently in the relevant articles.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.