Clarify behaviour of cmdlet `Update-SessionEnvironment`
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- powershell
- Domain
- documentation
Research direction
Start with the documented page at docs.chocolatey.org/en-us/create/cmdlets/update-sessionenvironment/ and review how it currently describes the current session and affected environment variables. Update the page to clarify the package, other packages, and calling user session, then account for the requested regeneration of Chocolatey CLI help documentation.
Written by the indexing model from the issue text.
Description
Checklist
- I have verified this is the correct repository for opening this issue.
- I have verified no other issues exist related to my request.
Is Your Feature Request Related To A Problem? Please describe.
When a maintainer or user makes use of the Update-SessionEnvironment variable, they may think that it will affect the running session of the users PowerShell session, instead of just the session that the package is running in.
Describe The Solution. Why is it needed?
We need to clarify what we are talking about when mentioning the current session when the Update-SessionEnvironment cmdlet is being used, and who or what will see the changes that gets updated/refreshed.
For example, if the Update-SessionEnvironment is being called inside of a package, only the package that calls it will have any updated or refreshed environment variables, other remaining packages that gets installed will be unaffected, as well as the user session that called choco will also be unaffected and need to call the same cmdlet themself.
User Story
I as a maintainer of Chocolatey packages
want to know what gets affected
so I can take appropriate measures during decisions in the package, or recommendations to the user.
Additional Context
The page that needs to be updated is: https://docs.chocolatey.org/en-us/create/cmdlets/update-sessionenvironment/
After that is updated, the next version of Chocolatey CLI needs to have the help documentation re-generated.
This issue was created as part of a comment made by a user recommending clarifications: https://github.com/chocolatey/choco/issues/3865#issuecomment-4197549374
Acceptance Criteria
- Documentation has been updated with a clarification
Related Issues
- Dominant language
- MDX
- Stars
- 223
- Forks
- 248
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 8
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from chocolatey/docs
-
Customer Documentation Enhancement Pro/Business
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
chocolatey/docs#1319 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
chocolatey/docs#861 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
chocolatey/docs#626 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
chocolatey/docs#457 · 3 reactions ·
-
Enhancement
chocolatey/docs#1360 · 1 assignee ·
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100