arcus-azure / arcus-azure/arcus.scripting

Add automation script for code-owners to quickly add `-MaximumVersion` to the `Install-Module` command in the feature docs

Open
#241 0 comments 0 reactions 0 assignees View on GitHub
automation documentation enhancement
Dominant language
PowerShell
Stars
10
Forks
13
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**
The feature docs contain `Install-Module` commands without any version indication. This is misleading when following a guideline as you could end up installing the wrong version.

**Describe the solution you'd like**
We should add the `-MaximumVersion` to the `Install-Module` in an automation script.
This script can be run together with the Docsaurus versioning.

Contributor guide

Open the contributing guide

Research direction

Start by locating the feature documentation and the existing Docsaurus versioning automation, then inspect how Install-Module commands are represented. Done means the automation adds -MaximumVersion to each relevant command and runs with Docsaurus versioning without altering unrelated documentation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.