pnp/cli-microsoft365

Script samples could also show CLI version

Open

#6,240 opened on Aug 11, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)TypeScript (399 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (1,390 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, in our docs we do not show which version of CLI was used when some script was written. image

This may lead to problems when someone tries one of our scripts with latest version of CLI. Some things could already changed and some options could already be deprecated. Of course it would be best if we would keep our scripts inline with latest major version but it is a lot of work and we may still just miss something.

in the Microsoft Adoption sample gallery this info is shown

image

It's kept in the sample.json in which we store all sample metadata image

It would be best if we could also show this on our docs also coming from the sample.json asset so we won't need to maintain the version in two places.

Contributor guide

Research direction
Review the sample.json structure and the current documentation rendering to identify where and how to inject the CLI version from the metadata. Look at the docs generation code or templates to add a version badge or note sourced from sample.json.
Tech stack
typescript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitCLI usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65