Skip to content

docs: Fix typos and clarify content #1323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2025
Merged

docs: Fix typos and clarify content #1323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ start by looking at [ADOPTERS.md](ADOPTERS.md).

## Community discussion

The [Github discussion forum](https://github.com/containers/bootc/discussions) is enabled.
The [GitHub discussion forum](https://github.com/containers/bootc/discussions) is enabled.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can be a followup, but it seems we should do another pass to scrub containers/bootc in favor of bootc-dev/bootc

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added #1325 for followup


This project is also tightly related to the previously mentioned Fedora/CentOS bootc project,
and many developers monitor the relevant discussion forums there. In particular there's a
Expand All @@ -46,6 +46,7 @@ Are you interested in working on bootc? Great! See our [CONTRIBUTING.md](CONTR
There is also a list of [MAINTAINERS.md](MAINTAINERS.md).

## Governance
See [GOVERNANCE.md](GOVERNANCE.md) for project governance details.

## Badges

Expand Down
4 changes: 2 additions & 2 deletions docs/src/filesystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Filesystem

As noted in other chapters, the bootc project currently
depends on [ostree project](https://github.com/ostreedev/ostree/)
depends on the [ostree project](https://github.com/ostreedev/ostree/)
for storing the base container image. Additionally there is a [containers/storage](https://github.com/containers/storage) instance for [logically bound images](logically-bound-images.md).

However, bootc is intending to be a "fresh, new container-native interface",
Expand Down Expand Up @@ -95,7 +95,7 @@ Some other image-based update systems do not have distinct "versions" of `/etc`
it may be populated only set up at install time, and untouched thereafter. But
that creates "hysteresis" where the state of the system's `/etc` is strongly
influenced by the initial image version. This can lead to problems
where e.g. a change to `/etc/sudoers.conf` (to give on simple example)
where e.g. a change to `/etc/sudoers` (to give one simple example)
would require external intervention to apply.

For more on configuration file best practices, see [Building](building/guidance.md).
Expand Down
5 changes: 2 additions & 3 deletions docs/src/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ systemd is in use, systemd acts as pid1 as usual - there's no "outer" process.

# Status

At the current time, bootc has not reached 1.0, and it is possible
that some APIs and CLIs may change. For more information, see
the [1.0 milestone](https://github.com/containers/bootc/milestone/1).
The CLI and API for bootc are now considered stable. Every existing system
can be upgraded in place seamlessly across any future changes.

However, the core underlying code uses the [ostree](https://github.com/ostreedev/ostree)
project which has been powering stable operating system updates for
Expand Down