apple / apple/container

[Request]: Troubleshooting doc section and GH project label.

Open
#773 2 comments 0 reactions 1 assignee Claimed by @jglogan View on GitHub
documentation next
Dominant language
Swift
Stars
49.9k
Forks
1.8k
Avg merge
1d 20h
Merged PRs (30d)
22

Description

### Feature or enhancement request details

We don't have a section today where we can curate the most common issues when using container, and how to diagnose and remedy them. Plus, a documentation few odds and ends:

- [ ] Create a new troubleshooting section, identify all known-issue/limitation/troubleshooting content in the existing docs, and sweep these into the new section, linking from their previous location. A notable example is the material on Sequoia networking in the technical overview section.
- [ ] Comb thorough all issues and create troubleshooting entries (e.g. VPN interactions)
- [x] Create a `doc-troubleshooting` tag for open issues that should have troubleshooting entry added before we close the issue.
- [ ] Also migrate and link any how-to content not presently in the how-to section. The only case I know of right now is the `socat` command in the networking limitations section of the tech overview.

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.