bottlerocket-os / bottlerocket-os/bottlerocket-project-website

More documentation around what mutable paths exist

Open
#112 0 comments 0 reactions 0 assignees View on GitHub
content-gap
Dominant language
HTML
Stars
12
Forks
21
Avg merge
22h 57m
Merged PRs (30d)
6

Description

**Path to page with conent (_do not_ include domain name):**
content/en/os/1.13.x/concepts/restricted-filesystem/index.markdown

**What content is incorrect?**
I expected there to be some discussion about what is specifically stored outside of the immutable root filesystem. There is state such as logs and container images that would be useful to call out so a user can find them if they need them.

**What should the content say or communicate?**

I would like to see specific paths/locations for commonly asked for files. Logs comes to mind first, but it would be useful to call out `/local` and what exists in that path and when to expect it to be there or not (for instance, are these files always persisted or cleaned up during upgrades, etc)

Contributor guide

Open the contributing guide

Research direction

Start with content/en/os/1.13.x/concepts/restricted-filesystem/index.markdown and review the existing explanation of the immutable root filesystem. Document specific locations for logs, container images, and /local, including when they exist, whether they persist, and what upgrades do to them; the page is done when it answers those user questions clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.