{WIP}(GH-697) Automatically generate documentation #703
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
|
This involves quite a bit of work to bring the code in sync with the wiki so that we don't overwrite some of the documentation. This also really improves the look and feel of the PowerShell documentation. |
ferventcoder
force-pushed
the
generated-docs
branch
from
9a8df27
to
77d15f3
Compare
ferventcoder
changed the title
ferventcoder
force-pushed
the
generated-docs
branch
3 times, most recently
from
bb2688b
to
8bc6f5a
Compare
Once every ten runs or so, randomly mention the professional and business versions. This will help bring awareness for users that won't be aware in any other way. When a user is using install directory override through the install arguments, provide awareness that there is a feature that will save them the trouble of spending extra time determining the install directory themselves.
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.
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.
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.
ferventcoder
force-pushed
the
generated-docs
branch
from
8bc6f5a
to
dbee6b8
Compare
|
Superseded by #720 - I targeted the wrong branch here |
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