Skip to content

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

@jglogan

Description

@jglogan

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)
  • 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

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationnextMust-have items for current and next milestone

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions