chocolatey / chocolatey/docs

Narrative Docs / Walkthroughs

Open
#342 47 comments 4 reactions 0 assignees Claimed by @pauby View on GitHub
Dominant language
MDX
Stars
223
Forks
248
Avg merge
3d 2h
Merged PRs (30d)
8

Description

We have a lot of great reference docs, which is good if you know exactly what you are looking for, but it would be good to also have more concept and narrative types of docs that are great for learning.

The below will become the docs home when complete. There are lots of needs for documentation and walkthroughs here though.

---

### Getting Started
* [ ] What is Chocolatey? https://github.com/chocolatey/choco/wiki | https://github.com/chocolatey/choco/wiki/Why#what-is-chocolatey
* [ ] Why? https://github.com/chocolatey/choco/wiki/Why
* [ ] We already have x. What additional benefit does Chocolatey provide?
* [ ] How does it work?
* [ ] Security
* [ ] Terminology
* [ ] FAQs

### Troubleshooting
* [ ] Troubleshooting
* [ ] I think I found a bug
* [ ] Support - open source
* [ ] Support - paid

### Installation
* [ ] Planning your install
* [ ] Choosing your client(s)
* [ ] Installation
* [ ] Completely offline / internal
* [ ] Non-admin installation
* [ ] Setting up Chocolatey
* [ ] Setting up Chocolatey for organizational use
* [ ] Securing your Chocolatey installation
* [ ] Setting up Sources
* [ ] [Proxies](https://github.com/chocolatey/choco/wiki/Proxy-Settings-for-Chocolatey)

### Package Repositories
* [ ] [Community Repository (the default) and Organizational Use]()
* [ ] What do I need to know?
* [ ] What are my options?
* [ ] Regular
* [ ] Proxy Repositories
* [ ] Aggregate Repositories

### Managing Software
* [ ] Installing, Upgrading, and Uninstalling Software with Chocolatey
* [ ] Passing arguments to choco.exe
* [ ] Passing parameters to customize packages at runtime (package parameters and install arguments)
* [ ] Installing from a non-known source
* [ ] Installing Windows Features
* [ ] Alternative Sources - Installing Ruby Gems / Python / Cygwin and other sources
* [ ] Installing multiple versions of some software side by side
* [ ] What if the software I want to manage with Chocolatey is already installed?
* [ ] [What commands can I call? (Command Reference)](https://github.com/chocolatey/choco/wiki/CommandsReference)

### Scripting
* [ ] Using choco.exe in scripts
* [ ] Using the Chocolatey.Lib API

### Integrations
* [ ] Using Chocolatey with SCCM
* [ ] Using Chocolatey with MDT
* [ ] Using Chocolatey with PowerShell DSC
* [ ] Using Chocolatey with Puppet
* [ ] Using Chocolatey with Chef
* [ ] Using Chocolatey with Ansible
* [ ] Using Chocolatey with Salt
* [ ] Using Chocolatey with remote management tools (LabTech, RMM, Altiris, etc)

### Packaging Patterns
* [ ] Creating Packages
* [ ] Packaging your own software
* [ ] Package Builder
* [ ] Embedding Binaries vs Download
* [ ] Use of VERIFICATION.txt, LICENSE.txt and REDISTRIBUTION.pdf
* [ ] Installing an Installer
* [ ] Installing a Zip
* [ ] Zip + Installer
* [ ] Installing VSIX
* [ ] Installing PowerShell Modules
* [ ] [Are there variables available for use?](https://github.com/chocolatey/choco/wiki/HelpersReference#environment-variables)
* [ ] How can I take user input? and Ask the user for input (`Read-Host` and `Prompt` have timeouts Chocolatey's PowerShell)
* [ ] [What functions are available? (PowerShell Function Reference)](https://github.com/chocolatey/choco/wiki/HelpersReference)
* [ ] Creating Templates
* [ ] Internalizing an existing package (making offline w/no internet access)
* [ ] Pre-post checks
* [ ] Adding functionality to Chocolatey

### Community Package Repository
* [ ] Maintaining packages
* [ ] Moderation
* [ ] Verifier failed
* [ ] Validator failed
* [ ] I'm getting comments/questions and not sure what is wrong

### Advanced Scenarios
* [ ] Self-service - non-admins installing software
* [ ] Keeping secrets out of the logs
* [ ] Securing packages, even from your users

### Contributing
* [ ] What do I need to know upfront?
* [ ] Guidelines
* [ ] Submitting Documentation
* [ ] PowerShell
* [ ] C#
* [ ] Other

* [ ] Versioning strategies for Chocolatey for less than v1 (SemVer compliance)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the proposed docs home and the linked Chocolatey wiki pages, then review the checklist to identify a single narrative topic and its existing reference material. Done means that topic has a complete learning-oriented document or walkthrough and is marked complete in the outline; the issue does not identify repository files or tests to run.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.