From 0030a7c3ab45be0b717779a5948860b3c42eae03 Mon Sep 17 00:00:00 2001 From: Troy Dawson Date: Aug 09 2024 16:34:49 +0000 Subject: Bring over wiki content Signed-off-by: Troy Dawson --- diff --git a/README.md b/README.md index d34d0e2..318eb45 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CentOS SIG Guid documentation +# CentOS SIG Guide documentation This git repository contains the needed sources (markdown format) used to generate the CentOS SIG Guide website. diff --git a/docs/active-sigs.md b/docs/active-sigs.md new file mode 100644 index 0000000..7dac36c --- /dev/null +++ b/docs/active-sigs.md @@ -0,0 +1,21 @@ +# Active SIGs + +* Alternative Architectures - Extend usability base beyond basic architectures (x86_64), including ARM 64-bit and 32-bit, x86 32-bit, Power 8, and so forth. +* Alternative Images - build and provide alternative iso images for CentOS Stream. +* Artwork - Improving the user experience with high quality artwork +* Automotive - Software related to Automotive +* Cloud - The Cloud SIG will look into issues around running Cloud Infrastructure / Hypervisor for onpremise clouds as well as support other SIGs and projects looking to consume some of the shared resources around on-premise cloud infra +* Config Management - a Special Interest Group to cover configuration management and system lifecycle management on CentOS. +* Core - Produces the CentOS Linux Distribution +* Hyperscale - Enable CentOS Stream deployment on large-scale infrastructures +* Infrastructure - Coordination of CentOS project infrastructure +* Kmods - Provide kernel modules currently not available in CentOS Stream. +* Messaging - Description needed +* NFV - Network Functions Virtualization (NFV) provides a CentOS-based stack that will serve as a platform for the deployment and testing of virtual network functions (VNFs). +* Operational Tooling - Logging, monitoring and other operational tool development. +* Promo - Promotion and Events +* Public CI - A Public testing and proving infrastructure +* Software Collections - Tools and packages that allow the build, install, and use multiple versions of software on the same system, without affecting system-wide installed packages. +* Storage - Deploying CentOS as a storage node +* Virtualization - Virtualization in and of CentOS +* CentOS Stream Feature Request - A gate for feature requests that are first developed in CentOS Stream from contributors who wish to request these features to be included in future RHEL releases diff --git a/docs/create.md b/docs/create.md new file mode 100644 index 0000000..a4e766a --- /dev/null +++ b/docs/create.md @@ -0,0 +1,63 @@ +# Setting up a new SIG + +## Get Approval + +Anyone can propose to setup a SIG, but needs to get the agreement and participation of a member of the CentOS Governing Board. To request a new Special interest group to be started, here is what needs to be done: + +* Look at the presently functional SIG's and make sure that your effort will not overlap with another team +* The topic for the SIG must be related to CentOS, or a use scenario for CentOS +* Open a new discussion topic in the CentOS-Devel mailing list, asking for comments and interest. +* Once the topic has been discussed, send a seperate proposal email to the CentOS-Devel mailing list. (Link to a template here) +* One of the CentOS Board members need to be part of the proposed SIG. +* The SIG needs to be approved by the board. + +## Initial Setup + +After the SIG has been approved, various things need to be setup. + +join the effort, once that happens then that Board member can : + +* Board members: List SIG on Active SIG page +* SIG Chair or Board mentor: Request a version control system. +* SIG Chair or Board mentor: Setup documentation using a version control system (Recommended be the same as setup above) +* SIG Chair or Board mentor: Request a new mailing list to be created (if needed) + +### RPM based setup steps + +* SIG meets with Infra SIG member to discuss how the dist git repo is going to be setup +* SIG Chair or Board mentor: setup a SIG-specific signing key to live on CentOS Project signing server and/or locally to the builder +* SIG Chair or Board mentor: request CBS build tag +* SIG Chair or Board mentor: request CBS targets and tags +* SIG Chair or Board mentor: if using git.centos.org request import of SRPMs + +# Requirements + +## Basic Requirements + +* There must be adequate control and feedback into the CentOS community. +* All code produced within the SIG must be compatible with a FOSS license presently used by CentOS. +* All documentation5. produced within the SIG must be compatible with the license of this wiki +* At least one member of the SIG, who need not be the lead, needs to be a member of the CentOS Devteam. + +## Communication + +Generally, all communication as to the work of the SIG should be public, understanding that sometimes a matter may need to be private. Private communication should be an exception, and not a general policy of the SIG. + +* If a SIG mailing list is created, the lists are open and can be joined freely. +* The SIG team leader may be asked to be the SIG mailing list moderator; generally however, CentOS mailing lists are not moderated. + +## Membership + +Each SIG should list it's membership policy in it's initial proposal. It should also have it listed in it's documentation. Normally, the following rule for SIG membership apply: + +* SIG members are appointed by the SIG team leader, and may have elevated privileges, like write access to the relevant Wiki section or git repo, depending on the role of the SIG member. + +## SIG Reporting + +SIGs are expected to report quarterly, with a brief summary of what they've accomplished in the past quarter. A suggested outline for this report is as follows: + +* Membership update (members added, removed. Chair changes.) +* Releases in the most recent quarter (or most recent release, if none in that quarter) +* Health report and general activity narrative. +* Issues for the board to address, if any + diff --git a/docs/index.md b/docs/index.md index e147ba0..84544a6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,15 +2,25 @@ CentOS Special Interest Groups are smaller groups within the CentOS community that focus feature work on or awareness around a topic related to CentOS Linux and CentOS Stream. -This guide is for anyone interested in starting, managing, or contributing to a [CentOS Special Interest Group](https://wiki.centos.org/SpecialInterestGroup). +## SIGS -You'll find on this (always involving) website best practices for each step in the process, including : + * [Active SIGs](active-sigs.md) + * [Retired SIGs](retired-sigs.md) - * How to [join](auth.md) a SIG +## Setup + + * How to [create a SIG](create.md) + +## RPM Info * How to [upload sources](git.md) to the lookaside cache * How to start [building](cbs.md) RPM packages or other artifacts * How to [test](ci.md) your packages * How to [push to mirror](delivery.md) network - * How to create a CentOS [spin](spin.md) + +## Image Info + * How to create a CentOS [image](spin.md) + +## Misc Info * Rules for [dns entries](dns.md) under sig.centos.org * Using the [CentOS namespace on gitlab.com](gitlab.md) + * How to [join](auth.md) a SIG (authentication) diff --git a/docs/retired-sigs.md b/docs/retired-sigs.md new file mode 100644 index 0000000..904c687 --- /dev/null +++ b/docs/retired-sigs.md @@ -0,0 +1,6 @@ +# Retired SIGs + +* Atomic - The AtomicSIG aims to build, deliver and maintain an Atomic Host for CentOS Linux. And help bootstrap tooling around the effort. +* Cloud Instance - Look into issues around running CentOS Linux Instances in various private and public clouds +* Xen4CentOS - A Xen 4 (4.4, 4.6, 4.8) implementation for CentOS Linux 6 and CentOS Linux 7. Later absorbed into the Virtualization SIG +* PaaS - Platform as a Service on CentOS