From Fedora Project Wiki
(Update testing section)
(Add trackers)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name.  This keeps all change proposals in the same namespace -->
= i3 Spin =
= i3 Spin =


Line 6: Line 4:
== Summary ==
== Summary ==


Create an official Fedora Spin shipping the popular i3 window manager. This is the first Fedora Spin based off a tiling/window manager instead of a traditional desktop environment.
Create an official Fedora Spin shipping the popular i3 window manager. This Spin would be the first Fedora Spin to feature a tiling/window manager instead of a traditional desktop environment.




== Owner ==
== Owner ==


* Names: [[User:Nasirhm|Nasir Hussain]], [[User:Jflory7|Justin W. Flory]], [[User:X3mboy|Eduard Lucena]], [[User:Defolos|    Dan Čermák]], [https://docs.fedoraproject.org/en-US/i3/ Fedora i3 SIG]
* Name: [[User:Nasirhm|Nasir Hussain]], [[User:Jflory7|Justin W. Flory]], [[User:X3mboy|Eduard Lucena]], [[User:Defolos|    Dan Čermák]], [https://docs.fedoraproject.org/en-US/i3/ Fedora i3 SIG]
* Email: nasirhm@fedoraproject.org, jwf@fedoraproject.org
* Email:
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
-->
-->


== Current status ==
== Current status ==
[[Category:ChangeAcceptedF34]]
[[Category:SelfContainedChange]]


[[Category:ChangePageIncomplete]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- The Wrangler announces the Change to the devel-announce list and changes the category to Category:ChangeAnnounced (no action required) -->  
<!-- The Wrangler announces the Change to the devel-announce list and changes the category to Category:ChangeAnnounced (no action required) -->  
<!-- After review, the Wrangler will move your page to Category:ChangeReadyForFesco... if it still needs more work it will move back to Category:ChangePageIncomplete-->
<!-- After review, the Wrangler will move your page to Category:ChangeReadyForFesco... if it still needs more work it will move back to Category:ChangePageIncomplete-->
[[Category:SelfContainedChange]]
* Targeted release: [[Releases/34|Fedora 34]]  
* Targeted release: [[Releases/34|Fedora 34]]  
* 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}}  
Line 40: Line 32:
-->
-->


* FESCo issue: <will be assigned by the Wrangler>
* FESCo issue: [https://pagure.io/fesco/issue/2537 #2537]
* Tracker bug: <will be assigned by the Wrangler>
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=1913852 #1913852]
* Release notes tracker: <will be assigned by the Wrangler>
* Release notes tracker: [https://pagure.io/fedora-docs/release-notes/issue/631 #631]


== Detailed Description ==


== Detailed Description ==
The Fedora i3 SIG began in May 2020 with a goal of creating an official Fedora Spin featuring the i3 tiling window manager. Since then, a community of i3 enthusiasts around the Fedora community has collaborated to define what an official Fedora i3 Spin would include, how it might work, and how the Fedora community might differentiate this Spin from other ready-to-use i3 implementations already in the open source ecosystem.


In May 2020, the Fedora i3 SIG began with a goal to create an official Fedora Spin for the i3 window manager. Since then, a community of i3 enthusiasts around Fedora came together to contribute to what should go into an official Fedora Spin for i3. While this Change will not explain what i3 is, here is what makes the Fedora i3 Spin unique from other distributions (see [https://docs.fedoraproject.org/en-US/i3/design-goals/ i3 SIG Design Goals] for details):
The SIG has outlined the following design goals to guide construction of the Spin (see [https://docs.fedoraproject.org/en-US/i3/design-goals/ i3 SIG Design Goals] for details):


# Simple is better than complex.
# Simple is better than complex.
Line 54: Line 47:
# Now is better than never.
# Now is better than never.


These four Design Goals inform and guide the decisions for the Kickstart. They are the basis for how the i3 SIG makes decisions for future changes to the i3 Spin.
These Design Goals inform and guide decisions regarding the Kickstart. They are also the basis for the SIG's decisions about future changes to the i3 Spin.


This Change is the realization of the work that began in May 2020, to create an official Fedora Spin based off the i3 SIG's kickstart.
In summary, this Change is represents the realization of work that began in May 2020. The goal is to create an official Fedora Spin based on the i3 SIG's kickstart.




== Feedback ==
== Feedback ==


There is no Fedora Spin currently available that offers any window/tiling manager. The i3 SIG includes newer and older Fedora contributors who use i3, and believe it would be a popular Spin if available to the Fedora Community. The community feedback shared to the i3 SIG informed this Change.
No Fedora Spin currently features a window/tiling manager. The i3 SIG includes newer and older Fedora contributors who use i3 and believe it would be a popular Spin if available to the Fedora Community. Community feedback informs this Change.


=== What did Twitter have to say? ===
=== What did Twitter have to say? ===
Line 67: Line 60:
Here are some tweets of what people had to say in response to news that the i3 SIG is working on a Fedora i3 Spin:
Here are some tweets of what people had to say in response to news that the i3 SIG is working on a Fedora i3 Spin:


{{quote|1=Always wanted to see if I can use tiling manager. If fedora is making official spin then I can try it.|2=https://twitter.com/varoondev/status/1313794208155787264}}
{{quote|1=Always wanted to see if I can use tiling manager. If fedora is making official Spin then I can try it.|2=https://twitter.com/varoondev/status/1313794208155787264}}


{{quote|1=Yes, would love to have i3 on Fedora if you guys can pull it off. Good luck!|2=https://twitter.com/bertmendz/status/1314040245843898370}}
{{quote|1=Yes, would love to have i3 on Fedora if you guys can pull it off. Good luck!|2=https://twitter.com/bertmendz/status/1314040245843898370}}
Line 76: Line 69:
== Benefit to Fedora ==
== Benefit to Fedora ==


This Change benefits end-users who run Fedora on a desktop or laptop, particularly low-end consumer-grade hardware. An i3 Spin provides a better initial installation experience for new i3 users on Fedora. To use i3 on Fedora, an end-user must install another Edition or Spin of Fedora, and then install i3. This also leaves many unnecessary packages if the end-user does not use another desktop environment.
This Change benefits end-users who run Fedora on a desktop or laptop, particularly low-end consumer-grade hardware.


In particular, the i3 SIG hypothesizes an official i3 Spin will have the lightest footprint (memory and base install size) of any Fedora Edition or Spin, but more data is needed to test this hypothesis.
An i3 Spin would provide a better initial installation experience for Fedora users installing i3 for the first time. Currently, end-users who wish to use i3 on Fedora must install another Edition or Spin of Fedora, then install the i3 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.
 
Moreover, the i3 SIG hypothesizes an official i3 Spin will have the lightest footprint (memory and base install size) of any Fedora Edition or Spin, but testing this hypothesis requires more data.




Line 93: Line 88:
<!-- 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: [https://pagure.io/releng/issues #Releng issue number] (a check of an impact with Release Engineering is needed) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Release engineering: [https://pagure.io/releng/issue/9864 #9864]
<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuild required?  include a link to the releng issue.
The issue is required to be filed prior to feature submission, to ensure that someone is on board to do any process development work and testing and that all changes make it into the pipeline; a bullet point in a change is not sufficient communication -->


* 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: N/A (not needed for this Change)
* Trademark approval: [https://pagure.io/Fedora-Council/tickets/issue/343#comment-707009 #343]
<!-- If your Change may require trademark approval (for example, if it is a new Spin), file a ticket ( https://fedorahosted.org/council/ ) requesting trademark approval from the Fedora Council. This approval will be done via the Council's consensus-based process. -->




Line 108: Line 100:
<!-- 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? -->


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
Since the Fedora i3 Spin is a Spin, it assumes new installations only. There is no upgrade/compatibility impact from the Spin.
N/A (not a System Wide Change)  
 
Eventually, the i3 SIG will also create a package group (composition) for `i3` and `i3-extended`. Fedora users can more easily switch from another desktop environment by installing the package group.




== How To Test ==
== How To Test ==


1. Boot the spin's iso either directly on your machine or in a VM.
1. Boot the Fedora i3 Spin ISO image either on bare-metal or in a virtual machine (V.M.).


2. The iso should boot directly into a live i3 environment with some basic packages available.
2. Confirm successful boot into a configured i3 environment with basic packages available.


3. The anaconda installer can be launched either from a terminal or via the application launcher dmenu. The installer works as on all other spins and editions.
3. Launch Anaconda installer. The Anaconda installer can be launched either from a terminal or via the application launcher `dmenu`.


4. The installed system uses lightDM 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 `lightdm` as the login manager and comes preinstalled with i3 as the default desktop environment with default applications present for most uses cases.


<!-- This does not need to be a full-fledged document. Describe the dimensions of tests that this change implementation is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.  
<!-- This does not need to be a full-fledged document. Describe the dimensions of tests that this change implementation is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.  
Line 146: Line 139:
== Dependencies ==
== Dependencies ==


See `%packages` [https://pagure.io/i3-sig/Fedora-i3-Spin/blob/master/f/Kickstarts/flat-i3.ks#_383 in flat-i3.ks].
See `%packages` [https://pagure.io/i3-sig/Fedora-i3-Spin/blob/master/f/fedora-i3-common.ks#_13 in fedora-i3-common.ks].





Latest revision as of 17:47, 7 January 2021

i3 Spin

Summary

Create an official Fedora Spin shipping the popular i3 window manager. This Spin would be the first Fedora Spin to feature a tiling/window manager instead of a traditional desktop environment.


Owner

Current status

  • Targeted release: Fedora 34
  • Last updated: 2021-01-07


Detailed Description

The Fedora i3 SIG began in May 2020 with a goal of creating an official Fedora Spin featuring the i3 tiling window manager. Since then, a community of i3 enthusiasts around the Fedora community has collaborated to define what an official Fedora i3 Spin would include, how it might work, and how the Fedora community might differentiate this Spin from other ready-to-use i3 implementations already in the open source ecosystem.

The SIG has outlined the following design goals to guide construction of the Spin (see i3 SIG Design Goals for details):

  1. Simple is better than complex.
  2. Fast is better than features.
  3. There should be one—and preferably only one—obvious way to do it.
  4. Now is better than never.

These Design Goals inform and guide decisions regarding the Kickstart. They are also the basis for the SIG's decisions about future changes to the i3 Spin.

In summary, this Change is represents the realization of work that began in May 2020. The goal is to create an official Fedora Spin based on the i3 SIG's kickstart.


Feedback

No Fedora Spin currently features a window/tiling manager. The i3 SIG includes newer and older Fedora contributors who use i3 and believe it would be a popular Spin if available to the Fedora Community. Community feedback informs this Change.

What did Twitter have to say?

Here are some tweets of what people had to say in response to news that the i3 SIG is working on a Fedora i3 Spin:

Always wanted to see if I can use tiling manager. If fedora is making official Spin then I can try it.


Yes, would love to have i3 on Fedora if you guys can pull it off. Good luck!



Benefit to Fedora

This Change benefits end-users who run Fedora on a desktop or laptop, particularly low-end consumer-grade hardware.

An i3 Spin would provide a better initial installation experience for Fedora users installing i3 for the first time. Currently, end-users who wish to use i3 on Fedora must install another Edition or Spin of Fedora, then install the i3 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.

Moreover, the i3 SIG hypothesizes an official i3 Spin will have the lightest footprint (memory and base install size) of any Fedora Edition or Spin, but testing this hypothesis requires more data.


Scope

  • Proposal owners:
    • Finalize kickstart composition. The i3 SIG is finalizing a list of packages for an integrated i3 desktop.
    • Work with RelEng to build. The i3 SIG needs to work with Release Engineering to pick up the i3 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. An excited group of users in our IRC/Telegram are ready to help.


  • Other developers: N/A (not a System Wide Change)
  • Release engineering: #9864
  • Policies and guidelines: N/A (not a System Wide Change)
  • Trademark approval: #343


Upgrade/compatibility impact

Since the Fedora i3 Spin is a Spin, it assumes new installations only. There is no upgrade/compatibility impact from the Spin.

Eventually, the i3 SIG will also create a package group (composition) for i3 and i3-extended. Fedora users can more easily switch from another desktop environment by installing the package group.


How To Test

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

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

3. Launch Anaconda installer. The Anaconda installer can be launched either from a terminal or via the application launcher dmenu.

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


User Experience

New Fedora users can install i3 from https://spins.fedoraproject.org instead of installing another desktop, and then manually installing i3 after the initial install. This reduces the number of steps needed to start using i3.

Additionally, the i3 Spin intends to be a ready-to-use, integrated i3 configuration. Often a new i3 user must find or set up other system utilities for things like networking, profile management, and other common desktop functions. The Fedora i3 Spin offers a ready-to-go environment that aims to offer an integrated, lightweight environment without pulling in larger dependency stacks from other desktops.


Dependencies

See %packages in fedora-i3-common.ks.


Contingency Plan

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


Documentation


Release Notes

TBD.