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.

Sign up for GitHub

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

Jump to bottom

Automatic Documentation #697

Closed

ferventcoder opened this issue Apr 18, 2016 · 0 comments

Assignees

Labels

5 - Released Breaking Change Documentation Improvement

Milestone

Member

ferventcoder commented Apr 18, 2016 •

edited

Generating documentation from PowerShell Functions and Choco commands should be easier to do. Provide a way to generate documentation in a way that is easier to update.

This might be a breaking change - depending on how folks were using some of the functions.

ferventcoder self-assigned this

ferventcoder added Improvement 2 - Working Documentation labels

ferventcoder added this to the 0.9.10 milestone

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) add current helpers/commands

4a92fe3

This adds the current items from the wiki prior to auto generated docs

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) rename CommandsSources to CommandsSource

ccf6fe7

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Current Docs for Generator

7d7f87c

The generator will create documents as UTF8 w/BOM, so
ensure all documents are prepped and ready for the
changes.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Generate Documentation Automatically

15595eb

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

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Code With Documentation

f553a1f

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Generated Documentation

9a8df27

Update the generated documentation with the result
of GenerateDocs.ps1.

ferventcoder mentioned this issue

{WIP}(GH-697) Automatically generate documentation #703

Closed

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) add current helpers/commands

d44caf1

This adds the current items from the wiki prior to auto generated docs

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) rename CommandsSources to CommandsSource

3cb105e

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Current Docs for Generator

c28b4a5

The generator will create documents as UTF8 w/BOM, so
ensure all documents are prepped and ready for the
changes.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Generate Documentation Automatically

26ef274

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

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Code With Documentation

dae6729

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Generated Documentation

ed7a33b

Update the generated documentation with the result
of GenerateDocs.ps1.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) genned docs fix

b5d9fa7

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) code docs squash

77d15f3

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Code With Documentation

8b19ec1

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Generated Documentation

4cd9cca

Update the generated documentation with the result
of GenerateDocs.ps1.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Code With Documentation

b18d78a

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Generated Documentation

5035b26

Update the generated documentation with the result
of GenerateDocs.ps1.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Generate Documentation Automatically

c20fe3a

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 added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Code With Documentation

1381dcd

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Generated Documentation

1ec0620

Update the generated documentation with the result
of GenerateDocs.ps1.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) add current helpers/commands

9d778a9

This adds the current items from the wiki prior to auto generated docs

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) rename CommandsSources to CommandsSource

bef728f

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Current Docs for Generator

abed184

The generator will create documents as UTF8 w/BOM, so
ensure all documents are prepped and ready for the
changes.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Generate Documentation Automatically

1dd87f1

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 added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Code With Documentation

20fad87

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Generated Documentation

25c355f

Update the generated documentation with the result
of GenerateDocs.ps1.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Allow for ignored arguments

027d014

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) add current helpers/commands

ee62b26

This adds the current items from the wiki prior to auto generated docs

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) rename CommandsSources to CommandsSource

2eb4342

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Current Docs for Generator

2ae25b3

The generator will create documents as UTF8 w/BOM, so
ensure all documents are prepped and ready for the
changes.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Generate Documentation Automatically

a3be2da

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 added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Code With Documentation

bcfb517

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Generated Documentation

441c5c8

Update the generated documentation with the result
of GenerateDocs.ps1.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Allow for ignored arguments

6892ee5

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Generate Documentation Automatically

2a9e0ba

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 added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Code With Documentation

3ed1f37

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Generated Documentation

f95b521

Update the generated documentation with the result
of GenerateDocs.ps1.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Allow for ignored arguments

ebda3ff

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Code With Documentation

20130be

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.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Update Generated Documentation

78bc0ef

Update the generated documentation with the result
of GenerateDocs.ps1.

ferventcoder added a commit to ferventcoder/choco that referenced this issue


          (chocolateyGH-697) Allow for ignored arguments

4ee8818

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.

ferventcoder added 4 - Done Breaking Change and removed 2 - Working labels

This was referenced Jun 3, 2016

Auto docs - Move examples above reference #773

Closed

Auto doc - aliases not working #774

Closed

ferventcoder added a commit that referenced this issue


          Merge pull request #720 from ferventcoder/generated-docs

2d26f44

(GH-697) Automatically generate documentation

ferventcoder added a commit that referenced this issue


          Merge branch 'stable'

1889f7e

* stable:
  (GH-772) Uninstall-ChocolateyEnvironmentVariable
  (GH-765) Updates for Get-FtpFile
  (GH-697) Allow for ignored arguments
  (maint) miscellaneous PS fixes
  (GH-713) Rename Get-ProcessorBits Get-OSArchitectureWidth
  (GH-527) Url is optional
  (GH-697) Update Generated Documentation
  (GH-697) Update Code With Documentation
  (GH-697) Generate Documentation Automatically
  (GH-697) Update Current Docs for Generator
  (GH-697) rename CommandsSources to CommandsSource
  (GH-697) add current helpers/commands
  (maint) remove magic string environment vars
  (GH-756) Empty $env:ChocolateyToolsLocation combine error
  (GH-689) Report install work w/non-POSH pkgs

ferventcoder closed this as completed

This was referenced Jun 17, 2016

Silent Args being passed as a string array cause package failure #808

Closed

NotSilent fails with "Cannot bind argument to parameter statements because it is an empty string" #819

Closed

gep13 added 5 - Released and removed 4 - Done labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment