From 2b780fafef425ffc01f384703583dacb14b39519 Mon Sep 17 00:00:00 2001 From: Pavel Raiskup Date: Thu, 7 Dec 2023 11:34:14 +0100 Subject: [PATCH] docs: create a Mock-Core-Configs page Complements: #1259 --- .../README.md => docs/Mock-Core-Configs.md | 26 ++++++++++++++++--- docs/index.md | 13 ++-------- mock-core-configs/README | 3 +++ mock-core-configs/mock-core-configs.spec | 2 +- 4 files changed, 28 insertions(+), 16 deletions(-) rename mock-core-configs/README.md => docs/Mock-Core-Configs.md (85%) create mode 100644 mock-core-configs/README diff --git a/mock-core-configs/README.md b/docs/Mock-Core-Configs.md similarity index 85% rename from mock-core-configs/README.md rename to docs/Mock-Core-Configs.md index 8e916926d..62a79a910 100644 --- a/mock-core-configs/README.md +++ b/docs/Mock-Core-Configs.md @@ -1,25 +1,43 @@ +--- +layout: default +title: Mock Core Configs +--- + # Mock core configs -The mock configs in this package are maintained by the community. +Mock project provides the `mock-core-configs` package which installs the default +[configuration files](configuration) for various RPM-based Linux distributions. +This packages is typically installed with Mock by default (runtime dependency). + +Other projects can provide their own configuration files in other packages, we +know of: + +* [mock-centos-sig-configs](https://pagure.io/centos-sig-hyperscale/mock-centos-sig-configs) +* [RPM Fusion Mock conifgs](https://github.com/rpmfusion-infra/mock-rpmfusion) + + +## Maintenance + +The configuration in this package maintained by the community. When encountering an issue please use your best judgement to decide whether a Mock config is broken, or the distribution is broken. -## Mock config issues +#### Mock config issues If a Mock config is broken (e.g. [#756][mock-756]), please [create a ticket for this repository][mock-issues] and tag the responsible maintainer from the table below. -## Distribution or repository issues +#### Distribution or repository issues If a distribution or repository is broken (e.g. [#889][mock-889]), please report the issue to the appropriate issue tracker for the distribution. -## Table +#### Table | Distribution | Chroots | Maintainer | Distribution or repository issue tracker | | ------------------------------------------------------------------------------ | ----------------- | --------------------------------------------------------------------- | ------------- | diff --git a/docs/index.md b/docs/index.md index bfd2c7edf..25a51d7d0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -44,7 +44,7 @@ Mock is capable of building SRPMs from source configuration management if the `m * [Tarballs](#tarballs) * [Download](#download) * [Setup](#setup) -* [Chroot config files](#chroot-config-files) +* [Chroot configuration files](Mock-Core-Configs) * [Plugins](#plugins) * [Features](#features) * [Using Mock outside your git sandbox](#using-mock-outside-your-git-sandbox) @@ -175,16 +175,7 @@ By default, builds are done in `/var/lib/mock`, so be sure you have room there. ## Chroot config files -Mock project provides the `mock-core-configs` package which installs the -default [configuration files](configuration) for various RPM-based Linux -distributions. This packages is typically installed with Mock by default -(runtime dependency). - -Other projects can provide their own configuration files in other packages, we -know of: - -* [mock-centos-sig-configs](https://pagure.io/centos-sig-hyperscale/mock-centos-sig-configs) - +See a [separate document](Mock-Core-Configs). ## Plugins diff --git a/mock-core-configs/README b/mock-core-configs/README new file mode 100644 index 000000000..cfed244b0 --- /dev/null +++ b/mock-core-configs/README @@ -0,0 +1,3 @@ +This package is provided by the Mock community. Take a look at +https://rpm-software-management.github.io/mock/Mock-Core-Configs +for more info. diff --git a/mock-core-configs/mock-core-configs.spec b/mock-core-configs/mock-core-configs.spec index c720c552a..4b3ca17f2 100644 --- a/mock-core-configs/mock-core-configs.spec +++ b/mock-core-configs/mock-core-configs.spec @@ -147,7 +147,7 @@ fi %files -f %{name}.cfgs %license COPYING -%doc README.md +%doc README %ghost %config(noreplace,missingok) %{_sysconfdir}/mock/default.cfg %changelog