From 8577820d7361c7cadd34df44de80d051464bcc9c Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Mar 27 2025 14:17:29 +0000 Subject: Add headers on all pages specifying that Modularity has been retired The Modularity docs are linked from many places on the internet. I think we shouldn't remove the documentation, since it may be of historical intereset. Nevertheless, we should make it clear the status of the project. For the most recent example of somebody being confused, see https://discussion.fedoraproject.org/t/status-of-whatcanidoforfedora-org/34168/46. --- diff --git a/modules/ROOT/pages/building-modules/copr/building-modules-in-copr.adoc b/modules/ROOT/pages/building-modules/copr/building-modules-in-copr.adoc index 1b43506..c5fe004 100644 --- a/modules/ROOT/pages/building-modules/copr/building-modules-in-copr.adoc +++ b/modules/ROOT/pages/building-modules/copr/building-modules-in-copr.adoc @@ -1,5 +1,6 @@ = Building modules in Copr +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. == Introduction diff --git a/modules/ROOT/pages/building-modules/fedora/adding-new-modules.adoc b/modules/ROOT/pages/building-modules/fedora/adding-new-modules.adoc index bd90320..ed4e799 100644 --- a/modules/ROOT/pages/building-modules/fedora/adding-new-modules.adoc +++ b/modules/ROOT/pages/building-modules/fedora/adding-new-modules.adoc @@ -1,5 +1,7 @@ = Adding new modules to Fedora +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + This page will guide you through the whole process of adding a new module to Fedora: 1. **<>** — To `dist-git/rpms` using stream branches. diff --git a/modules/ROOT/pages/building-modules/fedora/building-modules.adoc b/modules/ROOT/pages/building-modules/fedora/building-modules.adoc index 5d32e16..94b5e23 100644 --- a/modules/ROOT/pages/building-modules/fedora/building-modules.adoc +++ b/modules/ROOT/pages/building-modules/fedora/building-modules.adoc @@ -1,5 +1,7 @@ = Submitting module builds in Fedora +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + NOTE: With Modularity, you no longer build individual packages. Instead, you need to submit a module build. Module builds are triggered using `fedpkg` from within your dist-git repository. diff --git a/modules/ROOT/pages/building-modules/fedora/defining-modules.adoc b/modules/ROOT/pages/building-modules/fedora/defining-modules.adoc index 57e35e3..92d1dfd 100644 --- a/modules/ROOT/pages/building-modules/fedora/defining-modules.adoc +++ b/modules/ROOT/pages/building-modules/fedora/defining-modules.adoc @@ -1,5 +1,7 @@ = Defining modules in modulemd +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Simply put, **modulemd is a file that defines which packages get built for which releases**. It includes a summary and a description, a list of source RPM packages, build information i.e. build order and macros, and usage information i.e. installation profiles and licenses. == A typical modulemd example diff --git a/modules/ROOT/pages/building-modules/fedora/index.adoc b/modules/ROOT/pages/building-modules/fedora/index.adoc index cc9d565..d9bcbe4 100644 --- a/modules/ROOT/pages/building-modules/fedora/index.adoc +++ b/modules/ROOT/pages/building-modules/fedora/index.adoc @@ -1,5 +1,7 @@ = Building Modules for Fedora +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + If you wish to maintain an additional version of an application, language stack, or any other piece of software, modules might be the way to go for you. The xref:building-modules/fedora/adding-new-modules.adoc[Adding New Modules] covers the whole process of adding a new module to Fedora. diff --git a/modules/ROOT/pages/building-modules/fedora/inspecting-build-failures.adoc b/modules/ROOT/pages/building-modules/fedora/inspecting-build-failures.adoc index 05a3614..14fb11e 100644 --- a/modules/ROOT/pages/building-modules/fedora/inspecting-build-failures.adoc +++ b/modules/ROOT/pages/building-modules/fedora/inspecting-build-failures.adoc @@ -1,5 +1,7 @@ = Inspecting module build failures in Fedora +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Have you submitted a build which failed? This page will point you to the right places to get all the information about build failures. == Inspecting build failures diff --git a/modules/ROOT/pages/building-modules/fedora/managing-defaults.adoc b/modules/ROOT/pages/building-modules/fedora/managing-defaults.adoc index 93ee226..d7b9957 100644 --- a/modules/ROOT/pages/building-modules/fedora/managing-defaults.adoc +++ b/modules/ROOT/pages/building-modules/fedora/managing-defaults.adoc @@ -1,5 +1,7 @@ = Managing module defaults in Fedora +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + NOTE: Default streams are *NOT* allowed in Fedora right now according to policy. Please check the xref:policies/index.adoc[Policy section] for more information. Setting or changing a default stream or a default installation profile of a module constitutes a major behavior change as defined in the Fedora Updates Policy. The following rules apply: diff --git a/modules/ROOT/pages/building-modules/fedora/module-obsoletes.adoc b/modules/ROOT/pages/building-modules/fedora/module-obsoletes.adoc index 5335826..9a42d08 100644 --- a/modules/ROOT/pages/building-modules/fedora/module-obsoletes.adoc +++ b/modules/ROOT/pages/building-modules/fedora/module-obsoletes.adoc @@ -1,6 +1,8 @@ :toc: macro = Module Obsoletes +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + [.lead] Module obsoletes allow for stream obsoleting another module or a stream being EOLed. diff --git a/modules/ROOT/pages/building-modules/fedora/updating-modules.adoc b/modules/ROOT/pages/building-modules/fedora/updating-modules.adoc index 153bb1c..df57d91 100644 --- a/modules/ROOT/pages/building-modules/fedora/updating-modules.adoc +++ b/modules/ROOT/pages/building-modules/fedora/updating-modules.adoc @@ -1,5 +1,7 @@ = Updating modules in Fedora +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + This page will guide you through the process of updating an existing module. 1. **<>** — Pushing new sources. diff --git a/modules/ROOT/pages/building-modules/index.adoc b/modules/ROOT/pages/building-modules/index.adoc index 6eec3a4..89b9a5a 100644 --- a/modules/ROOT/pages/building-modules/index.adoc +++ b/modules/ROOT/pages/building-modules/index.adoc @@ -1,5 +1,7 @@ = Building Modules +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + 1. **xref::building-modules/fedora/index.adoc[Fedora]** 2. **xref::building-modules/copr/building-modules-in-copr.adoc[COPR]** 3. **xref::building-modules/local/building-modules-locally.adoc[Localhost]** \ No newline at end of file diff --git a/modules/ROOT/pages/building-modules/local/building-modules-locally.adoc b/modules/ROOT/pages/building-modules/local/building-modules-locally.adoc index b87027e..cad5d5a 100644 --- a/modules/ROOT/pages/building-modules/local/building-modules-locally.adoc +++ b/modules/ROOT/pages/building-modules/local/building-modules-locally.adoc @@ -1,5 +1,7 @@ = Building modules locally +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + This page walks you through building modules locally on your machine. == Prerequisites diff --git a/modules/ROOT/pages/community.adoc b/modules/ROOT/pages/community.adoc index 4b9581f..125355e 100644 --- a/modules/ROOT/pages/community.adoc +++ b/modules/ROOT/pages/community.adoc @@ -1,6 +1,9 @@ :toc: macro = Community +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + + This page lists the communication channels of members of the Modularity Working Group (Modularity WG), related projects and also how you can contribute to the project. + + diff --git a/modules/ROOT/pages/core-concepts/building.adoc b/modules/ROOT/pages/core-concepts/building.adoc index e48b133..e311157 100644 --- a/modules/ROOT/pages/core-concepts/building.adoc +++ b/modules/ROOT/pages/core-concepts/building.adoc @@ -1,5 +1,7 @@ = Building Software with Modularity +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + This is a high-level overview of how builds work with Fedora Modularity and how it compares with traditional builds. == Traditional package builds diff --git a/modules/ROOT/pages/core-concepts/consuming.adoc b/modules/ROOT/pages/core-concepts/consuming.adoc index 9528a1a..6b7b2d6 100644 --- a/modules/ROOT/pages/core-concepts/consuming.adoc +++ b/modules/ROOT/pages/core-concepts/consuming.adoc @@ -1,5 +1,7 @@ = Consuming Software with Modularity +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + This is a high-level overview of how users can install software with Fedora Modularity and how is it different from the traditional workflow(s). == Understanding the Delivery Channels diff --git a/modules/ROOT/pages/core-concepts/dnf-behavior.adoc b/modules/ROOT/pages/core-concepts/dnf-behavior.adoc index 527c78c..fbd6310 100644 --- a/modules/ROOT/pages/core-concepts/dnf-behavior.adoc +++ b/modules/ROOT/pages/core-concepts/dnf-behavior.adoc @@ -1,6 +1,6 @@ = Modular DNF Behavior -WARNING: This page has been archived. It contains information that is either no longer true, relevant, or it should not be part of this documentation. It has been kept for historical reasons and can be removed at any time. +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. This page captures the key behaviors of modular DNF. diff --git a/modules/ROOT/pages/core-concepts/index.adoc b/modules/ROOT/pages/core-concepts/index.adoc index 1525e81..d0cfb3d 100644 --- a/modules/ROOT/pages/core-concepts/index.adoc +++ b/modules/ROOT/pages/core-concepts/index.adoc @@ -1,5 +1,7 @@ = Core Concepts of Modularity +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + The Modularity project added a lot of new concepts to an already established packaging ecosystem. A lot of those concepts are based on already existing non-modular ones. On the following pages we will try to describe and outline what are the cornerstones of the Modularity project. == Table of contents diff --git a/modules/ROOT/pages/core-concepts/modular-repository.adoc b/modules/ROOT/pages/core-concepts/modular-repository.adoc index 13a8b30..3387c66 100644 --- a/modules/ROOT/pages/core-concepts/modular-repository.adoc +++ b/modules/ROOT/pages/core-concepts/modular-repository.adoc @@ -1,6 +1,8 @@ :toc: macro = Modular repository +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + A standard non-modular RPM repository contains RPM binary files and the repodata directory which is generated by the `createrepo_c` tool. In a non-modular repository the metadata information is stored inside the RPM binary files themselves. So when running `createrepo_c` command on a directory with RPM files present, the metadata is extracted from each of the headers of the RPM files and bundled together in the repodata directory. Modular repository is a standard RPM repository which is extended with modular metadata and modular binary RPM files. A modular repository can consist of non-modular binary RPMs, modular binary RPMs and their corresponding modular metadata. Modular metadata defines a new entity inside a modular repository which is called a module stream. The simplest explanation of a module stream is that a module stream is a group of binary RPM artifacts bound together with extra modular metadata inside a YAML file. diff --git a/modules/ROOT/pages/core-concepts/module-artifacts.adoc b/modules/ROOT/pages/core-concepts/module-artifacts.adoc index 54ba543..20763e7 100644 --- a/modules/ROOT/pages/core-concepts/module-artifacts.adoc +++ b/modules/ROOT/pages/core-concepts/module-artifacts.adoc @@ -1,5 +1,7 @@ = Module Artifacts +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Artifacts are consumable outputs of the build and release processes e.g. an ISO image, an RPM repository, a container base image, or an OSTree tree. The artifacts of a module stream are a modulemd YAML file and the source and binary RPM files. Each component of a module stream represents a RPM package. All the built source and binary RPM files are recorded in the `artifacts` section of a xref:core-concepts/module-stream.adoc#_output_modulemd[output modulemd YAML file]. We are reusing packages as they are. Packages are the smallest unit of software delivery. Fedora uses RPM packages to build and ship all of its software. There is a distinction between source RPM (SRPM) packages and binary RPM packages. diff --git a/modules/ROOT/pages/core-concepts/module-buildorder.adoc b/modules/ROOT/pages/core-concepts/module-buildorder.adoc index 7ec0bb7..69f0ffa 100644 --- a/modules/ROOT/pages/core-concepts/module-buildorder.adoc +++ b/modules/ROOT/pages/core-concepts/module-buildorder.adoc @@ -1,5 +1,7 @@ = Module build order +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Packages which are built within a module stream can have dependency relationships between them. This means that packages within a module can use other packages from the same module as build or runtime dependencies. For this to be possible we are using the `buildorder` property which can be added to each of the components defined in a module stream. By default, if no `buildorder` property is specified the build order of the packages is equal to 0 for the purposes of the module stream build. This means that all the packages can be built at the same time. diff --git a/modules/ROOT/pages/core-concepts/module-context.adoc b/modules/ROOT/pages/core-concepts/module-context.adoc index fa55e82..5c4f2bb 100644 --- a/modules/ROOT/pages/core-concepts/module-context.adoc +++ b/modules/ROOT/pages/core-concepts/module-context.adoc @@ -1,6 +1,8 @@ :toc: macro = Module Context +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + A module stream can be built in and for several different environments. Each of those environments has its own configuration. We call this configuration a context configuration or a context for short. + + diff --git a/modules/ROOT/pages/core-concepts/module-dependency-resolution.adoc b/modules/ROOT/pages/core-concepts/module-dependency-resolution.adoc index 3f453f8..44f660b 100644 --- a/modules/ROOT/pages/core-concepts/module-dependency-resolution.adoc +++ b/modules/ROOT/pages/core-concepts/module-dependency-resolution.adoc @@ -1,6 +1,8 @@ :toc: macro = Module dependency resolution +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Module streams are groups of RPM packages which provide alternatives to the default content which is present in a RPM repository. Module streams contain RPM packages which can have the same name as non-module RPM packages of the default content of a RPM repository. To be able to deliver the correct content to your system a few changes need to be introduced to the dependency resolution algorithm inside the DNF libraries and tools. + + diff --git a/modules/ROOT/pages/core-concepts/module-lifecycles.adoc b/modules/ROOT/pages/core-concepts/module-lifecycles.adoc index 1b14e59..0f2d574 100644 --- a/modules/ROOT/pages/core-concepts/module-lifecycles.adoc +++ b/modules/ROOT/pages/core-concepts/module-lifecycles.adoc @@ -1,5 +1,7 @@ = Module stream lifecycles +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + One of the major problems which modularity should solve is to enable different life cycles of software content. For example the life cycle of packaged software in the Fedora repository is for the lifetime of the release. There was no easy way to include software which would have life cycles closer to the upstream release cycle of a software. == EOL and obsolete metadata diff --git a/modules/ROOT/pages/core-concepts/module-stream.adoc b/modules/ROOT/pages/core-concepts/module-stream.adoc index eb38d48..cb6d1ef 100644 --- a/modules/ROOT/pages/core-concepts/module-stream.adoc +++ b/modules/ROOT/pages/core-concepts/module-stream.adoc @@ -1,6 +1,8 @@ :toc: macro = Module Stream +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + A module stream is the cornerstone of the Modularity project. A module stream represents a new entity which can be a part of a RPM repository. With the inclusion of module streams in a RPM repository the repository will be extended to a modular RPM repository. A module stream is a group of RPM packages which are built, installed and shipped together. The RPM packages are bound together by modular metadata. The artifacts of a module stream are binary and source RPM files and a module metadata (modulemd) yaml file. diff --git a/modules/ROOT/pages/core-concepts/nsvca.adoc b/modules/ROOT/pages/core-concepts/nsvca.adoc index 15c578c..e345a62 100644 --- a/modules/ROOT/pages/core-concepts/nsvca.adoc +++ b/modules/ROOT/pages/core-concepts/nsvca.adoc @@ -3,6 +3,8 @@ + + +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + toc::[] == Naming and identifying modules in Fedora diff --git a/modules/ROOT/pages/core-concepts/upgrade-paths.adoc b/modules/ROOT/pages/core-concepts/upgrade-paths.adoc index 611dad5..1cfdace 100644 --- a/modules/ROOT/pages/core-concepts/upgrade-paths.adoc +++ b/modules/ROOT/pages/core-concepts/upgrade-paths.adoc @@ -1,5 +1,7 @@ = Upgrade Paths in Modularity +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Since modularity consists of modules and packages, there two levels of upgrade. == On the modular level == diff --git a/modules/ROOT/pages/faq.adoc b/modules/ROOT/pages/faq.adoc index 9fd1347..c1a91d3 100644 --- a/modules/ROOT/pages/faq.adoc +++ b/modules/ROOT/pages/faq.adoc @@ -1,5 +1,7 @@ = Frequently Asked Questions (FAQ) +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + [qanda] Exactly what problem are you trying to solve?:: Deploying software has many solutions, but what gets deployed often plays out as a fight between developers and operators. Developers want the latest (or at least later) features. Operators want software in packages, certified, with a known period of support. Fedora Modularity provides multiple versions of packages in a Linux distribution with the qualities expected from a Linux distribution: transparently built and delivered, actively maintained, and easy to install — making both happy. diff --git a/modules/ROOT/pages/glossary.adoc b/modules/ROOT/pages/glossary.adoc index 851d892..16101bf 100644 --- a/modules/ROOT/pages/glossary.adoc +++ b/modules/ROOT/pages/glossary.adoc @@ -1,6 +1,8 @@ :toc: macro = Glossary +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Modularity introduces a lot of new keywords to the established packaging ecosystem. This is a short glossary to get you started on the basic terms. + + diff --git a/modules/ROOT/pages/history.adoc b/modules/ROOT/pages/history.adoc index df70203..dd64e84 100644 --- a/modules/ROOT/pages/history.adoc +++ b/modules/ROOT/pages/history.adoc @@ -1,5 +1,7 @@ = Modularity: History and Background +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Fedora Modularity is a new technology that tries to solve important and complex user problems. From time to time other solutions are suggested to solve these problems in different ways. Often those diff --git a/modules/ROOT/pages/hosting-modules.adoc b/modules/ROOT/pages/hosting-modules.adoc index 5c4ab8c..cbfe540 100644 --- a/modules/ROOT/pages/hosting-modules.adoc +++ b/modules/ROOT/pages/hosting-modules.adoc @@ -1,5 +1,7 @@ = Hosting modules for Fedora +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Since modules are technically collections of RPM packages with metadata, they are hosted the same way as traditional RPM packages are — in a repository. Apart from the packages, such repository must also contain the modular metadata (modulemd) that come with the modules. == Creating a modular repository diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 650e3a0..3eae04a 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,6 +1,8 @@ :toc: macro = Introduction +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Welcome to the Modularity project documentation. diff --git a/modules/ROOT/pages/policies/index.adoc b/modules/ROOT/pages/policies/index.adoc index 6862a26..8293c3b 100644 --- a/modules/ROOT/pages/policies/index.adoc +++ b/modules/ROOT/pages/policies/index.adoc @@ -1,5 +1,7 @@ = Policies Regarding Modules in Fedora, Fedora ELN and EPEL +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + == Modularity was retired from Fedora 39+ and EPEL There are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer]. diff --git a/modules/ROOT/pages/policies/naming-guidelines.adoc b/modules/ROOT/pages/policies/naming-guidelines.adoc index e785006..d55ab5d 100644 --- a/modules/ROOT/pages/policies/naming-guidelines.adoc +++ b/modules/ROOT/pages/policies/naming-guidelines.adoc @@ -1,5 +1,7 @@ = Modularity Naming Guidelines +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + Each module has a **name**, and one or more **streams** that usually represent a major version of the application, language stack, or other software in the module. To simplify their installation, modules can define **profiles** representing a specific use case. Modules are built out of SRPM packages that have a name and one or more branches. **Example 1:** A Node.js module could be named "nodejs", with three streams "6", "8" and "10", and two profiles "default" and "devel". This module would include a single package in each stream named "nodejs", branched as "6", "8", and "10". diff --git a/modules/ROOT/pages/policies/packaging-guidelines.adoc b/modules/ROOT/pages/policies/packaging-guidelines.adoc index 72e1873..23601ad 100644 --- a/modules/ROOT/pages/policies/packaging-guidelines.adoc +++ b/modules/ROOT/pages/policies/packaging-guidelines.adoc @@ -1,5 +1,7 @@ = Fedora Packaging Guidelines for Modules +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + These guidelines specify restrictions and guidance for xref:building-modules/fedora/defining-modules.adoc[defining modules in modulemd]. == Short Overview diff --git a/modules/ROOT/pages/references.adoc b/modules/ROOT/pages/references.adoc index bd39623..60676df 100644 --- a/modules/ROOT/pages/references.adoc +++ b/modules/ROOT/pages/references.adoc @@ -1,5 +1,7 @@ = References +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + https://github.com/fedora-modularity/libmodulemd/tree/main/yaml_specs[Module metadata definitions]:: A modulemd-packager format is used to define how to build a module. + A modulemd format, (a.k.a. modulemd-stream) is used to define the end result which is distributed to end user systems. + diff --git a/modules/ROOT/pages/requirements.adoc b/modules/ROOT/pages/requirements.adoc index dbd9468..ac4cf92 100644 --- a/modules/ROOT/pages/requirements.adoc +++ b/modules/ROOT/pages/requirements.adoc @@ -1,5 +1,7 @@ = Modularity: Requirements and use cases +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + If you haven't already read it, you should check out the first part of this essay on the xref:history.adoc[history and background of modularity]. == Critical use cases for consumers diff --git a/modules/ROOT/pages/using-modules.adoc b/modules/ROOT/pages/using-modules.adoc index 6245642..7b8e5f5 100644 --- a/modules/ROOT/pages/using-modules.adoc +++ b/modules/ROOT/pages/using-modules.adoc @@ -1,6 +1,8 @@ :toc: macro = Using modules in Fedora +WARNING: **The Modularity project has been retired** and there are https://fedoraproject.org/wiki/Changes/RetireModularity[no modules in Fedora 39 or newer] or https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/thread/KA3JQUZW63A4V7OQ7ZVDFCM32EQUSOXH/[in EPEL]. This page is only retained for historical reference. + **Modules** are special package groups usually representing an application, a language runtime, or a set of tools. They are available in one or **multiple streams** which usually represent a major version of a piece of software, giving you an option to choose what versions of packages you want to consume. To simplify installation, modules usually define one or more **installation profiles** that represent a specific use case. For example a `server` or a `client` profile in a database module.