From Fedora Project Wiki
(First pass for a full proposal, pending feedback on "How to Test")
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 -->
 
<!-- 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 -->
  
= i3wm Spin =
+
= i3 Spin =
 +
 
  
 
== Summary ==
 
== Summary ==
A minimal Fedora spin which has i3 Window Manger which is a X11 tiling window manager by default on live and after installation along with some widely used packages among i3 users on Fedora which are present on Fedora's official repo.
+
 
 +
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.
 +
 
  
 
== Owner ==
 
== Owner ==
<!--
+
 
For change proposals to qualify as self-contained, owners of all affected packages need to be included here. Alternatively, a SIG can be listed as an owner if it owns all affected packages.
+
* 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]
This should link to your home wiki page so we know who you are.
+
* Email: nasirhm@fedoraproject.org, jwf@fedoraproject.org
-->
 
* Name: [[User:FASAcountName| Your Name]]
 
<!-- 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. -->
 
* Email: <your email address so we can contact you, invite you to meetings, etc. Please provide your Bugzilla email address if it is different from your email in FAS>
 
 
<!--- 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>
 
-->
 
-->
<!--- UNCOMMENT only if this Change aims specific product, working group (Cloud, Workstation, Server, Base, Env & Stacks)
+
 
* Product:
 
* Responsible WG:
 
-->
 
  
 
== Current status ==
 
== Current status ==
 +
 
[[Category:ChangePageIncomplete]]
 
[[Category:ChangePageIncomplete]]
 +
 
<!-- 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 29: Line 27:
 
<!-- 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-->
  
<!-- Select proper category, default is Self Contained Change -->
 
 
[[Category:SelfContainedChange]]
 
[[Category:SelfContainedChange]]
<!-- [[Category:SystemWideChange]] -->
 
  
* Targeted release: [[Releases/<number> | Fedora <number> ]]  
+
* 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}}  
 +
 
<!-- 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  
 
Bugzilla states meaning as usual:
 
Bugzilla states meaning as usual:
Line 42: Line 39:
 
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
 
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
 
-->
 
-->
 +
 
* FESCo issue: <will be assigned by the Wrangler>
 
* FESCo issue: <will be assigned by the Wrangler>
 
* Tracker bug: <will be assigned by the Wrangler>
 
* Tracker bug: <will be assigned by the Wrangler>
 
* Release notes tracker: <will be assigned by the Wrangler>
 
* Release notes tracker: <will be assigned by the Wrangler>
 +
  
 
== 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. -->
+
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):
 +
 
 +
# Simple is better than complex.
 +
# Fast is better than features.
 +
# There should be one—and preferably only one—obvious way to do it.
 +
# 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.
 +
 
 +
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.
 +
 
  
 
== 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. -->
+
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.
 +
 
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
  
<!-- What is the benefit to the distribution?  Will the software we generate be improved? How will the process of creating Fedora releases be improved?
+
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.
 
 
      Be sure to include the following areas if relevant:
 
      If this is a major capability update, what has changed?
 
          For example: This change introduces Python 5 that runs without the Global Interpreter Lock and is fully multithreaded.
 
      If this is a new functionality, what capabilities does it bring?
 
          For example: This change allows package upgrades to be performed automatically and rolled-back at will.
 
      Does this improve some specific package or set of packages?
 
          For example: This change modifies a package to use a different language stack that reduces install size by removing dependencies.
 
      Does this improve specific Spins or Editions?
 
          For example: This change modifies the default install of Fedora Workstation to be more in line with the base install of Fedora Server.
 
      Does this make the distribution more efficient?
 
          For example: This change replaces thousands of individual %post scriptlets in packages with one script that runs at the end.
 
      Is this an improvement to maintainer processes?
 
          For example: Gating Fedora packages on automatic QA tests will make rawhide more stable and allow changes to be implemented more smoothly.
 
      Is this an improvement targeted as specific contributors?
 
          For example: Ensuring that a minimal set of tools required for contribution to Fedora are installed by default eases the onboarding of new contributors.  
 
  
    When a Change has multiple benefits, it's better to list them all.
