Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create a Mock-Core-Configs page #1264

Merged
merged 1 commit into from
Dec 11, 2023
Merged

docs: create a Mock-Core-Configs page #1264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions mock-core-configs/README.md → docs/Mock-Core-Configs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
| ------------------------------------------------------------------------------ | ----------------- | --------------------------------------------------------------------- | ------------- |
Expand Down
13 changes: 2 additions & 11 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down
3 changes: 3 additions & 0 deletions mock-core-configs/README
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion mock-core-configs/mock-core-configs.spec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ fi

%files -f %{name}.cfgs
%license COPYING
%doc README.md
%doc README
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd keep the file as .md so it renders nicely on git forges.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think anyone is going to take a look online (mock project has a separate readme)? I'm slightly -1 (to prefer the command-line readability for %doc files), but it's not a big deal.. So, just please confirm you want this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I bet a lot of people are clicking through project files on GitHub instead of cloning the repo locally. So my attitude is to use markdown files everywhere. Just by adding the .md (and not using any syntax), GitHub uses a prettier and larger font to display it, so IMHO there is no downside.

But since the README is basically just a link to the documentation, it doesn't really matter. Even non-markdown file is fine with me.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, thank you. I kept it as is for now. The product of this change comes here:
https://rpm-software-management.github.io/mock/Mock-Core-Configs

%ghost %config(noreplace,missingok) %{_sysconfdir}/mock/default.cfg

%changelog
Expand Down