(GH-697) Automatically generate documentation #720
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ferventcoder
force-pushed
the
generated-docs
branch
2 times, most recently
from
ad91000 to
027d014
Compare
This adds the current items from the wiki prior to auto generated docs
The generator will create documents as UTF8 w/BOM, so ensure all documents are prepped and ready for the changes.
ferventcoder
force-pushed
the
generated-docs
branch
from
027d014 to
6892ee5
Compare
Generate documentation for Commands and Helpers (PowerShell Functions) automatically. - Like the current documentation, generate the command call in parentheses next to the current command name. - Add command reference specific - Convert commands in reference to links - Check for the "See It In Action" header - Add all commands to be generated - Add notice about auto generation - Headers for formatting - Remove options and switches note and reimplement - Replace `command` and `choco command` with links to the wiki documents - Replace gif links with actual images - convert the packages.config section - Replace links for Chocolatey Pro/Business - Write out how to rerun powershell commands to see the helper documentation - Ensure parameters are capitalized - All line endings should be CRLF - Ensure each parameter is listed on its own line in syntax - Ensure the parameters in syntax are TitleCase. - Replace community feed and community repository with url to dot org packages page.
ferventcoder
force-pushed
the
generated-docs
branch
from
6892ee5 to
eee6871
Compare
Update all of the code with documentation based on what is needed and what is already available on the wiki. This will allow documentation to have one source of truth regarding Commands and PowerShell Helpers.
Update the generated documentation with the result of GenerateDocs.ps1.
Some packages should be able to support 64 bit only. In those cases Chocolatey should allow 32 bit urls to be optional and fail the package on 32 bit systems with a helpful message.
Keep around the alias for Get-ProcessorBits though.
- Don't call a method on a null variable - Return empty headers if the url is null
This will allow cmdlet bindings but still allow for splatting with parameters that would not apply, which works when you do not have cmdlet bindings, but doesn't work with cmdlet bindings without this switch.
Get-FtpFile has not received all of the enhancements/fixes that Get-WebFile has received. Apply those to Get-FtpFile as well - Explicit proxy - Request/ReadWriteTimeout - Better error handling - Explicitly close used resources when done. - Exit code on 404.
Reversing the adding of an environment variable is just setting that environment variable to null. Have a function that handles that.
ferventcoder
force-pushed
the
generated-docs
branch
from
794fc1c to
9007474
Compare
ferventcoder
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Help for wiki and other places should be automatically generated from running commands and from the PowerShell Help documentation in the Installer Module.
Closes #697
Closes #527
Closes #713
Closes #765
Closes #772