From Fedora Project Wiki
(New page: {{draft}} = Overview = Having just gone through the process, there are lots of folks willing to help you through creating a spin. However, it is not hte most straight forward. Here is my c...)
 
Line 1: Line 1:
 
{{draft}}
 
{{draft}}
 
= Overview =
 
= Overview =
Having just gone through the process, there are lots of folks willing to help you through creating a spin. However, it is not hte most straight forward. Here is my cut of what I think it should be. Assuming the new [[User:Pfrields/NewTrademarkGuidelines | trademark guidelines]] are in place this would be a process for officially hosted spins.
+
Having just gone through the process, there are lots of folks willing to help you through creating a spin. However, it is not the most straight forward. Here is my cut of what I think it should be. Assuming the new [[User:Pfrields/NewTrademarkGuidelines | trademark guidelines]] are in place this would be a process for officially hosted spins. Much of this doc was edited from the existing process [[SIGs/Spins/SpinSubmissionProcess]] here.
  
 
= Submission Process =
 
= Submission Process =
== Step 0: Is this a spin ==
+
== Step 0: Is this a spin? ==
 
If all of these are true, then continue on with the process
 
If all of these are true, then continue on with the process
 
# You have a spin concept you would like to be included in the [[SIGs/Spins/KickstartPool| Kickstart Pool]] and hosted on [[http://spins.fedoraproject.org]]
 
# You have a spin concept you would like to be included in the [[SIGs/Spins/KickstartPool| Kickstart Pool]] and hosted on [[http://spins.fedoraproject.org]]
# It complies with the [[SIGs/Spins/CommunitySpinGuidelines|  Spin Guidelines]]  
+
# It complies with the [[SIGs/Spins/CommunitySpinGuidelines |  Spin Guidelines]]
 +
# It complies with the [[SIGs/Spins/CommunitySpinGuidelines | Community Spin Guidelines]]  
 
# It complies with the MINIMAL REQUIRED TECHNICAL SPECIFICATIONs
 
# It complies with the MINIMAL REQUIRED TECHNICAL SPECIFICATIONs
  
 
== Step 1: Define the Spin as a Feature ==  
 
== Step 1: Define the Spin as a Feature ==  
Every Fedora release, define a [[Features| Feature Page]] for the spin. If this is a subsequent release, the summary page can be a copy of the previous release.
+
Every Fedora release, define a [[Features| Feature Page]] for the spin. If this is a subsequent release, the summary page can be a copy of the previous release. The feature page should include:
 +
 
 +
# A description of the spin concept. Here's a couple of ideas:
 +
#* Does it have a particular target audience?
 +
#** Grannies in church need bigger font sizes
 +
#* Does it have a particular use(-case)?
 +
#** I boot this specific spin on XXX desktops at the office so that (...)
 +
#* Is it a localized spin (based on an existing spin)?
 +
#The spin concept's scope:
 +
#* Does the spin concept apply for being officially released?
 +
#* Does the spin concept need to be included in the Kickstart Pool package (being released, as a package, via Fedora repositories)?
 +
#* Is the spin going to be maintained during it's lifecycle? The lifecycle of a spin is at least one Fedora releases lifecycle.
 +
#* Does the spin expect to release updates during it's lifecycle?
 +
 
 +
== Step 2: Gain Approval for Spin from the Spin SIG ==
 +
The [[SIGs/Spins|  Spin SIG]] owns this step. The goal of this step is for the SIG to ensure that the evaluation which you made in Step 0 is accurate. In theory, the only thing which should keep the SPIN from not being included after this step concludes is either Trademark issues (brought up by the board) or capacity issues by release engineering.
 +
 
 +
# If you have not done so, join the [[SIGs/Spins|  Spin SIG]] [[http://lists.fedoraproject.org/mailman/listinfo/fedora-spins | mailing list]]
 +
# If this is the initial spin submission, email the group the proposed kickstart file
 +
# if this is a subsequent spin submission, email the group the link to the kickstart file in the [http://git.fedorahosted.org/git/?p=spin-kickstarts.git the GIT Repository]
 +
# In both cases, the submission email and the kickstart file should follow the submission guidelines below
 +
 
 +
=== Submission Guidelines ===
 +
 
 +
When submitting a spin concept, the first thing you do is debranding the spin. To the kickstart file for your spin concept, you add:
 +
 
 +
