Skip to content

(doc) Fix source link for Uninstall-ChocolateyZipPackage.ps1#1281

Open
sparrowt wants to merge 1 commit intochocolatey:masterfrom
sparrowt:patch-2
Open

(doc) Fix source link for Uninstall-ChocolateyZipPackage.ps1#1281
sparrowt wants to merge 1 commit intochocolatey:masterfrom
sparrowt:patch-2

Conversation

@sparrowt
Copy link
Copy Markdown

@sparrowt sparrowt commented Feb 6, 2026

Description Of Changes

The link at the bottom of https://docs.chocolatey.org/en-us/create/functions/uninstall-chocolateyzippackage/ is currently as follows but gives a 404:

View the source for Uninstall-ChocolateyZipPackage

This is because the source code for UnInstall-ChocolateyZipPackage.ps1 has an upper-case I in UnInstall for some reason, so the correct URL is: https://github.com/chocolatey/choco/blob/master/src/chocolatey.resources/helpers/functions/UnInstall-ChocolateyZipPackage.ps1

Motivation and Context

Docs website should not contain broken links

Testing

  • I have previewed these changes using the Docker Container or another method before submitting this pull request.

No - this is trivial so the new link was simply tested in a web browser.

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
  • Images added to the img repository?
    • PR -
  • All items are complete on the Definition of Done.

Related Issue

N/A - I found plenty of existing merged PRs to this repo with (docs) prefix and no ticket (e.g. PR numbers 1227 1245 1254) so I haven't raised one for now. Having made the commit and got as far as opening this PR though I do now see "Make sure you have raised an issue for this pull request before continuing." in the comment in the PR template. I had previously read this which says "Submit the enhancement ticket" and I wasn't sure if that applied to trivial docs fixes. This says "the first line ... should ... be prefixed with the GitHub issue" but then the next bullet point says "If the commit is about documentation, the message should be prefixed with (doc)" so I wonder if CONTRIBUTING.md could be tweaked to clarify whether trivial docs fixes require a ticket or not, to make this more obvious for newcomers?

Note also: I haven't done anything with CLA but this meets the definition of "trivial" per this.

@sparrowt
Copy link
Copy Markdown
Author

@gep13 / @AdmiringWorm as you've made recent docs changes is this something you're happy to approve as a trivial fix?

@pauby
Copy link
Copy Markdown
Member

pauby commented Feb 23, 2026

@sparrowt I believe the issue here is the file name in the chocolatey/choco repository has the wrong casing. The docs link is correct.

We'll get something created over on the correct repository.

@sparrowt
Copy link
Copy Markdown
Author

Righto thanks!

I had assumed that changing the filename could be a lot more of a hassle in case other things were relying on it, but perhaps being Windows that is less likely... (!)

@corbob
Copy link
Copy Markdown
Member

corbob commented Feb 24, 2026

@sparrowt said:

I had assumed that changing the filename could be a lot more of a hassle in case other things were relying on it, but perhaps being Windows that is less likely... (!)

Yeah, it being Windows centric, and PowerShell makes the casing slightly less of a concern. I've opened an issue on the Chocolatey/choco repo here: chocolatey/choco#3848. I've got some internal discussions around this, but I'm not aware of any concerns this would cause. If you wanted to submit a PR over there to rename the file, feel free, just be aware that we might not be able to bring it in right away, or at all if there's a concern that arises.

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.

3 participants