PowerShell / PowerShell/DSC

Proposed additional canonical properties

Open
#201 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
523
Forks
75
Avg merge
3d 16h
Merged PRs (30d)
24

Description

Summary of the new feature / enhancement

Suggesting the following for discussion and consideration. This is based on a review of 2500 resources currently available in the PowerShell Gallery. The motivation to include items from this list (some or all) is to standardize across resources so that users have a consistent experience across resources from many authors. Of course, anyone can choose to drop the underscore and re-implement for any reason.

See technical details section for suggested list.

Additional considerations for discussion that feel a bit more like they would have specific implementation requirements so might not be suitable?
"Server"
"Database"
"State"

Finally, it might be worth discussing if it would be possible to standardize a password parameter to lead authors towards best practices for security. Referencing a secure password service rather than storing the string in a file, for example.
"Password"

Proposed technical implementation details

_name

title: Name
description: >-
  Indicates a short string that provides a name for the instance.
type: string

_description

title: Description
description: >-
  Indicates a long string that provides details about the instance.
type: string

_version

title: Version
description: >-
  Indicates a version number for the instance. Semantic version format is preferred but not required.
type: string

_path

title: File System Path
description: >-
  Indicates the path to a file or folder represented in DOS, UNC, or Files System Hierarchy format. Should not be used for Internet locations.
type: string

_url

title: Uniform Resource Locator
description: >-
  Indicates a reference to a specific Internet resource using format protocol://nameorip:port/path. Offen used when referencing untrusted content. A URI path is also acceptable.
type: string

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 by reviewing issue #201 and its proposed technical implementation details, including the YAML definitions for _name, _description, _version, _path, and _url. Clarify which additional properties, including Server, Database, State, and Password, are in scope and what acceptance criteria would define the final standardized schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell, yaml
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.