From Fedora Project Wiki
(Created page with "= Fedora Sway Spin = {{Change_Proposal_Banner}} == Summary == NOTE: This is still in a draft state while it's discussed with the Sway SIG team. Create an official Fedora S...")
 
(s/greetd/sddm/ as that's what we really shipped in f38)
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
= Fedora Sway Spin =
= Fedora Sway Spin =
{{Change_Proposal_Banner}}


== Summary ==
== Summary ==
 
Create an official Fedora Spin shipping the up-and-coming Sway window manager. Following the footsteps of the recently shipped [https://spins.fedoraproject.org/en/i3/ i3 spin].
NOTE: This is still in a draft state while it's discussed with the Sway SIG team.
 
Create an official Fedora Spin shipping the up and coming Sway window manager. Following the footsteps of the recently shipped [https://spins.fedoraproject.org/en/i3/ i3 spin].


== Owner ==
== Owner ==
* Name: [[User:anthr76| Anthony Rabbito]], [[User:jkonecny| Jiří (Jirka) Konečný]] (More possibly TBA after the next Sway SIG meeting)
* Name: [[User:alebastr| Aleksei Bavshin]], [[User:anthr76| Anthony Rabbito]], [[User:jkonecny| Jiří (Jirka) Konečný]], [[User:Fale|Fabio Alessandro Locati]] as well as the rest of the sway-sig
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
<!-- Include your email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
* Email: hello@anthonyrabbito.com
** Primary contact person: [[User:Fale|Fabio Alessandro Locati]]
 
* Email: fale@fedoraproject.org
 


== Current status ==
== Current status ==
[[Category:ChangePageIncomplete]]
[[Category:ChangeAcceptedF38]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
Line 27: Line 21:
<!-- [[Category:SystemWideChange]] -->
<!-- [[Category:SystemWideChange]] -->


* Targeted release: [[Releases/37 | Fedora Linux 37 ]]  
* Targeted release: [[Releases/38 | Fedora Linux 38 ]]  
* Last updated: <!-- this is an automatic macro — you don't need to change this line -->  {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}  
* Last updated: <!-- this is an automatic macro — you don't need to change this line -->  {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}  
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page  
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page  
Line 35: Line 29:
ON_QA -> change is fully code complete
ON_QA -> change is fully code complete
-->
-->
* FESCo issue: TBD
* [devel thread https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/thread/UWGGI736YFHCNC2RTN4SZUHHH2TMW46H/]
* Tracker bug: TBD
* Fedora Council ticket: [https://pagure.io/Fedora-Council/tickets/issue/424 #424]
* Release notes tracker: TBD
* FESCo issue: [https://pagure.io/fesco/issue/2914 #2914]
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=2155081 #2155081]
* Release notes tracker: [https://pagure.io/fedora-docs/release-notes/issue/939 #939]
 
* RelEng ticket: [https://pagure.io/releng/issue/11152 #11152]
* Kickstart: [https://pagure.io/fedora-kickstarts/pull-request/924 #924]
* comps: [https://pagure.io/fedora-comps/pull-request/781 #781]
* ostree: [https://pagure.io/workstation-ostree-config/pull-request/324 #324]
* Fedora design: [https://gitlab.com/fedora/design/team/logos/fedora-team-community-logos/-/issues/7 #7]
* Fedora websites: [https://pagure.io/fedora-websites/pull-request/1185 spin pre], [https://pagure.io/fedora-websites/pull-request/1186 spin release], [https://gitlab.com/fedora/docs/docs-website/docs-fp-o/-/merge_requests/5 sericea docs]
* Fedora Infra: [https://pagure.io/fedora-infra/ansible/pull-request/1344 1344]


== Detailed Description ==
== Detailed Description ==
<!-- Expand on the summary, if appropriate. A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
<!-- Expand on the summary, if appropriate. A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
 
Fedora Window Manager spins greatly benefit users who enjoy a minimal desktop. Sway is beginning to become well polished and is continuing to gain traction from the community. Fedora particularly has a first-class Wayland experience making an even more compelling use case for having a Wayland window manager spin.


Fedora window manager spins have a great benefit to users who enjoy a minimal desktop. Sway is begging to become well polished and is continuing to gain traction from the community. Fedora particularly has a first class Wayland experience making a even more compelling use case to having a wayland window manager spin. On top of creating a proper workstation spin also publish an ostree remote with workstation-ostree-config. The goal would be to make the default config file functional. Meaning only include packages required for it.
For those reasons, we propose to create a Sway spin and an ostree one, called `Sericea`.


More info possibly TBD after Sway SIG holds the next meeting.
The goal of both spins would be to create a turnkey environment to enjoy Fedora and Sway functionally and beautifully.
To achieve this, we plan to put in those spins the minimum amount of packages to accomplish the stated goal. [[User:alebastr| Aleksei Bavshin]] has begun an [https://src.fedoraproject.org/rpms/sway/pull-request/12 RFC] for the `sway` source package that would extend it by creating three sub-packages with Fedora's default Sway configuration.


== Feedback ==
== Feedback ==
<!-- Summarize the feedback from the community and address why you chose not to accept proposed alternatives. This section is optional for all change proposals but is strongly suggested. Incorporating feedback here as it is raised gives FESCo a clearer view of your proposal and leaves a good record for the future. If you get no feedback, that is useful to note in this section as well. For innovative or possibly controversial ideas, consider collecting feedback before you file the change proposal. -->
<!-- Summarize the feedback from the community and address why you chose not to accept proposed alternatives. This section is optional for all change proposals but is strongly suggested. Incorporating feedback here as it is raised gives FESCo a clearer view of your proposal and leaves a good record for the future. If you get no feedback, that is useful to note in this section as well. For innovative or possibly controversial ideas, consider collecting feedback before you file the change proposal. -->


Feedback has been low at the moment. Some comments were made that this isn't worthwhile as some sway users prefer to have gnome installed alongside Sway. There's also been comments that users would prefer having a minimal package set of just Sway and don't want a two step process to get to their environment. I.E install a spin that is not Sway then install Sway.
Feedback has been low at the moment.
We have seen wildly different feedback, from people saying they liked the idea and would use it to others who do not see the value of it and will probably not use it.
Some commenters highlighted that this isn't worthwhile for them as they would prefer to have Gnome installed alongside Sway. There have also been comments that some users like having a minimal package set that only includes Sway and don't want a two-step process to get to their environment, which would be the situation if they install a spin that is not Sway and then have to install Sway on top.


== Benefit to Fedora ==
== Benefit to Fedora ==


Much like i3, this Change benefits end-users who run Fedora on a desktop or laptop, particularly low-end consumer-grade hardware.
Like the introduction of the i3 Spin, this change benefits end-users who run Fedora on a desktop or laptop, particularly low-end consumer-grade hardware.


A Sway Spin would provide a better initial installation experience for Fedora users installing Sway for the first time. Currently, end-users who wish to use Sway on Fedora must install another Edition or Spin of Fedora, then install the Sway window manager (and related packages) separately (a process often requiring use of an external guide or tutorial). Additionally, this "two-step" method adds unnecessary packages to the user's system, particularly if the end-user does not wish to use another desktop environment.
A Sway Spin would provide a better initial installation experience for Fedora users installing Sway for the first time. Currently, end-users who wish to use Sway on Fedora must install another Edition or Spin of Fedora, then install the Sway window manager (and related packages) separately. Also, at the moment, the process is not documented in Fedora documentation, forcing the user to use an external guide or tutorial.


Additionally, this "two-step" (first install Fedora, then install Sway on top of it) method adds unnecessary packages to the user's system, particularly if the end-user does not wish to use another desktop environment. One of Fedora's foundations is being "First".
We believe that, in this situation, being committed to being "First" means pushing the boundaries of Sway and Wayland by shipping the first Fedora Spin that is based on a Wayland-only Window Manager.


== Scope ==
== Scope ==
Line 66: Line 77:
** '''Test Day coordination'''. Work with the Fedora QA team to plan and run a series of Test Days to solicit early feedback.
** '''Test Day coordination'''. Work with the Fedora QA team to plan and run a series of Test Days to solicit early feedback.


<!-- What work do the feature owners have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
<!-- What work do the feature owners have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
** '''fedora-sway-configs'''. [[User:alebastr| Aleksei Bavshin]]


* Other developers: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Other developers: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- What work do other developers have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
<!-- What work do other developers have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->


* Release engineering: TBD
* Release engineering: [https://pagure.io/releng/issue/11152 Requested]


* Policies and guidelines: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Policies and guidelines: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- Do the packaging guidelines or other documents need to be updated for this feature? If so, does it need to happen before or after the implementation is done? If a FPC ticket exists, add a link here. -->
<!-- Do the packaging guidelines or other documents need to be updated for this feature? If so, does it need to happen before or after the implementation is done? If a FPC ticket exists, add a link here. -->


* Trademark approval: TBD
* Trademark approval: [https://pagure.io/Fedora-Council/tickets/issue/424 Requested]


== Upgrade/compatibility impact ==
== Upgrade/compatibility impact ==
<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->


Since the Fedora Sway Spin is a Spin, it assumes new installations only. There is no upgrade/compatibility impact from the Spin. rpm-ostree installations will be able to seamlessly rebase like users from Silverblue to Kinoite have.
Since the Fedora Sway Spin is a Spin, it assumes new installations only. There is no upgrade/compatibility impact from the Spin. ostree installations will be able to seamlessly rebase to `sericea` in the same way they would with any other ostree variant.


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
Line 94: Line 106:
2. Confirm successful boot into a configured Sway environment with basic packages available.
2. Confirm successful boot into a configured Sway environment with basic packages available.


3. Launch Anaconda installer. The Anaconda installer can be launched either from a terminal or via the application launcher `wofi`.
3. Launch Anaconda installer. The Anaconda installer can be launched either from a terminal (executable by pressing Windows+Enter) or via the application launcher `rofi-wayland` (executable by pressing Windows+d).


4. Confirm no major issues with windows and display. The installed system uses `greetd-gtkgreet` as the login manager and comes preinstalled with i3 as the default desktop environment with default applications present for most uses cases.
4. Confirm no major issues with windows and display. The installed system uses `sddm` as the login manager and comes preinstalled with Sway as the default desktop environment and with default applications present for most use cases.


Ostree Fedora Sway Spin:
Install `sericea` on fresh install:


1. Use rpm-ostree to rebase to Fedora Sway or download a ostree variant ISO image either on bare-metal or in a virtual machine (V.M.).
1. Use rpm-ostree to rebase to Fedora Sway or download a ostree variant ISO image either on bare-metal or in a virtual machine (V.M.).
Line 106: Line 118:
3. TBD
3. TBD


4. Confirm no major issues with windows and display. The installed system uses `greetd-gtkgreet` as the login manager and comes preinstalled with i3 as the default desktop environment with default applications present for most uses cases.
4. Confirm no major issues with windows and display. The installed system uses `sddm` as the login manager and comes preinstalled with Sway as the default desktop environment and with default applications present for most use cases.


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
Line 112: Line 124:


== User Experience ==
== User Experience ==
Users are able to consume Sway from https://spins.fedoraproject.org instead of installing another desktop and then manually installing Sway after the initial installation. This reduces the number of steps needed to start using Sway.


Users are able to consume Sway from https://spins.fedoraproject.org instead of installing another desktop, and then manually installing Sway after the initial install. This reduces the number of steps needed to start using Sway.
The Spin should remain as minimal as possible and only include small supplements on top of making the default configuration workable. For example, integrate sway-systemd and a login manager. We should make the user experience as easy and simple as possible without defining too many opinions.  
 
The spin should remain as minimal as possible and only include small supplements on top of making the default configuration workable. For example integrate sway-systemd and a login manager. We should make the user experience as easy and simple as possible without defining too many opinions.  


== Dependencies ==
== Dependencies ==
<!-- What other packages (RPMs) depend on this package? Are there changes outside the developers' control on which completion of this change depends? In other words, completion of another change owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate? Other upstream projects like the kernel (if this is not a kernel change)? -->
<!-- What other packages (RPMs) depend on this package? Are there changes outside the developers' control on which completion of this change depends? In other words, completion of another change owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate? Other upstream projects like the kernel (if this is not a kernel change)? -->


TBD
TBD
Line 127: Line 138:
== Contingency Plan ==
== Contingency Plan ==


<!-- If you cannot complete your feature by the final development freeze, what is the backup plan? This might be as simple as "Revert the shipped configuration". Or it might not (e.g. rebuilding a number of dependent packages). If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan? This might be as simple as "Revert the shipped configuration". Or it might not (e.g. rebuilding a number of dependent packages). If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
* Contingency mechanism: If a blocker bug comes up that breaks composes of the Sway Spin in time for Fedora 37, the Change can be bumped to a future Fedora release (e.g. F38).
* Contingency mechanism: If a blocker bug comes up that breaks composes of the Sway Spin in time for Fedora 38, the Change can be bumped to a future Fedora release (e.g. F39).
<!-- When is the last time the contingency mechanism can be put in place? This will typically be the beta freeze. -->
<!-- When is the last time the contingency mechanism can be put in place? This will typically be the beta freeze. -->
* Contingency deadline: Change Checkpoint: Tue 2022-08-23 100% Code Complete Deadline  
* Contingency deadline: Change Checkpoint: Tue 2023-02-21 100% Code Complete Deadline  
* Blocks release? No
* Blocks release? No




== Documentation ==
== Documentation ==
<!-- Is there upstream documentation on this change, or notes you have written yourself? Link to that material here so other interested developers can get involved. -->
<!-- Is there upstream documentation on this change, or notes you have written yourself? Link to that material here so other interested developers can get involved. -->


* https://fedoraproject.org/wiki/SIGs/Sway
* https://fedoraproject.org/wiki/SIGs/Sway
Line 145: Line 156:


== Release Notes ==
== Release Notes ==
<!-- The Fedora Release Notes inform end-users about what is new in the release. Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
<!-- The Fedora Release Notes inform end-users about what is new in the release. Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns. If there are any such changes involved in this change, indicate them here. A link to upstream documentation will often satisfy this need. This information forms the basis of the release notes edited by the documentation team and shipped with the release.  
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns. If there are any such changes involved in this change, indicate them here. A link to upstream documentation will often satisfy this need. This information forms the basis of the release notes edited by the documentation team and shipped with the release.  


Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.  
Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.  
-->
-->

Latest revision as of 01:13, 3 April 2023

Fedora Sway Spin

Summary

Create an official Fedora Spin shipping the up-and-coming Sway window manager. Following the footsteps of the recently shipped i3 spin.

Owner

Current status

Detailed Description

Fedora Window Manager spins greatly benefit users who enjoy a minimal desktop. Sway is beginning to become well polished and is continuing to gain traction from the community. Fedora particularly has a first-class Wayland experience making an even more compelling use case for having a Wayland window manager spin.

For those reasons, we propose to create a Sway spin and an ostree one, called Sericea.

The goal of both spins would be to create a turnkey environment to enjoy Fedora and Sway functionally and beautifully. To achieve this, we plan to put in those spins the minimum amount of packages to accomplish the stated goal. Aleksei Bavshin has begun an RFC for the sway source package that would extend it by creating three sub-packages with Fedora's default Sway configuration.

Feedback

Feedback has been low at the moment. We have seen wildly different feedback, from people saying they liked the idea and would use it to others who do not see the value of it and will probably not use it. Some commenters highlighted that this isn't worthwhile for them as they would prefer to have Gnome installed alongside Sway. There have also been comments that some users like having a minimal package set that only includes Sway and don't want a two-step process to get to their environment, which would be the situation if they install a spin that is not Sway and then have to install Sway on top.

Benefit to Fedora

Like the introduction of the i3 Spin, this change benefits end-users who run Fedora on a desktop or laptop, particularly low-end consumer-grade hardware.

A Sway Spin would provide a better initial installation experience for Fedora users installing Sway for the first time. Currently, end-users who wish to use Sway on Fedora must install another Edition or Spin of Fedora, then install the Sway window manager (and related packages) separately. Also, at the moment, the process is not documented in Fedora documentation, forcing the user to use an external guide or tutorial.

Additionally, this "two-step" (first install Fedora, then install Sway on top of it) method adds unnecessary packages to the user's system, particularly if the end-user does not wish to use another desktop environment. One of Fedora's foundations is being "First". We believe that, in this situation, being committed to being "First" means pushing the boundaries of Sway and Wayland by shipping the first Fedora Spin that is based on a Wayland-only Window Manager.

Scope

  • Proposal owners:
    • kickstart composition. Owner TBA
    • workstation-ostree-config. Create a 'tree-file' for Fedora ostree vairents. - Anthony Rabbito
    • Work with RelEng to build. Work with Release Engineering to pick up the Sway Spin in regular composes.
    • Test Day coordination. Work with the Fedora QA team to plan and run a series of Test Days to solicit early feedback.
  • Other developers: N/A (not a System Wide Change)
  • Policies and guidelines: N/A (not a System Wide Change)

Upgrade/compatibility impact

Since the Fedora Sway Spin is a Spin, it assumes new installations only. There is no upgrade/compatibility impact from the Spin. ostree installations will be able to seamlessly rebase to sericea in the same way they would with any other ostree variant.


How To Test

Proper Fedora Sway Spin:

1. Boot the Fedora Sway Spin ISO image either on bare-metal or in a virtual machine (V.M.).

2. Confirm successful boot into a configured Sway environment with basic packages available.

3. Launch Anaconda installer. The Anaconda installer can be launched either from a terminal (executable by pressing Windows+Enter) or via the application launcher rofi-wayland (executable by pressing Windows+d).

4. Confirm no major issues with windows and display. The installed system uses sddm as the login manager and comes preinstalled with Sway as the default desktop environment and with default applications present for most use cases.

Install sericea on fresh install:

1. Use rpm-ostree to rebase to Fedora Sway or download a ostree variant ISO image either on bare-metal or in a virtual machine (V.M.).

2. Confirm successful boot into a configured Sway environment with basic packages available.

3. TBD

4. Confirm no major issues with windows and display. The installed system uses sddm as the login manager and comes preinstalled with Sway as the default desktop environment and with default applications present for most use cases.


User Experience

Users are able to consume Sway from https://spins.fedoraproject.org instead of installing another desktop and then manually installing Sway after the initial installation. This reduces the number of steps needed to start using Sway.

The Spin should remain as minimal as possible and only include small supplements on top of making the default configuration workable. For example, integrate sway-systemd and a login manager. We should make the user experience as easy and simple as possible without defining too many opinions.

Dependencies

TBD


Contingency Plan

  • Contingency mechanism: If a blocker bug comes up that breaks composes of the Sway Spin in time for Fedora 38, the Change can be bumped to a future Fedora release (e.g. F39).
  • Contingency deadline: Change Checkpoint: Tue 2023-02-21 100% Code Complete Deadline
  • Blocks release? No


Documentation

N/A (not a System Wide Change)

TBD?

Release Notes