+
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.
  
    Consider these Change pages from previous editions as inspiration:
 
    https://fedoraproject.org/wiki/Changes/Annobin (low-level and technical, invisible to users)
 
    https://fedoraproject.org/wiki/Changes/ParallelInstallableDebuginfo (low-level, but visible to advanced users)
 
    https://fedoraproject.org/wiki/Changes/VirtualBox_Guest_Integration (primarily a UX change)
 
    https://fedoraproject.org/wiki/Changes/NoMoreAlpha (an improvement to distro processes)
 
    https://fedoraproject.org/wiki/Changes/perl5.26 (major upgrade to a popular software stack, visible to users of that stack)
 
-->
 
  
 
== Scope ==
 
== Scope ==
 +
 
* Proposal owners:
 
* 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.
 +
 
<!-- 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?-->
  
Line 100: Line 92:
 
* Trademark approval: N/A (not needed for this Change)
 
* Trademark approval: N/A (not needed for this Change)
 
<!-- 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. -->
 
<!-- 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. -->
 +
  
 
== 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? -->
  
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
N/A (not a System Wide Change)  
 
N/A (not a System Wide Change)  
 +
  
 
== How To Test ==
 
== How To Test ==
 +
 +
TBD.
 +
 
<!-- 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 124: Line 122:
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
N/A (not a System Wide Change)  
 
N/A (not a System Wide Change)  
 +
  
 
== User Experience ==
 
== User Experience ==
<!-- If this change proposal is noticeable by users, how will their experiences change as a result?
 
  
This section partially overlaps with the Benefit to Fedora section above. This section should be primarily about the User Experience, written in a way that does not assume deep technical knowledge. More detailed technical description should be left for the Benefit to Fedora section.
+
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.
  
Describe what Users will see or notice, for example:
 
  - Packages are compressed more efficiently, making downloads and upgrades faster by 10%.
 
  - Kerberos tickets can be renewed automatically. Users will now have to authenticate less and become more productive. Credential management improvements mean a user can start their work day with a single sign on and not have to pause for reauthentication during their entire day.
 
- Libreoffice is one of the most commonly installed applications on Fedora and it is now available by default to help users "hit the ground running".
 
- Green has been scientifically proven to be the most relaxing color. The move to a default background color of green with green text will result in Fedora users being the most relaxed users of any operating system.
 
-->
 
  
 
== 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)? -->
 
  
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
See `%packages` [https://pagure.io/i3-sig/Fedora-i3-Spin/blob/master/f/Kickstarts/flat-i3.ks#_383 in flat-i3.ks].
N/A (not a System Wide Change)
+
 
  
 
== 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.  -->
+
* 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 mechanism: (What to do?  Who will do it?) N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
* Contingency deadline: Change Checkpoint: 100% Code Complete Deadline (Tue 2021-02-23)
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
+
* Blocks release? No
* Contingency deadline: N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
 
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
 
* Blocks release? N/A (not a System Wide Change), Yes/No <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
* Blocks product? product <!-- Applicable for Changes that blocks specific product release/Fedora.next -->
 
  
 
== 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. -->
 
  
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
* https://docs.fedoraproject.org/en-US/i3/
N/A (not a System Wide Change)
+
* https://pagure.io/i3-sig/docs
 +
 
  
 
== Release Notes ==
 
== Release Notes ==
 +
 +
TBD.
 +
 
<!-- 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.  

Revision as of 22:15, 10 October 2020


i3 Spin

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.


Owner


Current status

  • Targeted release: Fedora 34
  • Last updated: 2020-10-10


  • FESCo issue: <will be assigned by the Wrangler>
  • Tracker bug: <will be assigned by the Wrangler>
  • Release notes tracker: <will be assigned by the Wrangler>


Detailed Description

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 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 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.

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.


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.


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.

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.


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)
  • Policies and guidelines: N/A (not a System Wide Change)
  • Trademark approval: N/A (not needed for this Change)


Upgrade/compatibility impact

N/A (not a System Wide Change)


How To Test

TBD.


N/A (not a System Wide Change)


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 flat-i3.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.