btrfs user docs

aday commented

2020-07-14 15:26:13 +00:00

Owner

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.

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.

dcavalca commented

2020-07-14 20:25:14 +00:00

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.

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.

ngompa commented

2020-07-15 18:08:38 +00:00

Owner

Metadata Update from @ngompa:

Issue assigned to dcavalca

**Metadata Update from @ngompa**: - Issue assigned to dcavalca

chrismurphy commented

2020-07-15 21:56:08 +00:00

Owner

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

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

chrismurphy commented

2020-08-23 22:59:34 +00:00

Owner

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:

Automatic partitioning - should say Btrfs instead of LVM
https://docs.fedoraproject.org/en-US/fedora/f32/install-guide/install/Installing_Using_Anaconda/#sect-installation-gui-storage-partitioning
Some partition types - notably the /boot and /usr directories and the BIOS Boot and EFI partitions - can not be placed on Btrfs subvolumes. Use standard physical volumes for them (or an LVM logical volume for /usr). See Installing_Using_Anaconda.adoc#sect-installation-gui-manual-partitioning-recommended for more information.
Ext4 is the default and recommended file system used by Fedora Workstation and Cloud.
Advice on Partitions
Recommended Partitioning Scheme (recommendations, sizes all need updates)
https://docs.fedoraproject.org/en-US/fedora/f32/install-guide/install/Installing_Using_Anaconda/#sect-installation-gui-manual-partitioning-recommended
Manual partitioning should say Btrfs instead of LVM
https://docs.fedoraproject.org/en-US/fedora/f32/install-guide/install/Installing_Using_Anaconda/#sect-installation-gui-manual-partitioning
Silverblue
https://docs.fedoraproject.org/en-US/fedora-silverblue/installation/
https://docs.fedoraproject.org/en-US/fedora-silverblue/technical-information/#filesystem-layout
swap - based on your system parameters
- unrelated to btrfs, but needs updating for swaponzram

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

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: - Automatic partitioning - should say Btrfs instead of LVM https://docs.fedoraproject.org/en-US/fedora/f32/install-guide/install/Installing_Using_Anaconda/#sect-installation-gui-storage-partitioning - Some partition types - notably the /boot and /usr directories and the BIOS Boot and EFI partitions - can not be placed on Btrfs subvolumes. Use standard physical volumes for them (or an LVM logical volume for /usr). See Installing_Using_Anaconda.adoc#sect-installation-gui-manual-partitioning-recommended for more information. - Ext4 is the default and recommended file system used by Fedora Workstation and Cloud. - Advice on Partitions - Recommended Partitioning Scheme (recommendations, sizes all need updates) https://docs.fedoraproject.org/en-US/fedora/f32/install-guide/install/Installing_Using_Anaconda/#sect-installation-gui-manual-partitioning-recommended - Manual partitioning should say Btrfs instead of LVM https://docs.fedoraproject.org/en-US/fedora/f32/install-guide/install/Installing_Using_Anaconda/#sect-installation-gui-manual-partitioning - Silverblue https://docs.fedoraproject.org/en-US/fedora-silverblue/installation/ https://docs.fedoraproject.org/en-US/fedora-silverblue/technical-information/#filesystem-layout - swap - based on your system parameters - unrelated to btrfs, but needs updating for swaponzram I'm plotting to update these things, and mention in the weekly Btrfs update

chrismurphy commented

2020-09-05 19:33:06 +00:00

Owner

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

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

chrismurphy commented

2020-09-05 19:37:47 +00:00

Owner

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

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

catanzaro commented

2020-10-27 14:25:17 +00:00

Owner

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?