Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(docs) Update documentation for CPMR0067 #1102

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

AdmiringWorm
Copy link
Member

Description Of Changes

This updates the documentation that is stubbed out for the Chocolatey
Community Package Validator rule CPMR0067, by including information
about the rule.

Motivation and Context

To keep the rules we have documented.

Testing

  • I have previewed these changes using the Docker Container or another method before submitting this pull request.

Change Types Made

  • Minor documentation fix (typos etc.).
  • Major documentation change (refactoring, reformatting or adding documentation to existing page).
  • New documentation page added.
  • The change I have made should have a video added, and I have raised an issue for this.
    • Issue #

Change Checklist

  • Requires a change to menu structure (top or left-hand side)/
  • Menu structure has been updated

Related Issue

N/A

This updates the documentation that is stubbed out for the Chocolatey
Community Package Validator rule CPMR0067, by including information
about the rule.
Copy link
Member

@pauby pauby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of comments, questions and changes.

## Issue

In the nuspec,
In the nuspec, the tag `notSilent` has been specified, indicating that the package is not silent. Normally this means that a window will be shown with a progressbar, or automated using Autohotkey.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In the nuspec, the tag `notSilent` has been specified, indicating that the package is not silent. Normally this means that a window will be shown with a progressbar, or automated using Autohotkey.
In the nuspec, the tag `notSilent` has been specified, indicating that the package is not silent, which means that there is some indication that an install, upgrade or uninstall is taking place such as a window bieng shown, a progress bar or something else that is visible.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't add in the part about Autohotkey as I wasn't sure it was relevant?


## Reasoning

The tag `notSilent` should only be used to indicate that the package is not silent.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The tag `notSilent` should only be used to indicate that the package is not silent.
The tag `notSilent` should only be used to indicate that the package is not silent, which means there is some indication that an install, upgrade or uninstall is taking place such as a window bieng shown, a progress bar or something else that is visible.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just added the definition from above into this one so it's clear. Happy to have the definition changed, but I think we should have it in both places so we are clear and specific.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants