#158 btrfs user docs
Closed: Deferred to upstream 11 months ago by catanzaro. Opened a year ago by aday.

If we're going to switch to btrfs, we will need easy to find docs for common tasks. Some obvious topics to cover:

  • Getting started - terminology, key concepts, basic commands
  • Problems and recovery
  • Reinstalling and preserving /home using Anaconda

@dcavalca mentioned that this is already in progress, which is great. Once the docs are in place, it would be good to test whether a Google search successfully returns the documentation for relevant keywords.


Docs working draft is here: https://docs.google.com/document/d/16yt7uUrJG5uJ_JIVvGGXs94MWIHUAqS7gJws7edilF8/edit?usp=sharing

If anybody would like to contribute I'm happy to add you as an editor (and if there's a better platform than gdocs to do this kind of stuff, I'm all ears). Once the content is mostly settled I'll reformat this and send a PR to https://pagure.io/fedora-docs/quick-docs to get it added there.

Metadata Update from @ngompa:
- Issue assigned to dcavalca

a year ago

This could use a refresh, or act as a table of contents or FAQ type of landing page that points elsewhere.
https://fedoraproject.org/wiki/Btrfs

bcotton suggests replacing the content in the above wiki with links to the change proposal, and anything else useful. i.e. make it a sort of landing page.

This whole thing needs a review for things related to btrfs, swap, default, ext4, encryption, and recommendations for partitioning...
https://docs.fedoraproject.org/en-US/fedora/f32/install-guide/install/Installing_Using_Anaconda/

Specifically:

I'm plotting to update these things, and mention in the weekly Btrfs update

These updates are minimally invasive, mainly to avoid docs totally conflicting with reality. Updates Installation Destination differences between F21 and F33 (not a typo), accounts for both Btrfs by default, and ZRAM swap by default. There are tweaks for related recommendations and to indicate current installer behavior.
https://pagure.io/fedora-docs/install-guide/pull-request/56#request_diff

Tiny update for Silverblue.
https://github.com/fedora-silverblue/silverblue-docs/pull/88/files

Also, there is a new QA test case for reusing /home that can be repurposed into a quick doc.
https://fedoraproject.org/wiki/QA:Testcase_partitioning_custom_btrfs_preserve_home

Proposal: close this issue and open it under https://pagure.io/fedora-btrfs/project/issues, so it's no longer tracked on the WG issue tracker. Chris, is this OK?

Metadata Update from @catanzaro:
- Issue close_status updated to: Deferred to upstream
- Issue status updated to: Closed (was: Open)

11 months ago

Login to comment on this ticket.

Metadata
Boards 1
Btrfs Status: In Progress