(docs) Add convention about installer arguments #2388
Conversation
AdmiringWorm
force-pushed
the
docs-installer-args
branch
from
fd70138
to
8c09ccb
Compare
|
✅ Package verification completed without issues. PR is now pending human review |
1 similar comment
|
✅ Package verification completed without issues. PR is now pending human review |
There was a problem hiding this comment.
This is a really useful addition @AdmiringWorm. Thanks for putting it together.
Added a few questions and tweaks.
This updates the COMMITTERS contribution documentation to include information about what silent arguments that should be used with each of the technologies that are commonly used.
AdmiringWorm
force-pushed
the
docs-installer-args
branch
from
8c09ccb
to
926b9ab
Compare
|
✅ Package verification completed without issues. PR is now pending human review |
|
@pauby I have rewritten just about the entire section, and changed the list of the installer technologies to have their own section with a bit more information. I also think I caught all the grammar errors you noted (if I didn't I'll blame LanguageTool). Please let me know if something doesn't make any sense. |
|
|
||
| To determine installers and the possible support of arguments, there are three utilities available on the Chocolatey Community Repository that may be used, and it is expected that anyone working on this repository has these installed. | ||
|
|
||
| 1. The easiest utility to use to determine an installer is the [Universal Silent Switch Finder][]. When it determines the installer, it also suggests what the arguments to use to make the installation silent. Verify these arguments with the below information about what should be used in this repository. |
There was a problem hiding this comment.
| 1. The easiest utility to use to determine an installer is the [Universal Silent Switch Finder][]. When it determines the installer, it also suggests what the arguments to use to make the installation silent. Verify these arguments with the below information about what should be used in this repository. | |
| 1. The easiest utility to use to determine an installer is the [Universal Silent Switch Finder][]. When it determines the installer, it also suggests the arguments to use to make the installation silent. Verify these arguments with the below information about what should be used in this repository. |
There was a problem hiding this comment.
Arguably either this or ending the sentence with an "are"?
|
|
||
| The easiest way to figure out if this property is supported or not is to make use of the [LessMSI][] utility. | ||
| This can be done by first launching the utility and passing in the path to the executable. | ||
| ```cmd |
There was a problem hiding this comment.
| ```cmd | |
| ```cmd |
Very minor, but markdown generally suggests having empty lines around codeblocks. Matches other uses in the document, too.
| Documentation and information about this installer can be found [here](https://github.com/Squirrel/Squirrel.Windows). | ||
|
|
||
| The arguments used when coming across this installer are: | ||
| ```cmd |
There was a problem hiding this comment.
| ```cmd | |
| ```cmd |
| lessmsi-gui C:\path\to\installer.msi | ||
| ``` | ||
|
|
||
| The following exit codes should always be specified as valid: `0`, `1641`, `3010`. |
There was a problem hiding this comment.
I feel like this line should be outside of the "how to use LessMSI to check AllUsers" section. Perhaps above it?
There was a problem hiding this comment.
I think moving it further down, to be right after the silent arguments would be more appropriate.
This is similar to what I did for the Inno Setup documentation part.
Description
This updates the COMMITTERS contribution documentation to include
information about what silent arguments that should be used with each of
the technologies that are commonly used.
Motivation and Context
To try to standardize the conventions we use in this repository, or are moving towards using.
How Has this Been Tested?
N/A
Screenshot (if appropriate, usually isn't needed):
Types of changes
- [ ] Bug fix (non-breaking change which fixes an issue)- [ ] New feature (non-breaking change which adds functionality)- [ ] Breaking change (fix or feature that would cause existing functionality to change)- [ ] Migrated package (a package has been migrated from another repository)Checklist:
- [ ] My code follows the code style of this repository.- [ ] My change requires a change to documentation (this usually means the notes in the description of a package).- [ ] I have updated the package description and it is less than 4000 characters.- [ ] All files are up to date with the latest Contributing Guidelines- [ ] The added/modified package passed install/uninstall in the chocolatey test environment.- [ ] The changes only affect a single package (not including meta package).