%packages
 +
-fedora-logos
 +
generic-logos
 +
%end
 +
 
 +
and:
 +
 
 +
%post
 +
sed -i -e 's/Fedora/Generic/g' /etc/fedora-release
 +
%end
 +
 
 +
In your submission email to the Spin SIG mailing list, you should include:
 +
 
 +
# A link to the spins Feature page.
 +
# The kickstart file you want to add to the pool.
 +
#* Make sure it has a brief description of the spin's purpose on top, and the author(s)/maintainer(s). Check [http://git.fedorahosted.org/git/?p=spin-kickstarts.git the GIT Repository]  for examples.
 +
# The SIG's name (if any) involved with developing and maintaining the spin concept, and/or your FAS account name
 +
# If applicable, an description of changes you apply that are not covered with the [[SIGs/Spins/CommunitySpinGuidelines|  Community Spin Guidelines]] , such as:
 +
#* The reason for changing the default behavior of an application
 +
#* Excluding or including packages for a localized spin because the spin breaks with or without that specific package (include Red Hat Bugzilla bugnumber)

Revision as of 13:04, 11 September 2008

Warning.png
This page is a draft only
It is still under construction and content may change. Do not rely on the information on this page.

Overview

Having just gone through the process, there are lots of folks willing to help you through creating a spin. However, it is not the most straight forward. Here is my cut of what I think it should be. Assuming the new trademark guidelines are in place this would be a process for officially hosted spins. Much of this doc was edited from the existing process SIGs/Spins/SpinSubmissionProcess here.

Submission Process

Step 0: Is this a spin?

If all of these are true, then continue on with the process

  1. You have a spin concept you would like to be included in the Kickstart Pool and hosted on [[1]]
  2. It complies with the Spin Guidelines
  3. It complies with the Community Spin Guidelines
  4. It complies with the MINIMAL REQUIRED TECHNICAL SPECIFICATIONs

Step 1: Define the Spin as a Feature

Every Fedora release, define a Feature Page for the spin. If this is a subsequent release, the summary page can be a copy of the previous release. The feature page should include:

  1. A description of the spin concept. Here's a couple of ideas:
    • Does it have a particular target audience?
      • Grannies in church need bigger font sizes
    • Does it have a particular use(-case)?
      • I boot this specific spin on XXX desktops at the office so that (...)
    • Is it a localized spin (based on an existing spin)?
  2. The spin concept's scope:
    • Does the spin concept apply for being officially released?
    • Does the spin concept need to be included in the Kickstart Pool package (being released, as a package, via Fedora repositories)?
    • Is the spin going to be maintained during it's lifecycle? The lifecycle of a spin is at least one Fedora releases lifecycle.
    • Does the spin expect to release updates during it's lifecycle?

Step 2: Gain Approval for Spin from the Spin SIG

The Spin SIG owns this step. The goal of this step is for the SIG to ensure that the evaluation which you made in Step 0 is accurate. In theory, the only thing which should keep the SPIN from not being included after this step concludes is either Trademark issues (brought up by the board) or capacity issues by release engineering.

  1. If you have not done so, join the Spin SIG [| mailing list]
  2. If this is the initial spin submission, email the group the proposed kickstart file
  3. if this is a subsequent spin submission, email the group the link to the kickstart file in the the GIT Repository
  4. In both cases, the submission email and the kickstart file should follow the submission guidelines below

Submission Guidelines

When submitting a spin concept, the first thing you do is debranding the spin. To the kickstart file for your spin concept, you add:

%packages
-fedora-logos
generic-logos
%end

and:

%post
sed -i -e 's/Fedora/Generic/g' /etc/fedora-release
%end

In your submission email to the Spin SIG mailing list, you should include:

  1. A link to the spins Feature page.
  2. The kickstart file you want to add to the pool.
    • Make sure it has a brief description of the spin's purpose on top, and the author(s)/maintainer(s). Check the GIT Repository for examples.
  3. The SIG's name (if any) involved with developing and maintaining the spin concept, and/or your FAS account name
  4. If applicable, an description of changes you apply that are not covered with the Community Spin Guidelines , such as:
    • The reason for changing the default behavior of an application
    • Excluding or including packages for a localized spin because the spin breaks with or without that specific package (include Red Hat Bugzilla bugnumber)