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

(doc) Add/update docs for Chocolatey.PowerShell module #993

Merged
merged 2 commits into from
Jun 5, 2024

Conversation

vexx32
Copy link
Member

@vexx32 vexx32 commented May 10, 2024

Description Of Changes

Adds / updates docs for changes in chocolatey/choco#3440

Motivation and Context

Twofold; one, new command, new docs. Two, the GenerateDocs.ps1 won't work for the new cmdlets and it would be hairy to tie them together. Instead, we're using PlatyPS to generate/maintain these docs, so they need to be in a separate folder (unfortunately).

I have retained the old links and xrefs from the original PowerShell Functions Reference page, so that all cmdlets can still be accessed from that index.

Eventually when everything has moved over to this new section as we progress with cmdlet rewrites, we can collapse the two sections back into one again.

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

chocolatey/choco#3440

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.

I don't have an issue with the slightly different format between this and the existing function docs. All I can see is the capitalisation of the headings which is consistent with what appears in the PowerShell comment based help.

Having said that, if this is the new format we are doing things then we should ensure that as we migrate more functions to cmdlets, we are using this new format. Consistency is important.

I will leave @gep13 to discuss the change of format, file locations etc.

@gep13 gep13 marked this pull request as ready for review June 5, 2024 17:07
Moved rewritten cmdlets docs to new cmdlets folder, retaining xrefs.
Updated cmdlet docs to use platyPS generated doc format.
Add missing redirects
Correct capitalization on xref
Copy link
Member

@gep13 gep13 left a comment

Choose a reason for hiding this comment

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

LGTM!

@gep13 gep13 dismissed st3phhays’s stale review June 5, 2024 17:33

This requested change has been added.

@gep13 gep13 enabled auto-merge June 5, 2024 17:33
@gep13
Copy link
Member

gep13 commented Jun 5, 2024

@vexx32 thanks for getting this added, and to @st3phhays and @pauby for the reviews. I have enabled auto-merge so the PR will be merged once the CI build completes.

@gep13 gep13 merged commit c4e3d6a into chocolatey:master Jun 5, 2024
1 check passed
choco-bot pushed a commit that referenced this pull request Jun 5, 2024
Merge pull request #993 from vexx32/update-cmdlet-docs

(doc) Add/update docs for Chocolatey.PowerShell module
@vexx32 vexx32 deleted the update-cmdlet-docs branch June 7, 2024 18:30
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.

None yet

4 participants